dependency-cruiser 11.4.1 → 11.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.4.1",
+  "version": "11.5.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -140,7 +140,7 @@
     "acorn-jsx-walk": "2.0.0",
     "acorn-loose": "8.3.0",
     "acorn-walk": "8.2.0",
-    "ajv": "8.10.0",
+    "ajv": "8.11.0",
     "chalk": "^4.1.2",
     "commander": "9.1.0",
     "enhanced-resolve": "5.9.2",
@@ -149,49 +149,49 @@
     "glob": "7.2.0",
     "handlebars": "4.7.7",
     "indent-string": "^4.0.0",
-    "inquirer": "8.2.1",
-    "json5": "2.2.0",
+    "inquirer": "8.2.2",
+    "json5": "2.2.1",
     "lodash": "4.17.21",
     "safe-regex": "2.1.1",
-    "semver": "^7.3.5",
-    "semver-try-require": "^5.0.1",
+    "semver": "^7.3.6",
+    "semver-try-require": "^5.0.2",
     "teamcity-service-messages": "0.1.12",
     "tsconfig-paths-webpack-plugin": "3.5.2",
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.8",
-    "@babel/plugin-transform-modules-commonjs": "7.17.7",
+    "@babel/core": "7.17.9",
+    "@babel/plugin-transform-modules-commonjs": "7.17.9",
     "@babel/preset-typescript": "7.16.7",
-    "@swc/core": "1.2.159",
-    "@typescript-eslint/eslint-plugin": "5.15.0",
-    "@typescript-eslint/parser": "5.15.0",
+    "@swc/core": "1.2.165",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@typescript-eslint/parser": "5.18.0",
     "@vue/compiler-sfc": "3.2.31",
     "c8": "7.11.0",
     "chai": "4.3.6",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.6.1",
-    "eslint": "^8.11.0",
+    "eslint": "^8.13.0",
     "eslint-config-moving-meadow": "3.0.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-budapestian": "3.0.1",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.4.0",
-    "eslint-plugin-unicorn": "^41.0.1",
+    "eslint-plugin-unicorn": "^42.0.0",
     "husky": "^4.3.8",
     "intercept-stdout": "0.1.2",
     "lint-staged": "12.3.4",
     "mocha": "9.2.2",
     "normalize-newline": "^3.0.0",
     "npm-run-all": "4.1.5",
-    "prettier": "2.6.0",
+    "prettier": "2.6.2",
     "proxyquire": "2.1.3",
     "shx": "0.3.4",
-    "svelte": "3.46.4",
+    "svelte": "3.47.0",
     "symlink-dir": "5.0.1",
-    "typescript": "4.6.2",
+    "typescript": "4.6.3",
     "upem": "^7.0.0",
     "vue-template-compiler": "2.6.14",
     "yarn": "1.22.18"

package/src/enrich/derive/circular/get-cycle.js

@@ -1,4 +1,4 @@
-const { findModuleByName } = require("../module-utl");
+/* eslint-disable security/detect-object-injection */
 /* about the absence of checks whether attributes/ objects actually
  * exist:
  * - it saves CPU cycles to the effect of being ~30% faster than with the
@@ -11,37 +11,53 @@ const { findModuleByName } = require("../module-utl");
  * Returns the first non-zero length path from pInitialSource to pInitialSource
  * Returns the empty array if there is no such path
  *
- * @param  {any} pGraph      The graph in which to test this condition
- * @param  {string} pInitialSource The 'source' attribute of the node to be tested
- *                              (source uniquely identifying a node)
- * @param  {string} pCurrentSource   The 'source' attribute of the 'to' node to
- *                              be traversed
- * @param  {Set} pVisited       The set of nodes visited hithereto (optional
- *                              attribute - there's no need to pass it when
- *                              calling it; it's used by the algorithm to
- *                              determine the stop condition)
- * @return {string[]}           see description above
+ * @param {any} pGraph            The graph in which to test this condition
+ * @param {string} pInitialSource The 'source' attribute of the node to be tested
+ *                                (source uniquely identifying a node)
+ * @param {string} pCurrentSource The 'source' attribute of the 'to' node to
+ *                                be traversed
+ * @param {string} pDependencyName The attribute name of the dependency to use.
+ *                                defaults to "resolved" (which is in use for
+ *                                modules). For folders pass "name"
+ * @param {function} pFindNodeByName Function taking a Graph and a pCurrentSource string
+ *                                that returns the Node in that graph going by
+ *                                that name. Defaults to findModuleByName (which
+ *                                is in use for modules). For folders pass
+ *                                findFolderByName
+ * @param {Set} pVisited          The set of nodes visited hithereto (optional
+ *                                attribute - there's no need to pass it when
+ *                                calling it; it's used by the algorithm to
+ *                                determine the stop condition)
+ * @return {string[]}             see description above
  */
-function getCycle(pGraph, pInitialSource, pCurrentSource, pVisited) {
+// eslint-disable-next-line max-params
+function getCycle(
+  pGraph,
+  pInitialSource,
+  pCurrentSource,
+  { pDependencyName, pFindNodeByName },
+  pVisited
+) {
   pVisited = pVisited || new Set();
 
-  const lCurrentNode = findModuleByName(pGraph, pCurrentSource);
+  const lCurrentNode = pFindNodeByName(pGraph, pCurrentSource);
   const lDependencies = lCurrentNode.dependencies.filter(
-    (pDependency) => !pVisited.has(pDependency.resolved)
+    (pDependency) => !pVisited.has(pDependency[pDependencyName])
   );
   const lMatch = lDependencies.find(
-    (pDependency) => pDependency.resolved === pInitialSource
+    (pDependency) => pDependency[pDependencyName] === pInitialSource
   );
   if (lMatch) {
-    return [pCurrentSource, lMatch.resolved];
+    return [pCurrentSource, lMatch[pDependencyName]];
   }
   return lDependencies.reduce((pAll, pDependency) => {
     if (!pAll.includes(pCurrentSource)) {
       const lCycle = getCycle(
         pGraph,
         pInitialSource,
-        pDependency.resolved,
-        pVisited.add(pDependency.resolved)
+        pDependency[pDependencyName],
+        { pDependencyName, pFindNodeByName },
+        pVisited.add(pDependency[pDependencyName])
       );
 
       if (lCycle.length > 0 && !lCycle.includes(pCurrentSource)) {

package/src/enrich/derive/circular/index.js

@@ -1,15 +1,25 @@
+/* eslint-disable security/detect-object-injection */
 const getCycle = require("./get-cycle");
 
-function addCircularityCheckToDependency(pToDep, pGraph, pFrom) {
-  const lCycle = getCycle(pGraph, pFrom, pToDep.resolved);
+function addCircularityCheckToDependency(
+  pGraph,
+  pFrom,
+  pToDep,
+  { pDependencyName, pFindNodeByName }
+) {
   let lReturnValue = {
     ...pToDep,
-    circular: lCycle.length > 0,
+    circular: false,
   };
+  const lCycle = getCycle(pGraph, pFrom, pToDep[pDependencyName], {
+    pDependencyName,
+    pFindNodeByName,
+  });
 
-  if (lReturnValue.circular) {
+  if (lCycle.length > 0) {
     lReturnValue = {
       ...lReturnValue,
+      circular: true,
       cycle: lCycle,
     };
   }
@@ -18,19 +28,25 @@ function addCircularityCheckToDependency(pToDep, pGraph, pFrom) {
 }
 
 /**
- * Runs through all dependencies of all pModules, for each of them determines
+ * Runs through all dependencies of all pNodes, for each of them determines
  * whether it's (part of a) circular (relationship) and returns the
  * dependencies with that added.
- *
- * @param  {Object} pModules [description]
- * @return {Object}               the same dependencies, but for each
- *                                of them added whether or not it is
- *                                part of
  */
-module.exports = (pModules) =>
-  pModules.map((pModule) => ({
+module.exports = (
+  pNodes,
+  { pSourceAttribute, pDependencyName, pFindNodeByName }
+) =>
+  pNodes.map((pModule) => ({
     ...pModule,
     dependencies: pModule.dependencies.map((pToDep) =>
-      addCircularityCheckToDependency(pToDep, pModules, pModule.source)
+      addCircularityCheckToDependency(
+        pNodes,
+        pModule[pSourceAttribute],
+        pToDep,
+        {
+          pDependencyName,
+          pFindNodeByName,
+        }
+      )
     ),
   }));

package/src/enrich/derive/folders/aggregate-to-folders.js

@@ -1,7 +1,9 @@
 /* eslint-disable security/detect-object-injection */
 const path = require("path").posix;
 const { calculateInstability, metricsAreCalculable } = require("../module-utl");
+const detectCycles = require("../circular");
 const {
+  findFolderByName,
   getAfferentCouplings,
   getEfferentCouplings,
   getParentFolders,
@@ -80,10 +82,6 @@ function calculateFolderMetrics(pFolder) {
   };
 }
 
-function findFolderByName(pAllFolders, pName) {
-  return pAllFolders.find((pFolder) => pFolder.name === pName);
-}
-
 function denormalizeInstability(pFolder, _, pAllFolders) {
   return {
     ...pFolder,
@@ -96,11 +94,35 @@ function denormalizeInstability(pFolder, _, pAllFolders) {
     }),
   };
 }
+function uniq(pArray) {
+  return [...new Set(pArray)];
+}
+function getSinks(pFolders) {
+  const lKnownFolders = new Set(pFolders.map(({ name }) => name));
+  const lAllFolders = uniq(
+    pFolders.flatMap(({ dependencies }) => dependencies.map(({ name }) => name))
+  );
+  const lReturnValue = lAllFolders
+    .filter((pFolder) => !lKnownFolders.has(pFolder))
+    .map((pFolder) => ({
+      name: pFolder,
+      moduleCount: -1,
+      dependencies: [],
+      dependents: [],
+    }));
+  return lReturnValue;
+}
 
 module.exports = function aggregateToFolders(pModules) {
   const lFolders = object2Array(
     pModules.filter(metricsAreCalculable).reduce(aggregateToFolder, {})
-  ).map(calculateFolderMetrics);
+  )
+    .map(calculateFolderMetrics)
+    .map(denormalizeInstability);
 
-  return lFolders.map(denormalizeInstability);
+  return detectCycles(lFolders.concat(getSinks(lFolders)), {
+    pSourceAttribute: "name",
+    pDependencyName: "name",
+    pFindNodeByName: findFolderByName,
+  });
 };

package/src/enrich/derive/folders/utl.js

@@ -1,6 +1,10 @@
 /* eslint-disable security/detect-object-injection */
 const path = require("path").posix;
 
+function findFolderByName(pAllFolders, pName) {
+  return pAllFolders.find((pFolder) => pFolder.name === pName);
+}
+
 function getAfferentCouplings(pModule, pDirname) {
   return pModule.dependents.filter(
     (pDependent) => !pDependent.startsWith(pDirname.concat(path.sep))
@@ -37,6 +41,7 @@ function object2Array(pObject) {
 }
 
 module.exports = {
+  findFolderByName,
   getAfferentCouplings,
   getEfferentCouplings,
   getParentFolders,

package/src/enrich/enrich-modules.js

@@ -2,17 +2,22 @@ const _get = require("lodash/get");
 const bus = require("../utl/bus");
 const busLogLevels = require("../utl/bus-log-levels");
 const addFocus = require("../../src/graph-utl/add-focus");
-const deriveCirculars = require("./derive/circular");
+const deriveCycles = require("./derive/circular");
 const deriveOrphans = require("./derive/orphan");
 const addDependents = require("./derive/dependents");
 const deriveReachable = require("./derive/reachable");
 const addValidations = require("./add-validations");
 const softenKnownViolations = require("./soften-known-violations");
 const deriveModuleMetrics = require("./derive/metrics");
+const { findModuleByName } = require("./derive/module-utl");
 
 module.exports = function enrichModules(pModules, pOptions) {
   bus.emit("progress", "analyzing: cycles", { level: busLogLevels.INFO });
-  let lModules = deriveCirculars(pModules);
+  let lModules = deriveCycles(pModules, {
+    pSourceAttribute: "source",
+    pDependencyName: "resolved",
+    pFindNodeByName: findModuleByName,
+  });
   bus.emit("progress", "analyzing: dependents", { level: busLogLevels.INFO });
   lModules = addDependents(lModules, pOptions);
   bus.emit("progress", "analyzing: orphans", { level: busLogLevels.INFO });

package/src/enrich/summarize/index.js

@@ -1,3 +1,4 @@
+const compare = require("../../graph-utl/compare");
 const addRuleSetUsed = require("./add-rule-set-used");
 const summarizeModules = require("./summarize-modules");
 const summarizeFolders = require("./summarize-folders");
@@ -28,9 +29,9 @@ module.exports = function summarize(
   pFileDirectoryArray,
   pFolders
 ) {
-  const lViolations = summarizeModules(pModules, pOptions.ruleSet).concat(
-    summarizeFolders(pFolders || [], pOptions.ruleSet)
-  );
+  const lViolations = summarizeModules(pModules, pOptions.ruleSet)
+    .concat(summarizeFolders(pFolders || [], pOptions.ruleSet))
+    .sort(compare.violations);
 
   return {
     violations: lViolations,

package/src/enrich/summarize/summarize-folders.js

@@ -1,10 +1,14 @@
-const _has = require("lodash/has");
+const has = require("lodash/has");
 const { findRuleByName } = require("../../graph-utl/rule-set");
 
 function classifyViolation(pRule, pRuleSet) {
-  if (_has(findRuleByName(pRuleSet, pRule.name), "to.moreUnstable")) {
+  const lRule = findRuleByName(pRuleSet, pRule.name);
+  if (has(lRule, "to.moreUnstable")) {
     return "instability";
   }
+  if (has(lRule, "to.circular")) {
+    return "cycle";
+  }
   return "folder";
 }
 
@@ -28,6 +32,11 @@ function getViolations(pFolder, pRuleSet) {
                 },
               }
             : {}),
+          ...(lViolationType === "cycle"
+            ? {
+                cycle: pDependency.cycle,
+              }
+            : {}),
         };
       })
     );

package/src/extract/ast-extractors/swc-dependency-visitor.js

@@ -13,7 +13,11 @@ function pryStringsFromArguments(pArguments) {
     lReturnValue = pArguments[0].expression.value;
   } else if (pArguments[0].expression.type === "TemplateLiteral") {
     /* c8 ignore start */
-    lReturnValue = pArguments[0].expression.quasis[0].cooked.value;
+    // @swc/core@1.2.159 and before: cooked.value.
+    // @swc/core@1.2.160 and after: just cooked
+    lReturnValue =
+      pArguments[0].expression.quasis[0].cooked.value ||
+      pArguments[0].expression.quasis[0].cooked;
   }
   /* c8 ignore stop */
 

package/src/main/options/normalize.js

@@ -1,6 +1,7 @@
 /* eslint-disable security/detect-object-injection */
-const _clone = require("lodash/clone");
-const _has = require("lodash/has");
+const get = require("lodash/get");
+const clone = require("lodash/clone");
+const has = require("lodash/has");
 const normalizeREProperties = require("../utl/normalize-re-properties");
 const defaults = require("./defaults.js");
 
@@ -67,7 +68,12 @@ function normalizeCollapse(pCollapse) {
 }
 
 function hasMetricsRule(pRule) {
-  return _has(pRule, "to.moreUnstable");
+  // TODO: philosophy: is a rule with 'folder' in it a metrics rule?
+  //       Or is it a misuse to ensure folder derivations (like cycles) get
+  //       kicked off?
+  return (
+    has(pRule, "to.moreUnstable") || get(pRule, "scope", "module") === "folder"
+  );
 }
 
 function ruleSetHasMetricsRule(pRuleSet) {
@@ -107,7 +113,7 @@ function normalizeCruiseOptions(pOptions) {
 
   lReturnValue.maxDepth = Number.parseInt(lReturnValue.maxDepth, 10);
   lReturnValue.moduleSystems = uniq(lReturnValue.moduleSystems.sort());
-  if (_has(lReturnValue, "collapse")) {
+  if (has(lReturnValue, "collapse")) {
     lReturnValue.collapse = normalizeCollapse(lReturnValue.collapse);
   }
   // TODO: further down the execution path code still relies on .doNotFollow
@@ -133,9 +139,9 @@ function normalizeCruiseOptions(pOptions) {
 }
 
 function normalizeFormatOptions(pFormatOptions) {
-  const lFormatOptions = _clone(pFormatOptions);
+  const lFormatOptions = clone(pFormatOptions);
 
-  if (_has(lFormatOptions, "collapse")) {
+  if (has(lFormatOptions, "collapse")) {
     lFormatOptions.collapse = normalizeCollapse(lFormatOptions.collapse);
   }
   return normalizeFilterOptions(lFormatOptions, [

package/src/meta.js

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

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"],"additionalProperties":false,"properties":{"name":{"type":"string"},"instability":{"type":"number"},"valid":{"type":"boolean"},"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"},"viaNot":{"$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"},"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"},"viaNot":{"$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"}}}}}

package/src/validate/match-folder-dependency-rule.js

@@ -5,9 +5,8 @@ function match(pFromFolder, pToFolder) {
   return (pRule) =>
     // TODO: add path rules - they need to be frippled from the ones
     // already in place for modules
-    // TODO: same for cycles - but these will additionally have to be
-    // yognated with an adapted cycle detection for folders
-    matchers.toIsMoreUnstable(pRule, pFromFolder, pToFolder);
+    matchers.toIsMoreUnstable(pRule, pFromFolder, pToFolder) &&
+    matchers.propertyEquals(pRule, pToFolder, "circular");
 }
 
 const isInteresting = (pRule) =>

package/types/cruise-result.d.ts

@@ -383,7 +383,38 @@ export interface IFolder {
   /**
    * List of folders this folder depends upon
    */
-  dependencies?: { name: string; instability: number }[];
+  dependencies?: {
+    /**
+     * the (resolved) name of the dependency
+     */
+    name: string;
+    /**
+     * 'true' if this folder dependency violated a rule; 'false' in all other
+     * cases. The violated rule will be in the 'rules' object at the same level.
+     */
+    valid: boolean;
+    /**
+     * the instability of the dependency (denormalized - this is a duplicate of
+     * the one found in the instability of the folder with the same name)
+     */
+    instability?: number;
+    /**
+     * 'true' if following this dependency will ultimately return to the source, false in all
+     * other cases
+     */
+    circular: boolean;
+    /**
+     * If following this dependency will ultimately return to the source (circular === true),
+     * this attribute will contain an (ordered) array of module names that shows (one of) the
+     * circular path(s)
+     */
+    cycle?: string[];
+    /**
+     * an array of rules violated by this dependency - left out if the dependency
+     * is valid
+     */
+    rules?: IRuleSummary[];
+  }[];
   /**
    * The total number of modules detected in this folder and its sub-folders
    */