dependency cruiser report action

Informe de dependientes

Una acción de GitHub que informa para visualizar las dependencias de los archivos modificados que cada extracción solicita.

Esta acción utiliza un redactor de dependencia para emitir la sintaxis de Mermaid.js. Inspirado en la acción de informes de cobertura de broma.

uso

Instalar en su proyecto

npm install --save-dev dependency-cruiser

Configuración de dependencias-redescente en el mago

npm run depcruise --init

Cree una nueva acción en .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 

Uso avanzado

Especificación del archivo de configuración

Esta acción detecta automáticamente el archivo de configuración del cruiser de dependencia ( .dependency-cruiser.js , etc.), pero puede especificar su propio archivo de reglas.

 with :
  config-file : my-rules.json

Para obtener más información sobre el archivo de configuración, consulte la documentación oficial

Personalización de script de crucero

Esta acción agrega automáticamente las banderas necesarias a su script de crucero basado en el administrador de paquetes. Por ejemplo, si está usando hilo, el script predeterminado es:

yarn run -s depcruise

Por lo tanto, no necesita especificar banderas adicionales: la acción las manejará automáticamente. Entonces, después de agregar las banderas necesarias, la acción ejecutará este comando:

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

Pero puede usar opciones adicionales:

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

Uso con bun , npm o pnpm

Esta acción descargará automáticamente las dependencias (el valor predeterminado es el hilo), pero también puede especificar bun , npm o pnpm :

 with :
  package-manager : npm

o

 with :
  package-manager : pnpm

Personalización del directorio de trabajo

Si desea ejecutar esta acción en otro directorio, especifique working-directory :

 with :
  working-directory : <dir> 

Compatibilidad

Esta acción requiere dependencia-cruiser v11.10.0 o más nueva.