Dependency Cruiser

Validate and Visualize JavaScript Dependencies

Dependency analysis
sverweij/dependency-cruiserdependency-cruiser

README

Dependency cruiser


_Validate and visualise 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 dependency graphs in various output formats including [cool visualizations](./doc/real-world-samples.md)
you can stick on the wall to impress your grandma.

How do I use it?


Install it


  1. ```shell
  2. npm install --save-dev dependency-cruiser
  3. # or
  4. yarn add -D dependency-cruiser
  5. pnpm add -D dependency-cruiser
  6. ```

Generate a config


  1. ```shell
  2. npx depcruise --init
  3. ```

This will look around in your environment a bit, ask you some questions and create
a .dependency-cruiser.js configuration file attuned to your project[^1][^2].

[^1]:
    We're using npx in the example scripts for convenience. When you use the
    commands in a script in package.json it's not necessary to prefix them with
    npx.

[^2]:
    If you don't don't want to use npx, but instead pnpx (from the pnpm
    package manager) or yarn - please refer to that tool's documentation.
    Particularly pnpx has semantics that differ from npx quite significantly
    and that you want to be aware of before using it. In the mean time: npx
    _should_ work even when you installed the dependency with a package manager
    different from npm.

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_[^3] on the result. In
a one liner:

  1. ```shell
  2. npx depcruise src --include-only "^src" --config --output-type dot | dot -T svg > dependency-graph.svg
  3. ```

- You can read more about what you can do with --include-only 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.
- If our grandma is more into formats like mermaid, json, csv, html or plain text
  we've got her covered
  as well.

[^3]:
    This assumes the GraphViz dot command is available - on most linux and
    comparable systems this will be. In case it's not, see
    GraphViz' download page for instructions
    on how to get it on your machine.

Validate things


Declare some rules


When you ran the depcruise --init command above, the command also added some rules
to .dependency-cruiser.js that make sense in most projects, like detecting
circular dependencies, dependencies missing in package.json, orphans,
and production code relying on dev- or optionalDependencies.

Start adding your own rules by tweaking that file.

Sample rule:

  1. ```json
  2. {
  3.   "forbidden": [
  4.     {
  5.       "name": "not-to-test",
  6.       "comment": "don't allow dependencies from outside the test folder to test",
  7.       "severity": "error",
  8.       "from": { "pathNot": "^test" },
  9.       "to": { "path": "^test" }
  10.     }
  11.   ]
  12. }
  13. ```

- To read more about writing rules check the
  writing rules tutorial
  or the rules reference

Report them


  1. ```sh
  2. npx depcruise --config .dependency-cruiser.js src
  3. ```

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 an self-containing html file.

- 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 depcruise script in the
  package.json

I want to know more!


You've come to the right place :-) :

- Usage
  - Command line reference
  - Writing rules
  - Rules reference
  - Options reference
  - FAQ
- Hacking on dependency-cruiser
  - API
  - Output format
  - Adding other output formats
  - Adding support for other alt-js languages
- Other things
  - Road map
  - Contact
  - Real world show cases
  - TypeScript, CoffeeScript and LiveScript support
  - Support for .jsx, .tsx, .csx/ .cjsx, .vue and .svelte
  - Webpack alias/ modules support

License


MIT

Thanks


- Marijn Haverbeke and other people who
  collaborated on acorn -
  the excellent JavaScript parser dependency-cruiser uses to infer
  dependencies.
- Katerina Limpitsouni of unDraw
  for the ollie in dependency-cruiser's
  social media image.
- All members of the open source community who have been kind enough to raise issues,
  ask questions and make pull requests to get dependency-cruiser to be a better
  tool.

Build status


GitHub Workflow Status
coverage
Maintainability
Test Coverage
total downloads on npm

Made with :metal: in Holland.