deptrac

Déptrac

Deptrac est un outil d'analyse de code statique pour PHP qui vous aide à communiquer, visualiser et appliquer des décisions architecturales dans vos projets. Vous pouvez définir librement vos couches architecturales sur les classes et quelles règles doivent leur être appliquées.

Par exemple, vous pouvez utiliser Deptrac pour garantir que les bundles/modules/extensions de votre projet sont véritablement indépendants les uns des autres afin de faciliter leur réutilisation.

Deptrac peut être utilisé dans un pipeline CI pour garantir qu'une pull request ne viole aucune des règles architecturales que vous avez définies. Avec le formateur optionnel Graphviz ou Mermaidjs, vous pouvez visualiser vos couches, règles et violations.

Documentation

Vous pouvez trouver la documentation dans le répertoire /docs ou visiter la page doc : https://qossmic.github.io/deptrac

Commencer

Vous pouvez installer Deptrac via Composer. Nous vous recommandons d'utiliser le package deptrac pour cela :

 composer require --dev qossmic/deptrac

Une fois que vous avez téléchargé/installé deptrac, vous devrez créer un fichier de configuration dans lequel vous définirez vos couches et vos règles de communication. Ce fichier de configuration est écrit en YAML ou php et, par défaut, est stocké sous le nom deptrac.yaml dans le répertoire racine de votre projet.

Deptrac peut générer un modèle pour vous, à l'aide de la commande init .

 vendor/bin/deptrac init

Lorsque vous disposez de ce fichier, vous pouvez analyser votre code en exécutant la commande analyse :

 vendor/bin/deptrac

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

Pour exécuter Deptrac, vous avez besoin d'au moins PHP 8.1.

Vous pouvez analyser les projets qui nécessitent une ancienne version de PHP tant que nikic/php-parser peut l'analyser.

Comment contribuer

Consultez le guide de contribution ou accédez au référentiel de développement qossmic/deptrac-src.

Documentation complémentaire

• Compatibilité ascendante – Informations générales sur la façon dont nous abordons la compatibilité ascendante
• Guide de mise à niveau - Liste des modifications rétrogrades qui doivent être prises en compte lors de la mise à niveau de Deptrac vers une nouvelle version et comment le faire.
• Concepts de base : explique les couches, les règles et les violations plus en détail.
• Configuration - Référence pour tous les paramètres disponibles dans un fichier dep
• Collecteurs - Référence pour laquelle les collecteurs sont disponibles dans Deptrac pour définir vos couches.
• Formateurs - Répertorie les différents formats de sortie pris en charge par Deptrac
• Débogage - Présentation des commandes de débogage
• Code de conduite - Nos normes communautaires
• Contribuer - Conseils pour contribuer aux modifications du code, par exemple comment exécuter des tests ou comment créer un fichier phar avec vos modifications que vous pouvez utiliser pour analyser vos projets
• Guide de sécurité - Comment signaler les failles de sécurité