dependency-cruiser 11.8.0 → 11.9.0-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.8.0",
+  "version": "11.9.0-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

package/src/enrich/summarize/index.js

@@ -14,7 +14,7 @@ const {
  * @param {import("../../../types/cruise-result").IModule[]} pModules -
  *    cruised modules that have been enriched with mandatory attributes &
  *    have been validated against rules as passed in the options
- * @param {import("../../../types/options").ICruiseOptions} pOptions -
+ * @param {import("../../../types/options").IStrictCruiseOptions} pOptions -
  * @param {string[]} pFileDirectoryArray -
  *    the files/ directories originally passed to be cruised
  * @param {import("../../../types/dependency-cruiser").IFolder[]} pFolders -

package/src/extract/gather-initial-sources.js

@@ -1,15 +1,16 @@
 const fs = require("fs");
 const path = require("path");
 const glob = require("glob");
-const _get = require("lodash/get");
+const get = require("lodash/get");
 const filenameMatchesPattern =
   require("../graph-utl/match-facade").filenameMatchesPattern;
 const pathToPosix = require("./utl/path-to-posix");
 const transpileMeta = require("./transpile/meta");
+const getExtension = require("./utl/get-extension");
 
 /**
  *
- * @param {import('../../types/options').ICruiseOptions} pOptions
+ * @param {import('../../types/options').IStrictCruiseOptions} pOptions
  * @returns {string[]}
  */
 function getScannableExtensions(pOptions) {
@@ -18,18 +19,22 @@ function getScannableExtensions(pOptions) {
   );
 }
 
+function fileIsScannable(pOptions, pPathToFile) {
+  return getScannableExtensions(pOptions).includes(getExtension(pPathToFile));
+}
+
 function shouldBeIncluded(pFullPathToFile, pOptions) {
   return (
-    !_get(pOptions, "includeOnly.path") ||
+    !get(pOptions, "includeOnly.path") ||
     filenameMatchesPattern(pFullPathToFile, pOptions.includeOnly.path)
   );
 }
 
 function shouldNotBeExcluded(pFullPathToFile, pOptions) {
   return (
-    (!_get(pOptions, "exclude.path") ||
+    (!get(pOptions, "exclude.path") ||
       !filenameMatchesPattern(pFullPathToFile, pOptions.exclude.path)) &&
-    (!_get(pOptions, "doNotFollow.path") ||
+    (!get(pOptions, "doNotFollow.path") ||
       !filenameMatchesPattern(pFullPathToFile, pOptions.doNotFollow.path))
   );
 }
@@ -37,7 +42,7 @@ function shouldNotBeExcluded(pFullPathToFile, pOptions) {
 /**
  *
  * @param {string} pDirectoryName
- * @param  {import('../../types/options').ICruiseOptions} pOptions options that
+ * @param  {import('../../types/options').IStrictCruiseOptions} pOptions options that
  * @returns {string[]}
  */
 function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
@@ -59,11 +64,7 @@ function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
           gatherScannableFilesFromDirectory(pFullPathToFile, pOptions)
         );
       }
-      if (
-        getScannableExtensions(pOptions).some((pExtension) =>
-          pFullPathToFile.endsWith(pExtension)
-        )
-      ) {
+      if (fileIsScannable(pOptions, pFullPathToFile)) {
         return pSum.concat(pFullPathToFile);
       }
       return pSum;
@@ -84,7 +85,7 @@ function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
  *
  * @param  {string[]} pFileAndDirectoryArray globs and/ or paths to files or
  *                               directories to be gathered
- * @param  {import('../../types/dependency-cruiser').ICruiseOptions} pOptions options that
+ * @param  {import('../../types/dependency-cruiser').IStrictCruiseOptions} pOptions options that
  *                               influence what needs to be gathered/ scanned
  *                               notably useful attributes:
  *                               - exclude - regexp of what to exclude

package/src/extract/get-dependencies.js

@@ -108,7 +108,7 @@ function extractWithTsc(
 
 /**
  *
- * @param {import('../../types/dependency-cruiser').ICruiseOptions} pCruiseOptions
+ * @param {import('../../types/dependency-cruiser').IStrictCruiseOptions} pCruiseOptions
  * @param {string} pFileName
  * @param {any} pTranspileOptions
  * @returns {import('../../types/cruise-result').IDependency[]}
@@ -208,7 +208,7 @@ function compareDeps(pLeft, pRight) {
  *
  *
  * @param  {string} pFileName path to the file
- * @param  {import("../../types/dependency-cruiser").ICruiseOptions} pCruiseOptions cruise options
+ * @param  {import("../../types/dependency-cruiser").IStrictCruiseOptions} pCruiseOptions cruise options
  * @param {import("../../types/dependency-cruiser").IResolveOptions} pResolveOptions  webpack 'enhanced-resolve' options
  * @param  {import("../../types/dependency-cruiser").ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
  *                               ('flattened' so there's no need for file access on any

package/src/extract/index.js

@@ -141,7 +141,7 @@ function filterExcludedDynamicDependencies(pModule, pExclude) {
  * returns an array of all the modules it finds that way.
  *
  * @param {string[]} pFileDirectoryArray
- * @param {import("../../types/dependency-cruiser").ICruiseOptions} pCruiseOptions
+ * @param {import("../../types/dependency-cruiser").IStrictCruiseOptions} pCruiseOptions
  * @param {import("../../types/dependency-cruiser").IResolveOptions} pResolveOptions
  * @param {import("../../types/dependency-cruiser").ITranspileOptions} pTranspileOptions
  * @returns {Partial<import("../../types/dependency-cruiser").IModule[]>}

package/src/main/index.js

@@ -51,6 +51,7 @@ function futureCruise(
   pTranspileOptions
 ) {
   bus.emit("progress", "parsing options", c(1));
+  /** @type {import("../../types/strict-options").IStrictCruiseOptions} */
   let lCruiseOptions = normalizeCruiseOptions(
     validateCruiseOptions(pCruiseOptions)
   );

package/src/main/options/defaults.js

@@ -1,4 +1,4 @@
-/** @type {import('../../../types/options').ICruiseOptions} */
+/** @type {import('../../../types/strict-options').IStrictCruiseOptions} */
 module.exports = {
   validate: false,
   maxDepth: 0,

package/src/main/options/normalize.js

@@ -110,11 +110,10 @@ function shouldCalculateMetrics(pOptions) {
 
 /**
  *
- * @param {Partial<import('../../../types/options').ICruiseOptions>} pOptions
- * @returns {import('../../../types/options').ICruiseOptions}
+ * @param {import('../../../types/options').ICruiseOptions} pOptions
+ * @returns {import('../../../types/strict-options').IStrictCruiseOptions}
  */
 function normalizeCruiseOptions(pOptions) {
-  /** @type {import('../../../types/options').ICruiseOptions} */
   let lReturnValue = {
     baseDir: process.cwd(),
     ...defaults,
@@ -145,6 +144,9 @@ function normalizeCruiseOptions(pOptions) {
     );
   }
   lReturnValue.metrics = shouldCalculateMetrics(pOptions);
+  // if (has(pOptions, "ruleSet")) {
+  //   lReturnValue.ruleSet = normalizeRuleSet(pOptions.ruleSet);
+  // }
 
   return lReturnValue;
 }
@@ -152,7 +154,7 @@ function normalizeCruiseOptions(pOptions) {
 /**
  *
  * @param {import("../../../types/dependency-cruiser").IFormatOptions} pFormatOptions
- * @returns {import("../../../types/dependency-cruiser").IFormatOptions}
+ * @returns {import("../../../types/strict-options").IStrictFormatOptions}
  */
 function normalizeFormatOptions(pFormatOptions) {
   const lFormatOptions = clone(pFormatOptions);

package/src/main/rule-set/normalize.js

@@ -1,9 +1,11 @@
+const { cloneDeep } = require("lodash");
 const has = require("lodash/has");
 const normalizeREProperties = require("../utl/normalize-re-properties");
 
 const VALID_SEVERITIES = /^(error|warn|info|ignore)$/;
 const DEFAULT_SEVERITY = "warn";
 const DEFAULT_RULE = "unnamed";
+const DEFAULT_SCOPE = "module";
 
 function normalizeSeverity(pSeverity) {
   const lSeverity = pSeverity ? pSeverity : DEFAULT_SEVERITY;
@@ -12,11 +14,29 @@ function normalizeSeverity(pSeverity) {
     ? lSeverity
     : DEFAULT_SEVERITY;
 }
-
+/**
+ *
+ * @param {string} pRuleName
+ * @returns {string}
+ */
 function normalizeName(pRuleName) {
   return pRuleName ? pRuleName : DEFAULT_RULE;
 }
 
+/**
+ *
+ * @param {import("../../../types/shared-types").RuleScopeType} pScope?
+ * @returns {import("../../../types/shared-types").RuleScopeType}
+ */
+function normalizeScope(pScope) {
+  return pScope ? pScope : DEFAULT_SCOPE;
+}
+
+/**
+ *
+ * @param {import("../../../types/rule-set").IAnyRuleType} pRule
+ * @returns {import("../../../types/strict-rule-set").IStrictAnyRuleType}
+ */
 function normalizeRule(pRule) {
   return {
     ...pRule,
@@ -24,6 +44,7 @@ function normalizeRule(pRule) {
     name: normalizeName(pRule.name),
     from: normalizeREProperties(pRule.from),
     to: normalizeREProperties(pRule.to),
+    scope: normalizeScope(pRule.scope),
     ...(pRule.module ? { module: normalizeREProperties(pRule.module) } : {}),
   };
 }
@@ -34,17 +55,19 @@ function normalizeRule(pRule) {
  * - rule name (default 'unnamed')
  * - severity (default 'warn')
  *
- * @param  {import("../../../types/dependency-cruiser").IFlattenedRuleSet} pRuleSet [description]
- * @return {import("../../../types/dependency-cruiser").IFlattenedRuleSet}          [description]
+ * @param  {import("../../../types/dependency-cruiser").IFlattenedRuleSet} pRuleSet
+ * @return {import("../../../types/strict-rule-set").IStrictRuleSet}
  */
 module.exports = function normalizeRuleSet(pRuleSet) {
-  if (has(pRuleSet, "allowed")) {
-    pRuleSet.allowedSeverity = normalizeSeverity(pRuleSet.allowedSeverity);
-    if (pRuleSet.allowedSeverity === "ignore") {
-      Reflect.deleteProperty(pRuleSet, "allowed");
-      Reflect.deleteProperty(pRuleSet, "allowedSeverity");
+  const lRuleSet = cloneDeep(pRuleSet);
+
+  if (has(lRuleSet, "allowed")) {
+    lRuleSet.allowedSeverity = normalizeSeverity(lRuleSet.allowedSeverity);
+    if (lRuleSet.allowedSeverity === "ignore") {
+      Reflect.deleteProperty(lRuleSet, "allowed");
+      Reflect.deleteProperty(lRuleSet, "allowedSeverity");
     } else {
-      pRuleSet.allowed = pRuleSet.allowed.map((pRule) => ({
+      lRuleSet.allowed = lRuleSet.allowed.map((pRule) => ({
         ...pRule,
         name: "not-in-allowed",
         from: normalizeREProperties(pRule.from),
@@ -53,17 +76,17 @@ module.exports = function normalizeRuleSet(pRuleSet) {
     }
   }
 
-  if (has(pRuleSet, "forbidden")) {
-    pRuleSet.forbidden = pRuleSet.forbidden
+  if (has(lRuleSet, "forbidden")) {
+    lRuleSet.forbidden = lRuleSet.forbidden
       .map(normalizeRule)
       .filter((pRule) => pRule.severity !== "ignore");
   }
 
-  if (has(pRuleSet, "required")) {
-    pRuleSet.required = pRuleSet.required
+  if (has(lRuleSet, "required")) {
+    lRuleSet.required = lRuleSet.required
       .map(normalizeRule)
       .filter((pRule) => pRule.severity !== "ignore");
   }
 
-  return pRuleSet;
+  return lRuleSet;
 };

package/src/main/utl/normalize-re-properties.js

@@ -1,5 +1,6 @@
 /* eslint-disable security/detect-object-injection */
 const get = require("lodash/get");
+const has = require("lodash/has");
 const set = require("lodash/set");
 const cloneDeep = require("lodash/cloneDeep");
 
@@ -16,6 +17,18 @@ const RE_PROPERTIES = [
   "viaSomeNot",
 ];
 
+/**
+ *
+ * @param {string|string[]} pStringish
+ * @returns {string}
+ */
+function normalizeToREAsString(pStringish) {
+  if (Array.isArray(pStringish)) {
+    return pStringish.join("|");
+  }
+  return pStringish;
+}
+
 module.exports = function normalizeREProperties(
   pPropertyContainer,
   pREProperties = RE_PROPERTIES
@@ -23,10 +36,12 @@ module.exports = function normalizeREProperties(
   let lPropertyContainer = cloneDeep(pPropertyContainer);
 
   for (const lProperty of pREProperties) {
-    let lValue = get(lPropertyContainer, lProperty);
-
-    if (Array.isArray(lValue)) {
-      set(lPropertyContainer, lProperty, lValue.join("|"));
+    if (has(lPropertyContainer, lProperty)) {
+      set(
+        lPropertyContainer,
+        lProperty,
+        normalizeToREAsString(get(lPropertyContainer, lProperty))
+      );
     }
   }
   return lPropertyContainer;

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "11.8.0",
+  version: "11.9.0-beta-1",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/src/report/error-html/index.js

@@ -1,58 +1,10 @@
 /* eslint-disable security/detect-object-injection */
 const Handlebars = require("handlebars/runtime");
-const _get = require("lodash/get");
-const {
-  getFormattedAllowedRule,
-  mergeCountsIntoRule,
-  formatSummaryForReport,
-} = require("./utl");
+const { formatSummaryForReport, aggregateViolations } = require("./utl");
 
 // eslint-disable-next-line import/no-unassigned-import
 require("./error-html.template");
 
-function aggregateCountsPerRule(pViolations) {
-  return pViolations.reduce((pAll, pCurrentViolation) => {
-    if (pAll[pCurrentViolation.rule.name]) {
-      pAll[pCurrentViolation.rule.name] =
-        pCurrentViolation.rule.severity === "ignore"
-          ? {
-              count: pAll[pCurrentViolation.rule.name].count,
-              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount + 1,
-            }
-          : {
-              count: pAll[pCurrentViolation.rule.name].count + 1,
-              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount,
-            };
-    } else {
-      pAll[pCurrentViolation.rule.name] =
-        pCurrentViolation.rule.severity === "ignore"
-          ? {
-              count: 0,
-              ignoredCount: 1,
-            }
-          : {
-              count: 1,
-              ignoredCount: 0,
-            };
-    }
-    return pAll;
-  }, {});
-}
-
-function aggregateViolations(pViolations, pRuleSetUsed) {
-  const lViolationCounts = aggregateCountsPerRule(pViolations);
-
-  return _get(pRuleSetUsed, "forbidden", [])
-    .concat(_get(pRuleSetUsed, "required", []))
-    .concat(getFormattedAllowedRule(pRuleSetUsed))
-    .map((pRule) => mergeCountsIntoRule(pRule, lViolationCounts))
-    .sort(
-      (pFirst, pSecond) =>
-        Math.sign(pSecond.count - pFirst.count) ||
-        pFirst.name.localeCompare(pSecond.name)
-    );
-}
-
 function massageSummaryIntoSomethingUsable(pResults) {
   const lSummary = formatSummaryForReport(pResults.summary);
   return {

package/src/report/error-html/utl.js

@@ -1,18 +1,18 @@
-const _get = require("lodash/get");
-const _has = require("lodash/has");
+const get = require("lodash/get");
+const has = require("lodash/has");
 const { version } = require("../../../src/meta.js");
 const { formatViolation, formatInstability } = require("../utl/index.js");
 
 function getFormattedAllowedRule(pRuleSetUsed) {
-  const lAllowed = _get(pRuleSetUsed, "allowed", []);
-  const lCommentedRule = lAllowed.find((pRule) => _has(pRule, "comment"));
+  const lAllowed = get(pRuleSetUsed, "allowed", []);
+  const lCommentedRule = lAllowed.find((pRule) => has(pRule, "comment"));
   const lComment = lCommentedRule ? lCommentedRule.comment : "-";
 
   return lAllowed.length > 0
     ? {
         name: "not-in-allowed",
         comment: lComment,
-        severity: _get(pRuleSetUsed, "allowedSeverity", "warn"),
+        severity: get(pRuleSetUsed, "allowedSeverity", "warn"),
       }
     : [];
 }
@@ -93,7 +93,52 @@ function formatSummaryForReport(pSummary) {
   };
 }
 
+function aggregateCountsPerRule(pViolations) {
+  return pViolations.reduce((pAll, pCurrentViolation) => {
+    if (pAll[pCurrentViolation.rule.name]) {
+      pAll[pCurrentViolation.rule.name] =
+        pCurrentViolation.rule.severity === "ignore"
+          ? {
+              count: pAll[pCurrentViolation.rule.name].count,
+              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount + 1,
+            }
+          : {
+              count: pAll[pCurrentViolation.rule.name].count + 1,
+              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount,
+            };
+    } else {
+      pAll[pCurrentViolation.rule.name] =
+        pCurrentViolation.rule.severity === "ignore"
+          ? {
+              count: 0,
+              ignoredCount: 1,
+            }
+          : {
+              count: 1,
+              ignoredCount: 0,
+            };
+    }
+    return pAll;
+  }, {});
+}
+
+function aggregateViolations(pViolations, pRuleSetUsed) {
+  const lViolationCounts = aggregateCountsPerRule(pViolations);
+
+  return get(pRuleSetUsed, "forbidden", [])
+    .concat(get(pRuleSetUsed, "required", []))
+    .concat(getFormattedAllowedRule(pRuleSetUsed))
+    .map((pRule) => mergeCountsIntoRule(pRule, lViolationCounts))
+    .sort(
+      (pFirst, pSecond) =>
+        Math.sign(pSecond.count - pFirst.count) ||
+        Math.sign(pSecond.ignoredCount - pFirst.ignoredCount) ||
+        pFirst.name.localeCompare(pSecond.name)
+    );
+}
+
 module.exports = {
+  aggregateViolations,
   getFormattedAllowedRule,
   mergeCountsIntoRule,
   formatSummaryForReport,

package/src/report/index.js

@@ -15,6 +15,7 @@ const text = require("./text");
 const baseline = require("./baseline");
 const metrics = require("./metrics");
 const { getExternalPluginReporter } = require("./plugins");
+const markdown = require("./markdown");
 
 const TYPE2REPORTER = {
   anon,
@@ -26,6 +27,7 @@ const TYPE2REPORTER = {
   fdot,
   flat: fdot,
   "err-html": errorHtml,
+  markdown,
   "err-long": errorLong,
   err: error,
   html,

package/src/report/markdown/index.js

@@ -0,0 +1,111 @@
+const { version } = require("../../../src/meta.js");
+const { aggregateViolations } = require("../error-html/utl");
+/**
+ *
+ * @param {import("../../../types/shared-types").SeverityType} pSeverity
+ */
+function severity2Icon(pSeverity) {
+  const lSeverity2IconMap = {
+    error: ":exclamation:",
+    info: ":grey_exclamation:",
+  };
+  // eslint-disable-next-line security/detect-object-injection
+  return lSeverity2IconMap[pSeverity] || ":warning:";
+}
+
+/**
+ *
+ * @param {import("../../../types/cruise-result").ISummary} pSummary
+ */
+function formatStatsSummary(pSummary) {
+  const lSpacerLength = 4;
+  const lSpacer = " ".repeat(lSpacerLength);
+  return `**${pSummary.totalCruised}** modules${lSpacer}**${pSummary.totalDependenciesCruised}** dependencies${lSpacer}**${pSummary.error}** errors${lSpacer}**${pSummary.warn}** warnings${lSpacer}**${pSummary.info}** informational${lSpacer}**${pSummary.ignore}** ignored\n`;
+}
+
+/**
+ *
+ * @param {import("../../../types/cruise-result").ICruiseResult} pCruiseResult
+ */
+function formatViolatedRules(pCruiseResult) {
+  const lTableHead =
+    "|rule|violations|ignored|explanation\n|:---|:---:|:---:|:---|\n";
+
+  return aggregateViolations(
+    pCruiseResult.summary.violations,
+    pCruiseResult.summary.ruleSetUsed
+  )
+    .filter((pRule) => pRule.count > 0)
+    .reduce(
+      (pAll, pRule) =>
+        (pAll += `|${severity2Icon(pRule.severity)} _${pRule.name}_|**${
+          pRule.count
+        }**|**${pRule.ignoredCount}**|${pRule.comment}|\n`),
+      lTableHead
+    );
+}
+
+/**
+ *
+ * @param {import("../../../types/cruise-result").ICruiseResult} pCruiseResult
+ */
+function formatSummary(pCruiseResult) {
+  let lReturnValue = formatStatsSummary(pCruiseResult.summary);
+
+  if (pCruiseResult.summary.violations.length > 0) {
+    lReturnValue += formatViolatedRules(pCruiseResult);
+  }
+  return lReturnValue;
+}
+
+/**
+ *
+ * @param {import("../../../types/cruise-result").IViolation[]} pViolations
+ */
+function formatViolations(pViolations) {
+  const lTableHead = "|violated rule|from|to|\n|:---|:---|:---|\n";
+
+  return pViolations
+    .filter((pViolation) => pViolation.rule.severity !== "ignore")
+    .reduce((pAll, pViolation) => {
+      return `${pAll}|${severity2Icon(pViolation.rule.severity)} _${
+        pViolation.rule.name
+      }_|\`${pViolation.from}\`|\`${pViolation.to}\`|\n`;
+    }, lTableHead);
+}
+
+/**
+ *
+ * @param {import("../../../types/cruise-result").ICruiseResult} pResults
+ */
+function report(pResults) {
+  let lReturnValue = "# Forbidden dependency check - results\n\n";
+
+  lReturnValue += `## :chart_with_upwards_trend: Summary\n\n${formatSummary(
+    pResults
+  )}\n\n`;
+
+  if (pResults.summary.violations.length > 0) {
+    lReturnValue += `<details><summary><h2>:fire: All violations</h2></summary>\n\n`;
+    lReturnValue += `${formatViolations(pResults.summary.violations)}`;
+    lReturnValue += "\n\n</details>\n\n";
+  } else {
+    lReturnValue +=
+      "## :revolving_hearts: No violations found\nGet gummy bears to celebrate.\n\n";
+  }
+
+  lReturnValue += `---\n[dependency-cruiser@${version}](https://www.github.com/sverweij/dependency-crduiser) / ${new Date().toISOString()}`;
+
+  return lReturnValue;
+}
+
+/**
+ * Returns the violations from a cruise in markdown format
+ *
+ * @param {import("../../../types/cruise-result").ICruiseResult} pResults
+ * @returns {import("../../../types/dependency-cruiser").IReporterOutput}
+ */
+module.exports = (pResults) => ({
+  output: report(pResults),
+  exitCode: 0,
+});

package/src/schema/configuration.schema.js

@@ -1,2 +1,2 @@
 /* generated - don't edit */
-module.exports={"title":"dependency-cruiser configuration","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/configuration.schema.json","type":"object","additionalProperties":false,"properties":{"$schema":{"type":"string"},"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}},"options":{"$ref":"#/definitions/OptionsType"},"extends":{"$ref":"#/definitions/ExtendsType"}},"definitions":{"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"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"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"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"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"OptionsType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundDoNotFollowType"}]},"exclude":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundExcludeType"}]},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundFocusType"}]},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"oneOf":[{"type":"string"},{"type":"integer","minimum":1,"maximum":9}]},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","none"]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"}}},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"ExtendsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}}
+module.exports={"title":"dependency-cruiser configuration","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/configuration.schema.json","type":"object","additionalProperties":false,"properties":{"$schema":{"type":"string"},"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}},"options":{"$ref":"#/definitions/OptionsType"},"extends":{"$ref":"#/definitions/ExtendsType"}},"definitions":{"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"AllowedRuleType":{"oneOf":[{"$ref":"#/definitions/RegularAllowedRuleType"},{"$ref":"#/definitions/ReachabilityAllowedRuleType"}]},"RegularAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"ReachabilityAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"ForbiddenRuleType":{"oneOf":[{"$ref":"#/definitions/RegularForbiddenRuleType"},{"$ref":"#/definitions/ReachabilityForbiddenRuleType"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"ReachabilityForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"OptionsType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundDoNotFollowType"}]},"exclude":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundExcludeType"}]},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundFocusType"}]},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"oneOf":[{"type":"string"},{"type":"integer","minimum":1,"maximum":9}]},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","none"]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"}}},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"ExtendsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}}

package/src/schema/cruise-result.schema.js

@@ -1,2 +1,2 @@
 /* generated - don't edit */
-module.exports={"title":"dependency-cruiser output format","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/cruise-result.schema.json","type":"object","required":["summary","modules"],"additionalProperties":false,"properties":{"modules":{"$ref":"#/definitions/ModulesType"},"folders":{"$ref":"#/definitions/FoldersType"},"summary":{"$ref":"#/definitions/SummaryType"}},"definitions":{"ModulesType":{"type":"array","items":{"$ref":"#/definitions/ModuleType"}},"ModuleType":{"type":"object","required":["source","dependencies","valid"],"additionalProperties":false,"properties":{"source":{"type":"string"},"valid":{"type":"boolean"},"dependencies":{"$ref":"#/definitions/DependenciesType"},"dependents":{"type":"array","items":{"type":"string"}},"followable":{"type":"boolean"},"matchesDoNotFollow":{"type":"boolean"},"matchesFocus":{"type":"boolean"},"coreModule":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"orphan":{"type":"boolean"},"reachable":{"type":"array","items":{"$ref":"#/definitions/ReachableType"}},"reaches":{"type":"array","items":{"$ref":"#/definitions/ReachesType"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"consolidated":{"type":"boolean"},"instability":{"type":"number"}}},"ReachableType":{"type":"object","required":["value","asDefinedInRule","matchedFrom"],"additionalProperties":false,"properties":{"value":{"type":"boolean"},"asDefinedInRule":{"type":"string"},"matchedFrom":{"type":"string"}}},"ReachesType":{"type":"object","required":["modules","asDefinedInRule"],"additionalProperties":false,"properties":{"modules":{"type":"array","items":{"type":"object","required":["source","via"],"additionalProperties":false,"properties":{"source":{"type":"string"},"via":{"type":"array","items":{"type":"string"}}}}},"asDefinedInRule":{"type":"string"}}},"DependenciesType":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"DependencyType":{"type":"object","required":["circular","coreModule","couldNotResolve","dependencyTypes","exoticallyRequired","dynamic","followable","module","moduleSystem","resolved","valid"],"additionalProperties":false,"properties":{"module":{"type":"string"},"protocol":{"type":"string","enum":["data:","file:","node:"]},"mimeType":{"type":"string"},"resolved":{"type":"string"},"coreModule":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"followable":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"type":"string"},"matchesDoNotFollow":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"preCompilationOnly":{"type":"boolean"},"typeOnly":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"moduleSystem":{"$ref":"#/definitions/ModuleSystemType"},"valid":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"instability":{"type":"number"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"FoldersType":{"type":"array","items":{"$ref":"#/definitions/FolderType"}},"FolderType":{"type":"object","required":["name","moduleCount"],"additionalProperties":false,"properties":{"name":{"type":"string"},"dependents":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string"}}}},"dependencies":{"type":"array","items":{"type":"object","required":["name","valid","circular"],"additionalProperties":false,"properties":{"name":{"type":"string"},"instability":{"type":"number"},"valid":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}}}}},"moduleCount":{"type":"number"},"afferentCouplings":{"type":"number"},"efferentCouplings":{"type":"number"},"instability":{"type":"number"}}},"SummaryType":{"type":"object","required":["violations","error","warn","info","totalCruised","optionsUsed"],"additionalProperties":false,"properties":{"violations":{"$ref":"#/definitions/ViolationsType"},"error":{"type":"number"},"warn":{"type":"number"},"info":{"type":"number"},"ignore":{"type":"number"},"totalCruised":{"type":"number"},"totalDependenciesCruised":{"type":"number"},"ruleSetUsed":{"$ref":"#/definitions/RuleSetType"},"optionsUsed":{"$ref":"#/definitions/OptionsUsedType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"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"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"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"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"OptionsUsedType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"$ref":"#/definitions/CompoundDoNotFollowType"},"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"$ref":"#/definitions/CompoundFocusType"},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"type":"string"},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","none"]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"},"args":{"type":"string"},"rulesFile":{"type":"string"},"outputTo":{"type":"string"},"outputType":{"$ref":"#/definitions/OutputType"}}},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"OutputType":{"oneOf":[{"type":"string","enum":["json","html","dot","ddot","cdot","archi","fdot","flat","csv","err","err-long","err-html","teamcity","anon","text","metrics"]},{"type":"string","pattern":"^plugin:[^:]+$"}]},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"}}}}}
+module.exports={"title":"dependency-cruiser output format","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/cruise-result.schema.json","type":"object","required":["summary","modules"],"additionalProperties":false,"properties":{"modules":{"$ref":"#/definitions/ModulesType"},"folders":{"$ref":"#/definitions/FoldersType"},"summary":{"$ref":"#/definitions/SummaryType"}},"definitions":{"ModulesType":{"type":"array","items":{"$ref":"#/definitions/ModuleType"}},"ModuleType":{"type":"object","required":["source","dependencies","valid"],"additionalProperties":false,"properties":{"source":{"type":"string"},"valid":{"type":"boolean"},"dependencies":{"$ref":"#/definitions/DependenciesType"},"dependents":{"type":"array","items":{"type":"string"}},"followable":{"type":"boolean"},"matchesDoNotFollow":{"type":"boolean"},"matchesFocus":{"type":"boolean"},"coreModule":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"orphan":{"type":"boolean"},"reachable":{"type":"array","items":{"$ref":"#/definitions/ReachableType"}},"reaches":{"type":"array","items":{"$ref":"#/definitions/ReachesType"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"consolidated":{"type":"boolean"},"instability":{"type":"number"}}},"ReachableType":{"type":"object","required":["value","asDefinedInRule","matchedFrom"],"additionalProperties":false,"properties":{"value":{"type":"boolean"},"asDefinedInRule":{"type":"string"},"matchedFrom":{"type":"string"}}},"ReachesType":{"type":"object","required":["modules","asDefinedInRule"],"additionalProperties":false,"properties":{"modules":{"type":"array","items":{"type":"object","required":["source","via"],"additionalProperties":false,"properties":{"source":{"type":"string"},"via":{"type":"array","items":{"type":"string"}}}}},"asDefinedInRule":{"type":"string"}}},"DependenciesType":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"DependencyType":{"type":"object","required":["circular","coreModule","couldNotResolve","dependencyTypes","exoticallyRequired","dynamic","followable","module","moduleSystem","resolved","valid"],"additionalProperties":false,"properties":{"module":{"type":"string"},"protocol":{"type":"string","enum":["data:","file:","node:"]},"mimeType":{"type":"string"},"resolved":{"type":"string"},"coreModule":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"followable":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"type":"string"},"matchesDoNotFollow":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"preCompilationOnly":{"type":"boolean"},"typeOnly":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"moduleSystem":{"$ref":"#/definitions/ModuleSystemType"},"valid":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"instability":{"type":"number"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"FoldersType":{"type":"array","items":{"$ref":"#/definitions/FolderType"}},"FolderType":{"type":"object","required":["name","moduleCount"],"additionalProperties":false,"properties":{"name":{"type":"string"},"dependents":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string"}}}},"dependencies":{"type":"array","items":{"type":"object","required":["name","valid","circular"],"additionalProperties":false,"properties":{"name":{"type":"string"},"instability":{"type":"number"},"valid":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}}}}},"moduleCount":{"type":"number"},"afferentCouplings":{"type":"number"},"efferentCouplings":{"type":"number"},"instability":{"type":"number"}}},"SummaryType":{"type":"object","required":["violations","error","warn","info","totalCruised","optionsUsed"],"additionalProperties":false,"properties":{"violations":{"$ref":"#/definitions/ViolationsType"},"error":{"type":"number"},"warn":{"type":"number"},"info":{"type":"number"},"ignore":{"type":"number"},"totalCruised":{"type":"number"},"totalDependenciesCruised":{"type":"number"},"ruleSetUsed":{"$ref":"#/definitions/RuleSetType"},"optionsUsed":{"$ref":"#/definitions/OptionsUsedType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"AllowedRuleType":{"oneOf":[{"$ref":"#/definitions/RegularAllowedRuleType"},{"$ref":"#/definitions/ReachabilityAllowedRuleType"}]},"RegularAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"ReachabilityAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"ForbiddenRuleType":{"oneOf":[{"$ref":"#/definitions/RegularForbiddenRuleType"},{"$ref":"#/definitions/ReachabilityForbiddenRuleType"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"ReachabilityForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"OptionsUsedType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"$ref":"#/definitions/CompoundDoNotFollowType"},"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"$ref":"#/definitions/CompoundFocusType"},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"type":"string"},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","none"]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"},"args":{"type":"string"},"rulesFile":{"type":"string"},"outputTo":{"type":"string"},"outputType":{"$ref":"#/definitions/OutputType"}}},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"OutputType":{"oneOf":[{"type":"string","enum":["json","html","dot","ddot","cdot","archi","fdot","flat","csv","err","err-long","err-html","teamcity","anon","text","metrics","markdown"]},{"type":"string","pattern":"^plugin:[^:]+$"}]},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"}}}}}

package/src/validate/rule-classifiers.js

@@ -2,7 +2,7 @@ const has = require("lodash/has");
 const get = require("lodash/get");
 
 /**
- * @param {import("../../types/rule-set").IAnyRuleType} pRule a dependency-cruiser rule
+ * @param {import("../../types/strict-rule-set").IStrictAnyRuleType} pRule a dependency-cruiser rule
  * @returns {boolean} whether or not the rule is 'module only'
  */
 function isModuleOnlyRule(pRule) {
@@ -13,8 +13,14 @@ function isModuleOnlyRule(pRule) {
     has(pRule, "module")
   );
 }
-
+/**
+ *
+ * @param {import("../../types/strict-rule-set").IStrictAnyRuleType} pRule
+ * @returns {boolean} whether or not the scope of the rule is "folder" or something else
+ */
 function isFolderScope(pRule) {
+  // TODO might be possible to just rule pRule.scope as it's now
+  // normalized away before getting here.
   return get(pRule, "scope", "module") === "folder";
 }
 

package/types/options.d.ts

@@ -83,7 +83,7 @@ export interface ICruiseOptions {
    * and the collapse options offer better, more reliable and more
    * understandable results.
    */
-  maxDepth?: number;
+  maxDepth?: number | string;
   /**
    * an array of module systems to use for following dependencies;
    * defaults to ["es6", "cjs", "amd"]

package/types/rule-set.d.ts

@@ -113,10 +113,6 @@ export interface IRequiredRuleType extends IBaseRuleType {
   to: IRequiredToRestrictionType;
 }
 
-export type IAllowedRuleType =
-  | IRegularAllowedRuleType
-  | IReachabilityAllowedRuleType;
-
 export interface IRegularAllowedRuleType {
   /**
    * You can use this field to document why the rule is there.
@@ -134,6 +130,10 @@ export interface IRegularAllowedRuleType {
   to: IToRestriction;
 }
 
+export type IAllowedRuleType =
+  | IRegularAllowedRuleType
+  | IReachabilityAllowedRuleType;
+
 export type IAnyRuleType =
   | IForbiddenRuleType
   | IAllowedRuleType

package/types/strict-filter-types.d.ts

@@ -0,0 +1,47 @@
+import {
+  IDoNotFollowType,
+  IExcludeType,
+  IFocusType,
+  IIncludeOnlyType,
+} from "./filter-types";
+import { DependencyType } from "./shared-types";
+
+export interface IStrictDoNotFollowType extends IDoNotFollowType {
+  /**
+   * a regular expression for modules to include, but not follow further
+   */
+  path?: string;
+  /**
+   * an array of dependency types to include, but not follow further
+   */
+  dependencyTypes?: DependencyType[];
+}
+
+export interface IStrictExcludeType extends IExcludeType {
+  /**
+   * a regular expression for modules to exclude
+   */
+  path?: string;
+  /**
+   * a boolean indicating whether or not to exclude dynamic dependencies
+   * leave out to match both
+   */
+  dynamic?: boolean;
+}
+
+export interface IStrictIncludeOnlyType extends IIncludeOnlyType {
+  /**
+   * regular expression describing which dependencies the function
+   * should cruise - anything not matching this will be skipped
+   */
+  path: string;
+}
+
+export interface IStrictFocusType extends IFocusType {
+  /**
+   * dependency-cruiser will include modules matching this regular expression
+   * in its output, as well as their neighbours (direct dependencies and
+   * dependents)
+   */
+  path: string;
+}

package/types/strict-options.d.ts

@@ -0,0 +1,47 @@
+import {
+  ICruiseOptions,
+  IFormatOptions,
+  ExternalModuleResolutionStrategyType,
+} from "./options";
+import { ModuleSystemType, OutputType } from "./shared-types";
+import { IStrictRuleSet } from "./strict-rule-set";
+import {
+  IStrictDoNotFollowType,
+  IStrictExcludeType,
+  IStrictFocusType,
+  IStrictIncludeOnlyType,
+} from "./strict-filter-types";
+
+/**
+ * the ICruiseOptions interface is lenient in what it accepts for convenience
+ * and/ or backwards compatiblity reasons. Internally we use a stricter version
+ * of ICruiseOptions that
+ * - allows only one data type per attribute
+ * - makes some attributes mandatory so they're easier to work with
+ */
+export interface IStrictCruiseOptions extends ICruiseOptions {
+  validate: boolean;
+  ruleSet?: IStrictRuleSet;
+  doNotFollow: IStrictDoNotFollowType;
+  exclude: IStrictExcludeType;
+  includeOnly?: IStrictIncludeOnlyType;
+  focus?: IStrictFocusType;
+  collapse?: string;
+  maxDepth: number;
+  moduleSystems: ModuleSystemType[];
+  baseDir: string;
+  tsPreCompilationDeps: boolean | "specify";
+  extraExtensionsToScan: string[];
+  preserveSymlinks: boolean;
+  externalModuleResolutionStrategy: ExternalModuleResolutionStrategyType;
+  exoticRequireStrings: string[];
+  metrics: boolean;
+}
+
+export interface IStrictFormatOptions extends IFormatOptions {
+  exclude?: IStrictExcludeType;
+  includeOnly?: IStrictIncludeOnlyType;
+  focus?: IStrictFocusType;
+  collapse?: string;
+  outputType: OutputType;
+}

package/types/strict-restrictions.d.ts

@@ -0,0 +1,47 @@
+import {
+  IBaseRestrictionType,
+  IFromRestriction,
+  IToRestriction,
+  IReachabilityToRestrictionType,
+  IRequiredToRestrictionType,
+  IDependentsModuleRestrictionType,
+} from "./restrictions";
+
+export interface IStrictBaseRestrictionType extends IBaseRestrictionType {
+  path?: string;
+  pathNot?: string;
+}
+
+export interface IStrictFromRestriction extends IFromRestriction {
+  path?: string;
+  pathNot?: string;
+}
+
+interface IStrictToRestriction extends IToRestriction {
+  path?: string;
+  pathNot?: string;
+  via?: string;
+  viaNot?: string;
+  viaSomeNot?: string;
+  exoticRequire?: string;
+  exoticRequireNot?: string;
+  license?: string;
+  licenseNot?: string;
+}
+
+export interface IStrictReachabilityToRestrictionType
+  extends IReachabilityToRestrictionType {
+  path?: string;
+  pathNot?: string;
+}
+
+export interface IStrictRequiredToRestrictionType
+  extends IRequiredToRestrictionType {
+  path?: string;
+}
+
+export interface IStrictDependentsModuleRestrictionType
+  extends IDependentsModuleRestrictionType {
+  path?: string;
+  pathNot?: string;
+}

package/types/strict-rule-set.d.ts

@@ -0,0 +1,72 @@
+import { SeverityType, RuleScopeType } from "./shared-types";
+import {
+  IBaseRuleType,
+  IRegularAllowedRuleType,
+  IFlattenedRuleSet,
+} from "./rule-set";
+import {
+  IStrictToRestriction,
+  IStrictFromRestriction,
+  IStrictBaseRestrictionType,
+  IStrictReachabilityToRestrictionType,
+  IStrictDependentsModuleRestrictionType,
+  IStrictRequiredToRestrictionType,
+} from "./strict-restrictions";
+
+export interface IStrictBaseRuleType extends IBaseRuleType {
+  name: string;
+  severity: SeverityType;
+}
+
+export interface IStrictRegularForbiddenRuleType extends IStrictBaseRuleType {
+  from: IStrictFromRestriction;
+  to: IStrictToRestriction;
+  scope: RuleScopeType;
+}
+
+export interface IStrictReachabilityForbiddenRuleType
+  extends IStrictBaseRuleType {
+  from: IStrictBaseRestrictionType;
+  to: IStrictReachabilityToRestrictionType;
+}
+
+export interface IStrictDependentsForbiddenRuleType
+  extends IStrictBaseRuleType {
+  module: IStrictDependentsModuleRestrictionType;
+  from: IStrictBaseRestrictionType;
+}
+
+export interface IStrictReachabilityAllowedRuleType {
+  from: IStrictBaseRestrictionType;
+  to: IStrictReachabilityToRestrictionType;
+}
+
+export type IStrictForbiddenRuleType =
+  | IStrictRegularForbiddenRuleType
+  | IStrictReachabilityForbiddenRuleType
+  | IStrictDependentsForbiddenRuleType;
+
+export interface IStrictRequiredRuleType extends IStrictBaseRuleType {
+  module: IStrictBaseRestrictionType;
+  to: IStrictRequiredToRestrictionType;
+}
+
+export interface IStrictRegularAllowedRuleType extends IRegularAllowedRuleType {
+  from: IStrictFromRestriction;
+  to: IStrictToRestriction;
+}
+export type IStrictAllowedRuleType =
+  | IStrictRegularAllowedRuleType
+  | IStrictReachabilityAllowedRuleType;
+
+export type IStrictAnyRuleType =
+  | IStrictForbiddenRuleType
+  | IStrictAllowedRuleType
+  | IStrictRequiredRuleType;
+
+export interface IStrictRuleSet extends IFlattenedRuleSet {
+  forbidden?: IStrictForbiddenRuleType[];
+  allowed?: IStrictAllowedRuleType[];
+  allowedSeverity?: SeverityType;
+  required?: IStrictRequiredRuleType[];
+}