dependency-cruiser/doc/rules.md

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

# dependency-cruiser's validation format
- A [json schema](../src/validate/jsonschema.json) describes the output format.
- Examples:
  - a [starter rule set](./rules.starter.json)
  - dependency-cruiser's [own rule set](../.dependency-cruiser-custom.json)

```json
{
    "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" }
    },{
        "name": "not-to-spec",
        "comment": "Don't allow dependencies to (typescript or javascript) spec files",
        "severity": "error",
        "from": {},
        "to": { "path": "\\.spec\\.[jt]s$" }
    },{
        "name": "not-to-core-punycode",
        "comment": "Warn about dependencies on the (deprecated) 'punycode' core module (use the userland punycode module instead).",
        "severity": "warn",
        "from": {},
        "to": { "coreModule": true, "path": "^punycode$" }
    },{
        "name": "not-to-unresolvable",
        "comment": "Don't allow dependencies on modules dependency-cruiser can't resolve to files on disk (which probably means they don't exist)",
        "severity": "error",
        "from": {},
        "to": { "couldNotResolve": true }
    }]
}
```

## Basics
- _Explain name/ severity/ comment/ from/ to/ path_
- _Advise {} over {"path": ".+"}_


## Reference
### Forbidden
### Allowed
### Specifying and excluding paths
### Attributes
#### path
#### pathNot
#### couldNotResolve
#### coreModule