config-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://dependency-cruiser.js.org/config-schema",
  "title": "dependency-cruiser configuration",
  "description": "A set of properties describing what dependencies are forbidden and what dependencies are allowed.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "extends": {
      "description": "A configuration this configuration uses as a base",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "description": "A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "forbidden": {
      "type": "array",
      "description": "A list of rules that describe dependencies that are not allowed. dependency-cruiser will emit a separate error (warning/ informational) messages for each violated rule.",
      "items": {
        "$ref": "#/definitions/ForbiddenRuleType"
      }
    },
    "allowed": {
      "type": "array",
      "description": "A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.",
      "items": {
        "$ref": "#/definitions/AllowedRuleType"
      }
    },
    "allowedSeverity": {
      "$ref": "#/definitions/SeverityType",
      "description": "Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'"
    },
    "options": {
      "type": "object",
      "description": "Runtime configuration options",
      "additionalProperties": false,
      "properties": {
        "doNotFollow": {
          "oneOf": [
            {
              "type": "string",
              "description": "a regular expression for modules to include, but not follow further"
            },
            {
              "type": "object",
              "description": "Criteria for modules to include, but not to follow further",
              "additionalProperties": false,
              "properties": {
                "path": {
                  "type": "string",
                  "description": "a regular expression for modules to include, but not follow further"
                },
                "dependencyTypes": {
                  "type": "array",
                  "description": "an array of dependency types to include, but not follow further",
                  "items": { "$ref": "#/definitions/DependencyType" }
                }
              }
            }
          ]
        },
        "exclude": {
          "oneOf": [
            {
              "type": "string",
              "description": "a regular expression for modules to exclude from being cruised"
            },
            {
              "type": "object",
              "description": "Criteria for dependencies to exclude",
              "additionalProperties": false,
              "properties": {
                "path": {
                  "type": "string",
                  "description": "a regular expression for modules to exclude from being cruised"
                },
                "dynamic": {
                  "type": "boolean",
                  "description": "a boolean indicating whether or not to exclude dynamic dependencies"
                }
              }
            }
          ]
        },
        "includeOnly": {
          "type": "string",
          "description": "a regular expression for modules to cruise; anything outside it will be skipped"
        },
        "maxDepth": {
          "type": "number",
          "minimum": 0,
          "maximum": 99,
          "description": "The maximum cruise depth specified. 0 means no maximum specified"
        },
        "moduleSystems": {
          "type": "array",
          "description": "list of module systems to cruise. Defaults to [amd, cjs, es6]",
          "items": {
            "type": "string",
            "enum": ["amd", "cjs", "es6", "tsd"]
          }
        },
        "prefix": {
          "type": "string"
        },
        "preserveSymlinks": {
          "type": "boolean",
          "description": "if true leave symlinks untouched, otherwise use the realpath. Defaults to `false` (which is also nodejs's default behavior since version 6)"
        },
        "combinedDependencies": {
          "type": "boolean",
          "description": "if true combines the package.jsons found from the module up to the base folder the cruise is initiated from. Useful for how (some) mono-repos manage dependencies & dependency definitions. Defaults to `false`."
        },
        "tsConfig": {
          "type": "object",
          "additionalProperties": false,
          "description": "Typescript project file ('tsconfig.json') to use for (1) compilation and (2) resolution (e.g. with the paths property)",
          "properties": {
            "fileName": {
              "description": "The typescript project file to use. The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './tsconfig.json'.",
              "type": "string"
            }
          }
        },
        "tsPreCompilationDeps": {
          "description": "if true detect dependencies that only exist before typescript-to-javascript compilation.",
          "oneOf": [
            { "type": "boolean" },
            { "type": "string", "enum": ["specify"] }
          ]
        },
        "externalModuleResolutionStrategy": {
          "type": "string",
          "description": "What external module resolution strategy to use. Defaults to 'node_modules'",
          "enum": ["node_modules", "yarn-pnp"]
        },
        "webpackConfig": {
          "type": "object",
          "additionalProperties": false,
          "description": "Webpack configuration to use to get resolve options from",
          "properties": {
            "fileName": {
              "type": "string",
              "description": "The webpack conf file to use (typically something like 'webpack.conf.js'). The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './webpack.conf.js'."
            },
            "env": {
              "description": "Environment to pass if your config file returns a function",
              "oneOf": [
                {
                  "type": "object"
                },
                {
                  "type": "string"
                }
              ]
            },
            "arguments": {
              "type": "object",
              "description": "Arguments to pass if your config file returns a function. E.g. {mode: 'production'} if you want to use webpack 4's 'mode' feature"
            }
          }
        },
        "exoticRequireStrings": {
          "type": "array",
          "description": "List of strings you have in use in addition to cjs/ es6 requires & imports to declare module dependencies. Use this e.g. if you've redeclared require (`const want = require`), use a require-wrapper (like semver-try-require) or use window.require as a hack to workaround something",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "definitions": {
    "AllowedRuleType": {
      "oneOf": [
        { "$ref": "#/definitions/RegularAllowedRuleType" },
        { "$ref": "#/definitions/ReachabilityAllowedRuleType" }
      ]
    },
    "RegularAllowedRuleType": {
      "type": "object",
      "required": ["from", "to"],
      "additionalProperties": false,
      "properties": {
        "comment": {
          "type": "string"
        },
        "from": {
          "$ref": "#/definitions/FromRestrictionType"
        },
        "to": {
          "$ref": "#/definitions/ToRestrictionType"
        }
      }
    },
    "ReachabilityAllowedRuleType": {
      "type": "object",
      "required": ["from", "to"],
      "additionalProperties": false,
      "properties": {
        "comment": {
          "type": "string"
        },
        "from": {
          "$ref": "#/definitions/ReachabilityFromRestrictionType"
        },
        "to": {
          "$ref": "#/definitions/ReachabilityToRestrictionType"
        }
      }
    },
    "ForbiddenRuleType": {
      "oneOf": [
        { "$ref": "#/definitions/RegularForbiddenRuleType" },
        { "$ref": "#/definitions/ReachabilityForbiddenRuleType" }
      ]
    },
    "RegularForbiddenRuleType": {
      "type": "object",
      "required": ["from", "to"],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "A short name for the rule - will appear in reporters to enable customers to quickly identify a violated rule. Try to keep them short, eslint style. E.g. 'not-to-core' for a rule forbidding dependencies on core modules, or 'not-to-unresolvable' for one that prevents dependencies on modules that probably don't exist."
        },
        "severity": { "$ref": "#/definitions/SeverityType" },
        "comment": {
          "type": "string",
          "description": "You can use this field to document why the rule is there."
        },
        "from": {
          "$ref": "#/definitions/FromRestrictionType"
        },
        "to": {
          "$ref": "#/definitions/ToRestrictionType"
        }
      }
    },
    "ReachabilityForbiddenRuleType": {
      "type": "object",
      "required": ["from", "to"],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "severity": { "$ref": "#/definitions/SeverityType" },
        "comment": {
          "type": "string"
        },
        "from": {
          "$ref": "#/definitions/ReachabilityFromRestrictionType"
        },
        "to": {
          "$ref": "#/definitions/ReachabilityToRestrictionType"
        }
      }
    },
    "FromRestrictionType": {
      "type": "object",
      "description": "Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.",
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": "string",
          "description": "A regular expression an end of a dependency should match to be catched by this rule."
        },
        "pathNot": {
          "type": "string",
          "description": "A regular expression an end of a dependency should NOT match to be catched by this rule."
        },
        "orphan": {
          "type": "boolean",
          "description": "Whether or not to match when the module is an orphan (= has no incoming or outgoing dependencies). When this property it is part of a rule, dependency-cruiser will ignore the 'to' part."
        }
      }
    },
    "ReachabilityFromRestrictionType": {
      "type": "object",
      "description": "Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.",
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": "string",
          "description": "A regular expression an end of a dependency should match to be catched by this rule."
        },
        "pathNot": {
          "type": "string",
          "description": "A regular expression an end of a dependency should NOT match to be catched by this rule."
        }
      }
    },
    "ToRestrictionType": {
      "type": "object",
      "description": "Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.",
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": "string",
          "description": "A regular expression an end of a dependency should match to be catched by this rule."
        },
        "pathNot": {
          "type": "string",
          "description": "A regular expression an end of a dependency should NOT match to be catched by this rule."
        },
        "couldNotResolve": {
          "type": "boolean",
          "description": "Whether or not to match modules dependency-cruiser could not resolve (and probably aren't on disk). For this one too: leave out if you don't care either way."
        },
        "circular": {
          "type": "boolean",
          "description": "Whether or not to match when following to the to will ultimately end up in the from."
        },
        "dynamic": {
          "type": "boolean",
          "description": "Whether or not to match when the dependency is a dynamic one."
        },
        "exoticRequire": {
          "type": "string",
          "description": "A regular expression to match against any 'exotic' require strings"
        },
        "exoticRequireNot": {
          "type": "string",
          "description": "A regular expression to match against any 'exotic' require strings - when it should NOT be caught by the rule"
        },
        "preCompilationOnly": {
          "type": "boolean",
          "description": "true if this dependency only exists before compilation (like type only imports), false in all other cases. Only returned when the tsPreCompilationDeps is set to 'specify'."
        },
        "dependencyTypes": {
          "type": "array",
          "description": "Whether or not to match modules of any of these types (leaving out matches any of them)",
          "items": { "$ref": "#/definitions/DependencyType" }
        },
        "moreThanOneDependencyType": {
          "type": "boolean",
          "description": "If true matches dependencies with more than one dependency type (e.g. defined in _both_ npm and npm-dev)"
        },
        "license": {
          "type": "string",
          "description": "Whether or not to match modules that were released under one of the mentioned licenses. E.g. to flag GPL-1.0, GPL-2.0 licensed modules (e.g. because your app is not compatible with the GPL) use \"GPL\""
        },
        "licenseNot": {
          "type": "string",
          "description": "Whether or not to match modules that were NOT released under one of the mentioned licenses. E.g. to flag everyting non MIT use \"MIT\" here"
        }
      }
    },
    "ReachabilityToRestrictionType": {
      "description": "Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.",
      "required": ["reachable"],
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": "string",
          "description": "A regular expression an end of a dependency should match to be catched by this rule."
        },
        "pathNot": {
          "type": "string",
          "description": "A regular expression an end of a dependency should NOT match to be catched by this rule."
        },
        "reachable": {
          "type": "boolean",
          "description": "Whether or not to match modules that aren't reachable from the from part of the rule."
        }
      }
    },
    "SeverityType": {
      "type": "string",
      "description": "How severe a violation of a rule is. The 'error' severity will make some reporters return a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated: use that.",
      "enum": ["error", "warn", "info", "ignore"]
    },
    "DependencyType": {
      "type": "string",
      "enum": [
        "aliased",
        "core",
        "deprecated",
        "local",
        "localmodule",
        "npm",
        "npm-bundled",
        "npm-dev",
        "npm-no-pkg",
        "npm-optional",
        "npm-peer",
        "npm-unknown",
        "undetermined",
        "unknown"
      ]
    }
  }
}