dependency-cruiser 11.7.1 → 11.9.0-beta-2

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.7.1",
+  version: "11.9.0-beta-2",
   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,145 @@
+const { version } = require("../../../src/meta.js");
+const { aggregateViolations } = require("../error-html/utl");
+
+const REPORT_DEFAULTS = {
+  showTitle: true,
+  title: "Forbidden dependency check - results",
+
+  showSummary: true,
+  showSummaryHeader: true,
+  summaryHeader: ":chart_with_upwards_trend: Summary",
+  showStatsSummary: true,
+  showRulesSummary: true,
+
+  showDetails: true,
+  showDetailsHeader: true,
+  detailsHeader: ":fire: All violations",
+  collapseDetails: true,
+  collapsedMessage: "Violations found - click to expand",
+  noViolationsMessage:
+    ":revolving_hearts: No violations found. Get gummy bears to celebrate.",
+
+  showFooter: true,
+  footer: `---\n[dependency-cruiser@${version}](https://www.github.com/sverweij/dependency-cruiser) / ${new Date().toISOString()}`,
+};
+
+/**
+ *
+ * @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 formatRulesSummary(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").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
+ */
+// eslint-disable-next-line complexity, max-statements
+function report(pResults, pOptions) {
+  const lOptions = { ...REPORT_DEFAULTS, ...(pOptions || {}) };
+  let lReturnValue = "";
+
+  if (lOptions.showTitle) {
+    lReturnValue += `# ${lOptions.title}\n\n`;
+  }
+
+  if (lOptions.showSummary) {
+    if (lOptions.showSummaryHeader) {
+      lReturnValue += `## ${lOptions.summaryHeader}\n\n`;
+    }
+    lReturnValue += `${formatStatsSummary(pResults.summary)}\n\n`;
+
+    if (pResults.summary.violations.length > 0 && lOptions.showRulesSummary) {
+      lReturnValue += `${formatRulesSummary(pResults)}\n\n`;
+    }
+  }
+
+  if (lOptions.showDetails) {
+    if (pResults.summary.violations.length > 0) {
+      if (lOptions.showDetailsHeader) {
+        lReturnValue += `## ${lOptions.detailsHeader}\n\n`;
+      }
+      if (lOptions.collapseDetails) {
+        lReturnValue += `<details><summary>${lOptions.collapsedMessage}</summary>\n\n`;
+      }
+      lReturnValue += `${formatViolations(pResults.summary.violations)}\n\n`;
+      if (lOptions.collapseDetails) {
+        lReturnValue += "</details>\n\n";
+      }
+    } else {
+      lReturnValue += `${lOptions.noViolationsMessage}\n\n`;
+    }
+  }
+
+  if (lOptions.showFooter) {
+    lReturnValue += `${lOptions.footer}\n\n`;
+  }
+
+  return lReturnValue;
+}
+
+/**
+ * Returns the violations from a cruise in markdown format
+ *
+ * @param {import("../../../types/cruise-result").ICruiseResult} pResults
+ * * @param {any} pOptions
+ * @returns {import("../../../types/dependency-cruiser").IReporterOutput}
+ */
+module.exports = (pResults, pOptions) => ({
+  output: report(pResults, pOptions),
+  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"},"markdown":{"$ref":"#/definitions/MarkdownReporterOptionsType"},"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"}}},"MarkdownReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"showTitle":{"type":"boolean"},"showSummary":{"type":"boolean"},"showSummaryHeader":{"type":"boolean"},"showStatsSummary":{"type":"boolean"},"showRulesSummary":{"type":"boolean"},"showDetails":{"type":"boolean"},"showDetailsHeader":{"type":"boolean"},"collapseDetails":{"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"}}]}}}