dependency cruiser report action

Rapport de dépendance à la dépendance

A GitHub Actions qui rapportent pour visualiser les dépendances des fichiers modifiés à chaque requête de traction.

Cette action utilise la dépendance-cruiser pour sortir la syntaxe de sirmaid.js. Inspiré par la référence en plaisantage.

usage

Installez dans votre projet

npm install --save-dev dependency-cruiser

Configurer le croiseur de dépendance dans l'assistant

npm run depcruise --init

Créez une nouvelle action sous .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 

Utilisation avancée

Spécification du fichier de configuration

Cette action détecte automatiquement le fichier de configuration de la dépendance-cruiser ( .dependency-cruiser.js , etc.), mais vous pouvez spécifier votre propre fichier de règles.

 with :
  config-file : my-rules.json

Pour plus d'informations sur le fichier de configuration, veuillez consulter la documentation officielle

Personnalisation du script de croisière

Cette action ajoute automatiquement les indicateurs nécessaires à votre script de croisière en fonction du gestionnaire de packages. Par exemple, si vous utilisez du fil, le script par défaut est:

yarn run -s depcruise

Vous n'avez donc pas besoin de spécifier des drapeaux supplémentaires - l'action les gérera automatiquement. Ainsi, après avoir ajouté les drapeaux nécessaires, l'action exécutera cette commande:

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

Mais vous pouvez utiliser des options supplémentaires:

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

Utilisation avec bun , npm ou pnpm

Cette action téléchargera automatiquement les dépendances (par défaut est le fil), mais vous pouvez également spécifier bun , npm ou pnpm :

 with :
  package-manager : npm

ou

 with :
  package-manager : pnpm

Personnalisation du répertoire de travail

Si vous souhaitez exécuter cette action dans un autre répertoire, spécifiez working-directory :

 with :
  working-directory : <dir> 

Compatibilité

Cette action nécessite la dépendance-cruiser V11.10.0 ou plus récente.