dependency-cruiser
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

dependency-cruiser

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

5.1.1  •  Updated 7 months ago  •  by Sander Verweij  •  MIT License

Dependency cruiser Dependency cruiser

Validate and visualize dependencies. With your rules. JavaScript. TypeScript. CoffeeScript. ES6, CommonJS, AMD.

What’s this do?

Snazzy dot output to whet your appetite

This runs through the dependencies in any JavaScript, TypeScript, LiveScript or CoffeeScript project and …

  • validates them against (your own) rules
  • reports violated rules
    • in text (for your builds)
    • in graphics (for your eyeballs)

As a side effect it can generate cool dependency graphs you can stick on the wall to impress your grandma.

How do I use it?

Install it

  • npm install --save-dev dependency-cruiser to use it as a validator in your project or…
  • npm install --global dependency-cruiser if you just want to to inspect multiple projects.

Show stuff to your grandma

To create a graph of the dependencies in your src folder, you’d run dependency cruiser with output type dot and run GraphViz dot on the result. In a one liner:

depcruise --exclude "^node_modules" --output-type dot src | dot -T svg > dependencygraph.svg
  • You can read more about what you can do with --exclude and other command line options in the command line interface documentation.
  • Real world samples contains dependency cruises of some of the most used projects on npm.

Validate things

Declare some rules

The easy way to get you started:

depcruise --init

This will create a .dependency-cruiser.json with some rules that make sense in most projects (detecting circular dependencies, dependencies missing in package.json, orphans, production code relying on dev- or optionalDependencies, …).

Start adding your rules by tweaking that file.

Sample rule:

{
    "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" }
    }]
}

Report them

depcruise --validate .dependency-cruiser.json src

This will validate against your rules and shows any violations in an eslint-like format:

sample err output

There’s more ways to report validations; in a graph (like the one on top of this readme) or in a table.

  • Read more about the err, dot, csv and html reporters in the command line interface documentation.
  • dependency-cruiser uses itself to check on itself in its own build process; see the decpruise script in the package.json

I want to know more!

You’ve come to the right place 😃 :

License

MIT

Thanks

  • Marijn Haverbeke and other people who collaborated on acorn - the excellent JavaScript parser dependency-cruiser uses to infer dependencies.

Build status

build status Build status Build Status coverage Maintainability Test Coverage total downloads on npm

Made with 🤘 in Holland.

Popularity

Weekly Downloads
11.2K
Stars
971

Maintenance

Development

Last ver 7 months ago
Created 3 years ago
Last commit 4 months ago
1 day between commits

Technology

Node version: 10.16.3
313.4K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

9 contributors
sverweij
Maintainer, 1007 commits, 150 merges, 145 PRs
Klaus Meinhardt
7 commits, 2 PRs
Siddharth Jain
3 commits
Jessica Kerr
1 commits, 1 PRs
Nick Ribal
1 commits, 1 PRs
Works at CodeValue
Tharun Rajendran
1 commits, 3 PRs
Works at thoughtworks

Tags

static analysis
circular
dependencies
typescript
javascript
coffeescript
ES6
ES2015
AMD
CommonJS
validation
spelunking
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.