dependency cruiser

Abhängigkeitskreuzer

Validieren und visualisieren Sie Abhängigkeiten. Mit deinen Regeln. JavaScript. Typoskript. Coffeescript. ES6, Commonjs, AMD.

Was macht das?

Dies läuft durch die Abhängigkeiten in jedem Projekt JavaScript, Typecript, Livescript oder Coffeescript und ...

• ... bestätigt sie für (eigene) Regeln
• ... Berichte haben gegen Regeln verstoßen
  • im Text (für Ihre Builds)
  • in Grafiken (für Ihre Augäpfel)

Als Nebeneffekt können Sie Abhängigkeitsgrafiken in verschiedenen Ausgangsformaten erzeugen, einschließlich cooler Visualisierungen, Sie können an der Wand kleben, um Ihre Oma zu beeindrucken.

Wie benutze ich es?

Installieren Sie es ...

npm install --save-dev dependency-cruiser
# or
yarn add -D dependency-cruiser
pnpm add -D dependency-cruiser

... und generieren Sie eine Konfiguration

npx depcruise --init

Dies wird sich in Ihrer Umgebung ein wenig umsehen, ^Ihnen einige Fragen stellen und eine ^{Konfigurationsdatei} .dependency-cruiser.js erstellen.

Zeigen Sie Ihrer Oma Sachen

Um ein Diagramm der Abhängigkeiten in Ihrem SRC -Ordner zu erstellen, führen Sie den Abhängigkeits -Cruiser mit Ausgangstyp dot und GraphViz DOT ³ für das Ergebnis aus. In einem Ein -Liner:

npx depcruise src --include-only " ^src " --output-type dot | dot -T svg > dependency-graph.svg

Abhängigkeitskruiser v12 und älter: Option-Konfiguration hinzufügen

Obwohl nicht von der Abhängigkeits-Kriminalität V13 und später erforderlich ist, müssen Sie in v12 und älter die Option-Konfiguration übergeben, damit die Konfigurationsdatei.

npx depcruise src --include-only " ^src " --config --output-type dot | dot -T svg > dependency-graph.svg

• In der Dokumentation der Befehlszeilenschnittstellen können Sie mehr darüber erfahren, was Sie mit --include-only und anderen Befehlszeilenoptionen tun können.
• Proben in der realen Welt enthalten Abhängigkeitskreuzfahrten einiger der am häufigsten verwendeten Projekte auf NPM.
• Wenn Ihre Oma mehr in Formate wie mermaid , json , csv , html oder einfacher Text steht, haben wir sie auch abgedeckt.

Dinge validieren

Einige Regeln deklarieren

Wenn Sie depcruise --init oben lief, wurde der Befehl auch einige Regeln zu .dependency-cruiser.js hinzugefügt, die in den meisten Projekten sinnvoll sind, z. B. Erkennung kreisförmiger Abhängigkeiten , Abhängigkeiten, die in Package.json, Orphans und Produktionscode auf Dev- oder OptionaldePendenzen fehlen .

Fügen Sie Ihre eigenen Regeln hinzu, indem Sie diese Datei optimieren.

Beispielregel:

{
  "forbidden" : [
    {
      "name" : " not-to-test " ,
      "comment" : " don't allow dependencies from outside the test folder to test " ,
      "severity" : " error " ,
      "from" : { "pathNot" : " ^test " },
      "to" : { "path" : " ^test " }
    }
  ]
}

• Weitere Informationen zu Schreibregeln finden Sie im Tutorial für Schreibregeln oder die Regeln Referenz

Melden Sie sie

npx depcruise src

Abhängigkeitskruiser v12 und älter: Option-Konfiguration hinzufügen

Obwohl nicht von der Abhängigkeits-Kriminalität V13 erforderlich ist, müssen Sie in v12 und älter die Option-Konfiguration übergeben, damit die Konfigurationsdatei.

npx depcruise --config .dependency-cruiser.js src

Dies wird gegen Ihre Regeln bestätigt und Verstöße in einem Eslint-ähnlichen Format angezeigt:

Es gibt mehr Möglichkeiten, Validierungen zu melden. in einem Diagramm (wie dem oben auf diesem Readme) oder in einer selbsthaltigen html Datei.

• Lesen Sie mehr über die Reporter von ERR-, DOT, CSV und HTML in der Dokumentation der Befehlszeilenschnittstellen.
• Die Abhängigkeitskreuzer verwendet sich selbst in seinem eigenen Build-Prozess. Siehe das depcruise -Skript im Paket.json

Ich möchte mehr wissen!

Du bist am richtigen Ort gekommen :-):

• Verwendung
  • Befehlszeilenreferenz
  • Schreibregeln
  • Regeln Referenz
  • Optionsreferenz
  • FAQ
• Hacking von Abhängigkeitskreuz
  • API
  • Ausgangsformat
  • Hinzufügen anderer Ausgangsformate
  • Hinzufügen von Unterstützung für andere Alt-JS-Sprachen
• Andere Dinge
  • Straßenkarte
  • Kontakt
  • Fälle von Real World Shows
  • TypeScript-, Coffeescript- und Livescript -Unterstützung
  • Unterstützung für .jsx, .tsx, .csx/ .cjsx, .vue und .svelte
  • Webpack alias/ modules Unterstützung

Lizenz

MIT

Danke

• Marijn Haverbeke und andere Personen, die mit ACORN zusammengearbeitet haben - der exzellente JavaScript -Parser -Abhängigkeits -Kriterium verwendet, um Abhängigkeiten zu schließen.
• Katerina Limpitouni von UNDRAW für den Ollie im Social-Media-Image von Abhängigkeitskruiser.
• Alle Mitglieder der Open-Source-Community, die freundlich genug waren, um Probleme aufzuwerfen, Fragen zu stellen und Anfragen zu stellen, um Abhängigkeitskruiser zu einem besseren Tool zu machen.

Status erstellen

Gemacht mit? in Holland.

Fußnoten

1. Wir verwenden npx in den Beispielskripten für die Bequemlichkeit. Wenn Sie die Befehle in einem Skript in package.json verwenden, ist es nicht erforderlich, sie mit npx zu präfixen. ↩

2. Wenn Sie npx nicht verwenden möchten, sondern pnpx (aus dem pnpm -Paketmanager) oder yarn , lesen Sie bitte die Dokumentation dieses Tools. Insbesondere pnpx verfügt über eine Semantik, die sich von npx erheblich unterscheidet und die Sie vor der Verwendung bewusst sein möchten. In der Zwischenzeit: npx sollte auch dann funktionieren, wenn Sie die Abhängigkeit mit einem anderen Paketmanager von npm installiert haben. ↩

3. Dies setzt voraus, dass der Befehl graphviz dot verfügbar ist - auf den meisten Linux und vergleichbaren Systemen wird dies sein. Für den Fall, dass dies nicht der Fall ist, finden Sie in Graphviz 'Download -Seite Anweisungen zum Erhalten auf Ihrem Computer. ↩