dependency cruiser

Croiseur de dépendance

Valider et visualiser les dépendances. Avec vos règles. Javascript. Manuscrit. CoffeeScript. ES6, CommonJS, AMD.

Qu'est-ce que c'est?

Cela traverse les dépendances dans n'importe quel projet JavaScript, TypeScript, LifeScript ou CoffeeScript et ...

• ... les valide contre (vos propres règles
• ... les rapports ont violé les règles
  • dans le texte (pour vos versions)
  • en graphiques (pour vos globes oculaires)

En tant qu'effet secondaire, il peut générer des graphiques de dépendance dans divers formats de sortie, y compris des visualisations cool, vous pouvez coller sur le mur pour impressionner votre grand-mère.

Comment l'utiliser?

L'installez ...

npm install --save-dev dependency-cruiser
# or
yarn add -D dependency-cruiser
pnpm add -D dependency-cruiser

... et générer une configuration

npx depcruise --init

Cela examinera un peu dans votre environnement, vous posera des questions et créera un fichier de configuration .dependency-cruiser.js à l'écoute de votre projet ^{1 2} .

Montrez des trucs à votre grand-mère

Pour créer un graphique des dépendances dans votre dossier SRC, vous exécuteriez Dependency Cruiser avec Type de sortie dot et exécutez Graphviz Dot ³ au résultat. Dans une doublure:

npx depcruise src --include-only " ^src " --output-type dot | dot -T svg > dependency-graph.svg

Dépendance-cruiser V12 et plus: Ajouter - Configtion d'option

Bien qu'il ne soit pas nécessaire de la dépendance-cruiser V13 et plus tard, dans V12 et plus

npx depcruise src --include-only " ^src " --config --output-type dot | dot -T svg > dependency-graph.svg

• Vous pouvez en savoir plus sur ce que vous pouvez faire avec --include-only et d'autres options de ligne de commande dans la documentation de l'interface de ligne de commande.
• Les échantillons du monde réel contient des croisières en dépendance de certains des projets les plus utilisés sur le NPM.
• Si votre grand-mère est plus dans des formats comme mermaid , json , csv , html ou le texte brut, nous l'avons également couverte.

Valider les choses

Déclarer certaines règles

Lorsque vous avez exécuté depcruise --init ci-dessus, la commande a également ajouté des règles à .dependency-cruiser.js qui ont du sens dans la plupart des projets, comme la détection des dépendances circulaires , des dépendances manquantes dans package.json, des orphelins et le code de production qui s'appuie sur Dev ou Oactionsaldependences.

Commencez à ajouter vos propres règles en modifiant ce fichier.

Exemple de règle:

{
  "forbidden" : [
    {
      "name" : " not-to-test " ,
      "comment" : " don't allow dependencies from outside the test folder to test " ,
      "severity" : " error " ,
      "from" : { "pathNot" : " ^test " },
      "to" : { "path" : " ^test " }
    }
  ]
}

• Pour en savoir plus sur l'écriture des règles, consultez le tutoriel des règles d'écriture ou la référence des règles

Les signaler

npx depcruise src

Dépendance-cruiser V12 et plus: Ajouter - Configtion d'option

Bien que cela ne soit pas nécessaire de la dépendance-cruiser V13, dans V12 et plus, vous devrez passer l'option - config.

npx depcruise --config .dependency-cruiser.js src

Cela validera contre vos règles et montrera toute violation dans un format de type Eslint:

Il existe plus de façons de signaler les validations; dans un graphique (comme celui au-dessus de cette lecture) ou dans un fichier html autonome.

• En savoir plus sur les journalistes ERR, DOT, CSV et HTML dans la documentation de l'interface de ligne de commande.
• Dependency-Cruiser s'utilise pour se vérifier dans son propre processus de construction; Voir le script depcruise dans le package.json

Je veux en savoir plus!

Vous êtes venu au bon endroit :-):

• Usage
  • Référence de la ligne de commande
  • Règles d'écriture
  • Règles de référence
  • Référence des options
  • FAQ
• Pirater la dépendance à la dépendance
  • API
  • Format de sortie
  • Ajout d'autres formats de sortie
  • Ajout de prise en charge des autres langues Alt-JS
• D'autres choses
  • Carte routière
  • Contact
  • Cas de spectacles du monde réel
  • Support de dactylographie, coffeeScript et Livescript
  • Prise en charge de .jsx, .tsx, .csx / .cjsx, .vue et .svelte
  • Webpack alias / modules Prise en charge

Licence

Mit

Merci

• Marijn Haverbeke et d'autres personnes qui ont collaboré à Acorn - l'excellente dépendance à l'analyseur JavaScript utilise pour déduire les dépendances.
• Katerina Limpitsouni de Undraw pour l'image d'Ollie dans l'image des médias sociaux de la dépendance-cruiser.
• Tous les membres de la communauté open source qui ont eu la gentillesse de soulever des problèmes, de poser des questions et de faire des demandes de traction pour obtenir un record de dépendance à être un meilleur outil.

Statut de construction

Fait avec? en Hollande.

Notes de bas de page

1. Nous utilisons npx dans l'exemple de scripts pour la commodité. Lorsque vous utilisez les commandes dans un script dans package.json il n'est pas nécessaire de les préfixer avec npx . ↩

2. Si vous ne souhaitez pas utiliser npx , mais à la place pnpx (à partir du pnpm Package Manager) ou yarn - veuillez vous référer à la documentation de cet outil. En particulier, pnpx a une sémantique qui diffère de npx considérablement et que vous voulez être conscient avant de l'utiliser. En attendant: npx devrait fonctionner même lorsque vous avez installé la dépendance avec un gestionnaire de packages différent de npm . ↩

3. Cela suppose que la commande Graphviz dot est disponible - sur la plupart des systèmes Linux et comparables, ce sera. Dans le cas où ce n'est pas le cas, voir la page de téléchargement de Graphviz pour des instructions sur la façon de l'obtenir sur votre machine. ↩