dependency cruiser report action

Abhängigkeitsbericht

Eine GitHub -Aktionen, die sich zur Visualisierung der Abhängigkeiten geänderter Dateien melden, die jeweils annimmt.

Diese Aktion verwendet Abhängigkeitskreuzer, um Syntax von mermaid.js auszugeben. Inspiriert von der Scherzbedeckung.

Verwendung

Installieren Sie in Ihrem Projekt

npm install --save-dev dependency-cruiser

Setup-Abhängigkeits-Kreuzer im Assistenten

npm run depcruise --init

Erstellen Sie neue Aktionen unter .github/workflows .

 name : ' depcruise '
on :
  pull_request :

jobs :
  report :
    permissions :
      pull-requests : write
    runs-on : ubuntu-latest
    steps :
      - uses : MH4GF/dependency-cruiser-report-action@v2 

Erweiterte Verwendung

Konfigurationsdatei angeben

Diese Aktion erkennt automatisch die Konfigurationsdatei von Abhängigkeiten ( .dependency-cruiser.js usw.), Sie können jedoch Ihre eigene Regelndatei angeben.

 with :
  config-file : my-rules.json

Weitere Informationen zur Konfigurationsdatei finden Sie in der offiziellen Dokumentation

Anpassen von Kreuzfahrtskript

Diese Aktion fügt Ihrem Kreuzfahrtskript automatisch die erforderlichen Flags hinzu, basierend auf Package Manager. Wenn Sie beispielsweise Garn verwenden, lautet das Standardskript:

yarn run -s depcruise

Sie müssen also keine zusätzlichen Flags angeben - Aktionen werden diese automatisch behandelt. Nach dem Hinzufügen der notwendigen Flags wird dieser Befehl ausgeführt:

 --output-type mermaid --config ${SPECIFIED_CONFIG_FILE} ${DIFF_FILE_A DIFF_FILE_B ...etc}

Sie können jedoch zusätzliche Optionen verwenden:

 with :
  cruise-script : yarn run -s depcruise --exclude "^lib"

Verwendung mit bun , npm oder pnpm

Diese Aktion lädt automatisch Abhängigkeiten herunter (Standard ist Garn). Sie können jedoch auch bun , npm oder pnpm angeben:

 with :
  package-manager : npm

oder

 with :
  package-manager : pnpm

Anpassung des Arbeitsverzeichnisses

Wenn Sie diese Aktion in einem anderen Verzeichnis ausführen möchten, geben Sie working-directory an:

 with :
  working-directory : <dir> 

Kompatibilität

Diese Aktion erfordert Abhängigkeits-Kriterien v11.10.0 oder neuer.