Home

Awesome

codechecks-dependency-cruiser

Usage

Add to your codechecks.yml file:

checks:
  - name: codechecks-dependency-cruiser
    options:
      exclude: (node_modules)
      graph: true
      paths:
        - src

Options

namerequiredtypedescription
pathsyesstring[]files or directories to cruise
graphnobooleanwhether to generate dependency graph
excludenostringa regexp for modules to exclude from being cruised
confignostringcustom path to .dependency-cruiser.js or .dependency-cruiser.json

Install GraphViz

macOS

brew install graphviz

Ubuntu

sudo apt-get install graphviz

Limitations