deptrac

Deptrac

Deptrac es una herramienta de análisis de código estático para PHP que le ayuda a comunicar, visualizar y hacer cumplir decisiones arquitectónicas en sus proyectos. Puede definir libremente sus capas arquitectónicas sobre clases y qué reglas se les deben aplicar.

Por ejemplo, puede utilizar Deptrac para asegurarse de que los paquetes/módulos/extensiones de su proyecto sean realmente independientes entre sí para que sean más fáciles de reutilizar.

Deptrac se puede utilizar en una canalización de CI para garantizar que una solicitud de extracción no viole ninguna de las reglas arquitectónicas que definió. Con el formateador opcional Graphviz o Mermaidjs puedes visualizar tus capas, reglas y violaciones.

Documentación

Puede encontrar la documentación en el directorio /docs o visitar la página de documentos: https://qossmic.github.io/deptrac

Empezando

Puede instalar Deptrac a través de Composer. Recomendamos utilizar el paquete deptrac para esto:

 composer require --dev qossmic/deptrac

Una vez que haya descargado/instalado deptrac, deberá crear un archivo de configuración, donde definirá sus capas y su conjunto de reglas de comunicación. Este archivo de configuración está escrito en YAML o php y, de forma predeterminada, se almacena con el nombre deptrac.yaml en el directorio raíz de su proyecto.

Deptrac puede generar una plantilla para usted mediante el comando init .

 vendor/bin/deptrac init

Cuando tenga este archivo, puede analizar su código ejecutando el comando analyse :

 vendor/bin/deptrac

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

Para ejecutar Deptrac necesita al menos PHP 8.1.

Puedes analizar proyectos que requieran una versión anterior de PHP siempre que nikic/php-parser pueda analizarla.

Cómo contribuir

Consulte la guía de contribución o vaya al repositorio de desarrollo qossmic/deptrac-src.

Documentación adicional

• Compatibilidad con versiones anteriores: información general sobre cómo abordamos la compatibilidad con versiones anteriores
• Guía de actualización: lista de cambios importantes que deben abordarse al actualizar Deptrac a una nueva versión y cómo hacerlo.
• Conceptos básicos: explica capas, reglas y violaciones con más detalle.
• Configuración: referencia para todas las configuraciones disponibles en un archivo depfile
• Coleccionistas: referencia sobre qué recopiladores están disponibles en Deptrac para definir sus capas.
• Formateadores: enumera los diferentes formatos de salida admitidos por Deptrac
• Depuración: descripción general de los comandos de depuración
• Código de conducta: nuestros estándares comunitarios
• Contribuir: consejos para contribuir con cambios de código, por ejemplo, cómo ejecutar pruebas o cómo crear un archivo phar con sus cambios que puede usar para analizar sus proyectos.
• Guía de seguridad: cómo informar vulnerabilidades de seguridad