https://github.com/MichalZalecki/codechecks-dependency-cruiser

Validate module dependencies with dependency-cruiser
https://github.com/MichalZalecki/codechecks-dependency-cruiser

Last synced: 2 months ago
JSON representation

Validate module dependencies with dependency-cruiser

• Host: GitHub
• URL: https://github.com/MichalZalecki/codechecks-dependency-cruiser
• Owner: MichalZalecki
• Created: 2019-08-25T17:03:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T08:14:16.000Z (about 2 years ago)
• Last Synced: 2024-11-02T14:42:26.835Z (2 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/codechecks-dependency-cruiser
• Size: 45.9 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# codechecks-dependency-cruiser

## Usage

Add to your `codechecks.yml` file:

```yml

checks:

  - name: codechecks-dependency-cruiser

    options:

      exclude: (node_modules)

      graph: true

      paths:

        - src

```

Options

| name | required | type | description |

| --- | --- | ---  | --- |

| `paths` | yes | `string[]` | files or directories to cruise |

| `graph` | no | `boolean` | whether to generate dependency graph |

| `exclude` | no | `string` | a regexp for modules to exclude from being cruised |

| `config` | no | `string` | custom path to .dependency-cruiser.js or .dependency-cruiser.json |

## Install GraphViz

macOS

    brew install graphviz

Ubuntu

    sudo apt-get install graphviz

## Limitations

* Extending presets is not supported, use self-contained dependency-cruiser configuration

* Generating graphs require [GraphViz](http://www.graphviz.org/) installed