deptrac

Deptrac

Deptrac ist ein statisches Code-Analysetool für PHP, das Ihnen hilft, Architekturentscheidungen in Ihren Projekten zu kommunizieren, zu visualisieren und durchzusetzen. Sie können Ihre Architekturebenen über Klassen frei definieren und welche Regeln für sie gelten sollen.

Mit Deptrac können Sie beispielsweise sicherstellen, dass Bundles/Module/Erweiterungen in Ihrem Projekt wirklich unabhängig voneinander sind, um ihre Wiederverwendung zu erleichtern.

Deptrac kann in einer CI-Pipeline verwendet werden, um sicherzustellen, dass eine Pull-Anfrage keine der von Ihnen definierten Architekturregeln verletzt. Mit dem optionalen Graphviz- oder Mermaidjs-Formatierer können Sie Ihre Ebenen, Regeln und Verstöße visualisieren.

Dokumentation

Sie finden die Dokumentation im Verzeichnis /docs oder besuchen Sie die Dokumentationsseite: https://qossmic.github.io/deptrac

Erste Schritte

Sie können Deptrac über Composer installieren. Wir empfehlen hierfür das Paket deptrac:

 composer require --dev qossmic/deptrac

Nachdem Sie deptrac heruntergeladen/installiert haben, müssen Sie eine Konfigurationsdatei erstellen, in der Sie Ihre Ebenen und Ihren Kommunikationsregelsatz definieren. Diese Konfigurationsdatei ist in YAML oder PHP geschrieben und wird standardmäßig unter dem Namen deptrac.yaml im Stammverzeichnis Ihres Projekts gespeichert.

Deptrac kann mit dem Befehl init eine Vorlage für Sie generieren.

 vendor/bin/deptrac init

Wenn Sie über diese Datei verfügen, können Sie Ihren Code analysieren, indem Sie den Befehl analyse ausführen:

 vendor/bin/deptrac

# which is equivalent to
vendor/bin/deptrac analyse --config-file=deptrac.yaml

Um Deptrac auszuführen, benötigen Sie mindestens PHP 8.1.

Sie können Projekte analysieren, die eine ältere PHP-Version erfordern, sofern nikic/php-parser diese analysieren kann.

So können Sie einen Beitrag leisten

Sehen Sie sich den Beitragsleitfaden an oder gehen Sie zum Entwicklungs-Repository qossmic/deptrac-src.

Weitere Dokumentation

• Abwärtskompatibilität – Allgemeine Informationen darüber, wie wir mit der Abwärtskompatibilität umgehen
• Upgrade-Leitfaden – Liste der rückwärtsgerichteten Änderungen, die beim Upgrade von Deptrac auf eine neue Version berücksichtigt werden müssen, und wie das geht.
• Kernkonzepte – Erklärt Ebenen, Regeln und Verstöße detaillierter.
• Konfiguration – Referenz für alle verfügbaren Einstellungen in einer Depfile
• Kollektoren – Referenz dafür, welche Kollektoren in Deptrac zur Definition Ihrer Ebenen verfügbar sind.
• Formatter – Listet die verschiedenen von Deptrac unterstützten Ausgabeformate auf
• Debuggen – Übersicht über die Debug-Befehle
• Verhaltenskodex – Unsere Gemeinschaftsstandards
• Mitwirken – Ratschläge zum Einbringen von Codeänderungen, z. B. zum Ausführen von Tests oder zum Erstellen einer Phar-Datei mit Ihren Änderungen, die Sie zum Analysieren Ihrer Projekte verwenden können
• Sicherheitsleitfaden – So melden Sie Sicherheitslücken