dependency-cruiser 10.8.0-beta-1 → 10.9.0

package/README.md

@@ -21,7 +21,7 @@ you can stick on the wall to impress your grandma.
 ### Install it
 
 - `npm install --save-dev dependency-cruiser` to use it as a validator in your project (recommended) or...
-- `npm install --global dependency-cruiser` if you just want to to inspect multiple projects.
+- `npm install --global dependency-cruiser` if you just want to inspect multiple projects.
 
 ### Show stuff to your grandma
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.8.0-beta-1",
+  "version": "10.9.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -76,7 +76,6 @@
     "depcruise:all": "node ./bin/dependency-cruise.js src bin test configs types tools --config",
     "depcruise:baseline": "node ./bin/depcruise-baseline.js src bin test configs types tools",
     "depcruise:explain": "node ./bin/dependency-cruise.js src bin test configs types tools --output-type err-long --config --progress none",
-    "depcruise:graph:dev": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config --output-type dot --progress cli-feedback | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
     "depcruise:graph:doc": "npm-run-all depcruise:graph:doc:json --parallel depcruise:graph:doc:fmt-* depcruise:graph:doc:samples",
     "depcruise:graph:doc:json": "node ./bin/dependency-cruise.js bin src test --config --output-type json --output-to tmp_graph_deps.json --progress",
     "depcruise:graph:doc:fmt-detail": "./bin/depcruise-fmt.js -T dot -f - tmp_graph_deps.json | dot -T svg | tee doc/real-world-samples/dependency-cruiser-without-node_modules.svg | node bin/wrap-stream-in-html.js > docs/dependency-cruiser-dependency-graph.html",
@@ -88,7 +87,9 @@
     "depcruise:graph:dot": "node ./bin/dependency-cruise.js bin src --config --output-type dot | dot -T svg > tmp_deps.svg",
     "depcruise:graph:fdp": "node ./bin/dependency-cruise.js bin src --config --output-type dot | fdp -GK=0.1 -Gsplines=true -T svg > tmp_deps.svg",
     "depcruise:graph:osage": "node ./bin/dependency-cruise.js bin src --config --output-type dot | osage -Gpack=32 -GpackMode=array2 -T svg > tmp_deps.svg",
-    "depcruise:report": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config --output-to dependency-violations.html",
+    "depcruise:graph:view": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.json --output-type dot --progress cli-feedback | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
+    "depcruise:report": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to dependency-violations.html",
+    "depcruise:report:view": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to - | browser",
     "depcruise:focus": "node ./bin/dependency-cruise.js src bin test configs types --progress --config --output-type text --focus",
     "lint": "npm-run-all --parallel --aggregate-output lint:eslint lint:prettier:check lint:types",
     "lint:eslint": "eslint bin/dependency-cruise.js src test configs tools/**/*.mjs --cache --cache-location .cache/eslint/",
@@ -131,13 +132,13 @@
     "version": "npm-run-all build depcruise:graph:doc scm:stage"
   },
   "dependencies": {
-    "acorn": "8.5.0",
+    "acorn": "8.6.0",
     "acorn-jsx": "5.3.2",
     "acorn-jsx-walk": "2.0.0",
     "acorn-loose": "8.2.1",
     "acorn-walk": "8.2.0",
-    "ajv": "8.6.3",
-    "chalk": "4.1.2",
+    "ajv": "8.8.2",
+    "chalk": "^4.1.2",
     "commander": "8.3.0",
     "enhanced-resolve": "5.8.3",
     "figures": "^3.2.0",
@@ -151,18 +152,18 @@
     "safe-regex": "2.1.1",
     "semver": "^7.3.5",
     "semver-try-require": "^5.0.1",
-    "teamcity-service-messages": "0.1.11",
-    "tsconfig-paths-webpack-plugin": "3.5.1",
+    "teamcity-service-messages": "0.1.12",
+    "tsconfig-paths-webpack-plugin": "3.5.2",
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.15.8",
-    "@babel/plugin-transform-modules-commonjs": "7.15.4",
-    "@babel/preset-typescript": "7.15.0",
-    "@swc/core": "1.2.105",
-    "@typescript-eslint/eslint-plugin": "5.2.0",
-    "@typescript-eslint/parser": "5.2.0",
-    "@vue/compiler-sfc": "3.2.20",
+    "@babel/core": "7.16.5",
+    "@babel/plugin-transform-modules-commonjs": "7.16.5",
+    "@babel/preset-typescript": "7.16.5",
+    "@swc/core": "1.2.120",
+    "@typescript-eslint/eslint-plugin": "5.7.0",
+    "@typescript-eslint/parser": "5.7.0",
+    "@vue/compiler-sfc": "3.2.26",
     "c8": "7.10.0",
     "chai": "4.3.4",
     "chai-json-schema": "1.5.1",
@@ -171,23 +172,23 @@
     "eslint-config-moving-meadow": "2.0.9",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-budapestian": "3.0.1",
-    "eslint-plugin-import": "2.25.2",
-    "eslint-plugin-mocha": "9.0.0",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.4.0",
-    "eslint-plugin-unicorn": "37.0.1",
+    "eslint-plugin-unicorn": "39.0.0",
     "husky": "^4.3.8",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "11.2.6",
+    "lint-staged": "12.1.2",
     "mocha": "9.1.3",
     "normalize-newline": "^3.0.0",
     "npm-run-all": "4.1.5",
-    "prettier": "2.4.1",
+    "prettier": "2.5.1",
     "proxyquire": "2.1.3",
     "shx": "0.3.3",
-    "svelte": "3.44.0",
+    "svelte": "3.44.3",
     "symlink-dir": "5.0.1",
-    "typescript": "4.4.4",
+    "typescript": "4.5.4",
     "upem": "^7.0.0",
     "vue-template-compiler": "2.6.14",
     "yarn": "1.22.17"
@@ -199,6 +200,11 @@
         "policy": "wanted",
         "because": "some eslint plugins (eslint-plugin-budapestian) are not compatible with eslint 8 yet "
       },
+      {
+        "package": "chalk",
+        "policy": "wanted",
+        "because": "version 5 only exports ejs - and we use cjs and don't transpile"
+      },
       {
         "package": "figures",
         "policy": "wanted",
@@ -214,6 +220,11 @@
         "policy": "wanted",
         "because": "version 5 only exports ejs - and we use cjs and don't transpile"
       },
+      {
+        "package": "eslint-plugin-mocha",
+        "policy": "wanted",
+        "because": "version 10 dropped support for node 12, which we still do support"
+      },
       {
         "package": "normalize-newline",
         "policy": "wanted",

package/src/enrich/derive/metrics/folder.js

@@ -0,0 +1,8 @@
+const getStabilityMetrics = require("./get-stability-metrics");
+
+module.exports = function deriveMetrics(pModules, pOptions) {
+  if (pOptions.metrics) {
+    return { folders: getStabilityMetrics(pModules) };
+  }
+  return {};
+};

package/src/enrich/derive/{folders → metrics}/get-stability-metrics.js

@@ -1,6 +1,6 @@
 /* eslint-disable security/detect-object-injection */
 const path = require("path").posix;
-const { foldersObject2folderArray, getParentFolders } = require("./utl");
+const { object2Array, getParentFolders } = require("./utl");
 const {
   getAfferentCouplings,
   getEfferentCouplings,
@@ -63,8 +63,8 @@ function getFolderLevelCouplings(pCouplingArray) {
 }
 
 function calculateFolderMetrics(pFolder) {
-  const lModuleDependents = foldersObject2folderArray(pFolder.dependents);
-  const lModuleDependencies = foldersObject2folderArray(pFolder.dependencies);
+  const lModuleDependents = object2Array(pFolder.dependents);
+  const lModuleDependencies = object2Array(pFolder.dependencies);
   const lAfferentCouplings = lModuleDependents.reduce(sumCounts, 0);
   const lEfferentCouplings = lModuleDependencies.reduce(sumCounts, 0);
 
@@ -83,7 +83,7 @@ function calculateFolderMetrics(pFolder) {
 }
 
 module.exports = function getStabilityMetrics(pModules) {
-  return foldersObject2folderArray(
+  return object2Array(
     pModules.filter(metricsAreCalculable).reduce((pAllFolders, pModule) => {
       getParentFolders(path.dirname(pModule.source)).forEach(
         (pParentDirectory) =>

package/src/enrich/derive/metrics/module.js

@@ -0,0 +1,28 @@
+const { findModuleByName, clearCache } = require("../utl");
+const { metricsAreCalculable } = require("./module-utl");
+
+module.exports = function deriveModuleMetrics(pModules, pOptions) {
+  if (pOptions.metrics) {
+    const lModules = pModules.map((pModule) => ({
+      ...pModule,
+      ...(metricsAreCalculable(pModule)
+        ? {
+            instability:
+              pModule.dependencies.length /
+                (pModule.dependents.length + pModule.dependencies.length) || 0,
+          }
+        : {}),
+    }));
+    clearCache();
+    return lModules.map((pModule) => ({
+      ...pModule,
+      dependencies: pModule.dependencies.map((pDependency) => ({
+        ...pDependency,
+        instability:
+          (findModuleByName(lModules, pDependency.resolved) || {})
+            .instability || 0,
+      })),
+    }));
+  }
+  return pModules;
+};

package/src/enrich/derive/{folders → metrics}/utl.js

@@ -10,7 +10,7 @@ function getParentFolders(pPath) {
   return lReturnValue.reverse();
 }
 
-function foldersObject2folderArray(pObject) {
+function object2Array(pObject) {
   return Object.keys(pObject).map((pKey) => ({
     name: pKey,
     ...pObject[pKey],
@@ -19,5 +19,5 @@ function foldersObject2folderArray(pObject) {
 
 module.exports = {
   getParentFolders,
-  foldersObject2folderArray,
+  object2Array,
 };

package/src/enrich/derive/utl.js

@@ -1,14 +1,26 @@
-const _memoize = require("lodash/memoize");
+let gIndexedGraph = null;
 
-function bareFindModuleByName(pGraph, pSource) {
-  return pGraph.find((pNode) => pNode.source === pSource);
+/**
+ * Returns the module with attribute pSource, when it exists in the pModuleGraph.
+ * Returns undefined when it doesn't.
+ *
+ * This function uses an indexed cache for efficiency reasons. If you need to
+ * call this function consecutively for different module graphs, you can clear
+ * this cache with the clearCache function from this module.
+ *
+ * @param {import('../../../types/cruise-result').IModule[]} pModuleGraph
+ * @param {string} pSource
+ * @returns {import('../../../types/cruise-result').IModule | undefined}
+ */
+function findModuleByName(pModuleGraph, pSource) {
+  if (!gIndexedGraph) {
+    gIndexedGraph = new Map(
+      pModuleGraph.map((pModule) => [pModule.source, pModule])
+    );
+  }
+  return gIndexedGraph.get(pSource);
 }
 
-const findModuleByName = _memoize(
-  bareFindModuleByName,
-  (_pGraph, pSource) => pSource
-);
-
 function isDependent(pResolvedName) {
   return (pModule) =>
     pModule.dependencies.some(
@@ -17,7 +29,11 @@ function isDependent(pResolvedName) {
 }
 
 function clearCache() {
-  findModuleByName.cache.clear();
+  gIndexedGraph = null;
 }
 
-module.exports = { findModuleByName, clearCache, isDependent };
+module.exports = {
+  findModuleByName,
+  clearCache,
+  isDependent,
+};

package/src/enrich/enrich-modules.js

@@ -8,6 +8,7 @@ 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/module");
 
 module.exports = function enrichModules(pModules, pOptions) {
   bus.emit("progress", "analyzing: cycles", { level: busLogLevels.INFO });
@@ -18,6 +19,10 @@ module.exports = function enrichModules(pModules, pOptions) {
   lModules = deriveOrphans(lModules);
   bus.emit("progress", "analyzing: reachables", { level: busLogLevels.INFO });
   lModules = deriveReachable(lModules, pOptions.ruleSet);
+  bus.emit("progress", "analyzing: module metrics", {
+    level: busLogLevels.INFO,
+  });
+  lModules = deriveModuleMetrics(lModules, pOptions);
   bus.emit("progress", "analyzing: add focus (if any)", {
     level: busLogLevels.INFO,
   });

package/src/enrich/index.js

@@ -1,5 +1,5 @@
 const enrichModules = require("./enrich-modules");
-const deriveFolders = require("./derive/folders");
+const deriveFolderMetrics = require("./derive/metrics/folder.js");
 const summarize = require("./summarize");
 const clearCaches = require("./clear-caches");
 
@@ -10,7 +10,7 @@ module.exports = function enrich(pModules, pOptions, pFileAndDirectoryArray) {
   clearCaches();
   return {
     modules: lModules,
-    ...deriveFolders(lModules, pOptions),
+    ...deriveFolderMetrics(lModules, pOptions),
     summary: summarize(lModules, pOptions, pFileAndDirectoryArray),
   };
 };

package/src/enrich/soften-known-violations.js

@@ -78,7 +78,8 @@ function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
           pRule,
           pModule.source,
           pKnownViolations.filter(
-            (pKnownError) => pKnownError.from === pKnownError.to
+            (pKnownError) =>
+              pKnownError.from === pKnownError.to && !pKnownError.cycle
           ),
           pSoftenedSeverity
         )
@@ -93,7 +94,8 @@ function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
         pDependency,
         pModule.source,
         pKnownViolations.filter(
-          (pKnownError) => pKnownError.from !== pKnownError.to
+          (pKnownError) =>
+            pKnownError.from !== pKnownError.to || pKnownError.cycle
         ),
         pSoftenedSeverity
       )

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

@@ -119,7 +119,13 @@ if (VisitorModule) {
     // also include the same method, but with the correct spelling.
     visitExportAllDeclration(pNode) {
       this.pushImportExportSource(pNode);
-      return super.visitExportAllDeclration(pNode);
+      /* c8 ignore start */
+      if (super.visitExportAllDeclration) {
+        return super.visitExportAllDeclration(pNode);
+      } else {
+        /* c8 ignore stop */
+        return super.visitExportAllDeclaration(pNode);
+      }
     }
 
     /* c8 ignore start */
@@ -131,7 +137,13 @@ if (VisitorModule) {
     // same spelling error as the above - same solution
     visitExportNamedDeclration(pNode) {
       this.pushImportExportSource(pNode);
-      return super.visitExportNamedDeclration(pNode);
+      /* c8 ignore start */
+      if (super.visitExportNamedDeclration) {
+        return super.visitExportNamedDeclration(pNode);
+      } else {
+        /* c8 ignore stop */
+        return super.visitExportNamedDeclaration(pNode);
+      }
     }
     /* c8 ignore start */
     visitExportNamedDeclaration(pNode) {

package/src/main/options/normalize.js

@@ -66,6 +66,32 @@ function normalizeCollapse(pCollapse) {
   return lReturnValue;
 }
 
+function hasMetricsRule(pRule) {
+  return _has(pRule, "to.moreUnstable");
+}
+
+function ruleSetHasMetricsRule(pRuleSet) {
+  const lRuleSet = pRuleSet || {};
+  return (
+    (lRuleSet.forbidden || []).some(hasMetricsRule) ||
+    (lRuleSet.allowed || []).some(hasMetricsRule)
+  );
+}
+
+/**
+ * Determines whether (instability) metrics should be calculated
+ *
+ * @param {import('../../../types/options').ICruiseOptions pOptions
+ * @returns Boolean
+ */
+function shouldCalculateMetrics(pOptions) {
+  return (
+    pOptions.metrics ||
+    pOptions.outputType === "metrics" ||
+    ruleSetHasMetricsRule(pOptions.ruleSet)
+  );
+}
+
 /**
  *
  * @param {Partial <import('../../../types/options').ICruiseOptions>} pOptions
@@ -101,6 +127,8 @@ function normalizeCruiseOptions(pOptions) {
       lReturnValue.reporterOptions
     );
   }
+  lReturnValue.metrics = shouldCalculateMetrics(pOptions);
+
   return lReturnValue;
 }
 

package/src/main/report-wrap.js

@@ -28,13 +28,18 @@ function reSummarizeResults(pResult, pFormatOptions) {
 
 module.exports = function reportWrap(pResult, pFormatOptions) {
   const lReportFunction = report.getReporter(pFormatOptions.outputType);
+  const lReportOptions = _get(
+    pResult,
+    `summary.optionsUsed.reporterOptions.${pFormatOptions.outputType}`,
+    {}
+  );
 
   return lReportFunction(
     reSummarizeResults(pResult, pFormatOptions),
     // passing format options here so reporters that read collapse patterns
     // from the result take the one passed in the format options instead
     _has(pFormatOptions, "collapse")
-      ? { collapsePattern: pFormatOptions.collapse }
-      : {}
+      ? { ...lReportOptions, collapsePattern: pFormatOptions.collapse }
+      : lReportOptions
   );
 };

package/src/meta.js

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

package/src/report/dot/dot.template.js

@@ -1 +1 @@
-var Handlebars=require("handlebars/runtime"),template=Handlebars.template,templates=Handlebars.templates=Handlebars.templates||{};templates["dot.template.hbs"]=template({1:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return null!=(a="function"==typeof(a=null!=(a=a(e,"graphAttrs")||(null!=n?a(n,"graphAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"graphAttrs",hash:{},data:o,loc:{start:{line:2,column:22},end:{line:2,column:38}}}):a)?a:""},3:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"node ["+(null!=(a="function"==typeof(a=null!=(a=a(e,"nodeAttrs")||(null!=n?a(n,"nodeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"nodeAttrs",hash:{},data:o,loc:{start:{line:3,column:27},end:{line:3,column:42}}}):a)?a:"")+"]"},5:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"edge ["+(null!=(a="function"==typeof(a=null!=(a=a(e,"edgeAttrs")||(null!=n?a(n,"edgeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"edgeAttrs",hash:{},data:o,loc:{start:{line:4,column:27},end:{line:4,column:42}}}):a)?a:"")+"]"},7:function(l,n,e,t,o,a,r){var u=null!=n?n:l.nullContext||{},c=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]},i=null!=(p=c(e,"if").call(u,null!=n?c(n,"folder"):n,{name:"if",hash:{},fn:l.program(8,o,0,a,r),inverse:l.program(20,o,0,a,r),data:o,loc:{start:{line:7,column:4},end:{line:12,column:11}}}))?p:"",s=null!=(s=c(e,"dependencies")||(null!=n?c(n,"dependencies"):n))?s:l.hooks.helperMissing,o={name:"dependencies",hash:{},fn:l.program(22,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:13,column:4},end:{line:15,column:21}}},p="function"==typeof s?s.call(u,o):s;return null!=(p=!c(e,"dependencies")?l.hooks.blockHelperMissing.call(n,p,o):p)&&(i+=p),i},8:function(l,n,e,t,o,a,r){var u,c,i=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"    "+(null!=(u=m(e,"each").call(i,null!=n?m(n,"path"):n,{name:"each",hash:{},fn:l.program(9,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:8,column:4},end:{line:8,column:201}}}))?u:"")+'"'+(null!=(u=typeof(c=null!=(c=m(e,"source")||(null!=n?m(n,"source"):n))?c:s)==p?c.call(i,{name:"source",hash:{},data:o,loc:{start:{line:9,column:9},end:{line:9,column:21}}}):c)?u:"")+'" [label='+(null!=(u=typeof(c=null!=(c=m(e,"label")||(null!=n?m(n,"label"):n))?c:s)==p?c.call(i,{name:"label",hash:{},data:o,loc:{start:{line:9,column:30},end:{line:9,column:41}}}):c)?u:"")+" "+(null!=(u=m(e,"if").call(i,null!=n?m(n,"rule"):n,{name:"if",hash:{},fn:l.program(12,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:42},end:{line:9,column:87}}}))?u:"")+(null!=(u=m(e,"if").call(i,null!=n?m(n,"URL"):n,{name:"if",hash:{},fn:l.program(14,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:87},end:{line:9,column:121}}}))?u:"")+(null!=(u=m(e,"if").call(i,null!=n?m(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(16,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:121},end:{line:9,column:162}}}))?u:"")+"]"+(null!=(u=m(e,"each").call(i,null!=n?m(n,"path"):n,{name:"each",hash:{},fn:l.program(18,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:163},end:{line:9,column:188}}}))?u:"")+"\n"},9:function(l,n,e,t,o,a,r){var u,c,i=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'subgraph "cluster_'+(null!=(u=typeof(c=null!=(c=m(e,"aggregateSnippet")||(null!=n?m(n,"aggregateSnippet"):n))?c:s)==p?c.call(i,{name:"aggregateSnippet",hash:{},data:o,loc:{start:{line:8,column:36},end:{line:8,column:58}}}):c)?u:"")+'" {label="'+(null!=(u=typeof(c=null!=(c=m(e,"snippet")||(null!=n?m(n,"snippet"):n))?c:s)==p?c.call(i,{name:"snippet",hash:{},data:o,loc:{start:{line:8,column:68},end:{line:8,column:81}}}):c)?u:"")+'" '+(null!=(u=m(e,"if").call(i,null!=r[2]?m(r[2],"clustersHaveOwnNode"):r[2],{name:"if",hash:{},fn:l.program(10,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:8,column:83},end:{line:8,column:191}}}))?u:"")},10:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'"'+(null!=(a="function"==typeof(a=null!=(a=a(e,"aggregateSnippet")||(null!=n?a(n,"aggregateSnippet"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"aggregateSnippet",hash:{},data:o,loc:{start:{line:8,column:117},end:{line:8,column:139}}}):a)?a:"")+'" [width="0.05" shape="point" style="invis"] '},12:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'tooltip="'+(null!=(l=l.lambda(null!=(l=null!=n?a(n,"rule"):n)?a(l,"name"):l,n))?l:"")+'" '},14:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'URL="'+(null!=(a="function"==typeof(a=null!=(a=a(e,"URL")||(null!=n?a(n,"URL"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"URL",hash:{},data:o,loc:{start:{line:9,column:103},end:{line:9,column:112}}}):a)?a:"")+'" '},16:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return null!=(a="function"==typeof(a=null!=(a=a(e,"themeAttrs")||(null!=n?a(n,"themeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"themeAttrs",hash:{},data:o,loc:{start:{line:9,column:139},end:{line:9,column:155}}}):a)?a:""},18:function(l,n,e,t,o){return" }"},20:function(l,n,e,t,o,a,r){var u,c,i=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'    "'+(null!=(u=typeof(c=null!=(c=m(e,"source")||(null!=n?m(n,"source"):n))?c:s)==p?c.call(i,{name:"source",hash:{},data:o,loc:{start:{line:11,column:5},end:{line:11,column:17}}}):c)?u:"")+'" [label='+(null!=(u=typeof(c=null!=(c=m(e,"label")||(null!=n?m(n,"label"):n))?c:s)==p?c.call(i,{name:"label",hash:{},data:o,loc:{start:{line:11,column:26},end:{line:11,column:37}}}):c)?u:"")+" "+(null!=(u=m(e,"if").call(i,null!=n?m(n,"rule"):n,{name:"if",hash:{},fn:l.program(12,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:11,column:38},end:{line:11,column:83}}}))?u:"")+(null!=(u=m(e,"if").call(i,null!=n?m(n,"URL"):n,{name:"if",hash:{},fn:l.program(14,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:11,column:83},end:{line:11,column:117}}}))?u:"")+(null!=(u=m(e,"if").call(i,null!=n?m(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(16,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:11,column:117},end:{line:11,column:158}}}))?u:"")+"]\n"},22:function(l,n,e,t,o,a,r){var u,c,i=null!=n?n:l.nullContext||{},s=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'    "'+(null!=(u=l.lambda(null!=r[1]?s(r[1],"source"):r[1],n))?u:"")+'" -> "'+(null!=(u="function"==typeof(c=null!=(c=s(e,"resolved")||(null!=n?s(n,"resolved"):n))?c:l.hooks.helperMissing)?c.call(i,{name:"resolved",hash:{},data:o,loc:{start:{line:14,column:26},end:{line:14,column:40}}}):c)?u:"")+'"'+(null!=(u=s(e,"if").call(i,null!=n?s(n,"hasExtraAttributes"):n,{name:"if",hash:{},fn:l.program(23,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:41},end:{line:14,column:193}}}))?u:"")+"\n"},23:function(l,n,e,t,o,a,r){var u,c=null!=n?n:l.nullContext||{},i=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return" ["+(null!=(u=i(e,"if").call(c,null!=(u=null!=n?i(n,"rule"):n)?i(u,"name"):u,{name:"if",hash:{},fn:l.program(24,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:69},end:{line:14,column:144}}}))?u:"")+(null!=(u=i(e,"if").call(c,null!=n?i(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(16,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:144},end:{line:14,column:185}}}))?u:"")+"]"},24:function(l,n,e,t,o){var a=l.lambda,r=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'xlabel="'+(null!=(l=a(null!=(l=null!=n?r(n,"rule"):n)?r(l,"name"):l,n))?l:"")+'" tooltip="'+(null!=(l=a(null!=(l=null!=n?r(n,"rule"):n)?r(l,"name"):l,n))?l:"")+'" '},compiler:[8,">= 4.3.0"],main:function(l,n,e,t,o,a,r){var u=null!=n?n:l.nullContext||{},c=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]},i='strict digraph "dependency-cruiser output"{\n    '+(null!=(p=c(e,"if").call(u,null!=n?c(n,"graphAttrs"):n,{name:"if",hash:{},fn:l.program(1,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:2,column:4},end:{line:2,column:45}}}))?p:"")+"\n    "+(null!=(p=c(e,"if").call(u,null!=n?c(n,"nodeAttrs"):n,{name:"if",hash:{},fn:l.program(3,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:3,column:4},end:{line:3,column:50}}}))?p:"")+"\n    "+(null!=(p=c(e,"if").call(u,null!=n?c(n,"edgeAttrs"):n,{name:"if",hash:{},fn:l.program(5,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:4,column:4},end:{line:4,column:50}}}))?p:"")+"\n\n",s=null!=(s=c(e,"modules")||(null!=n?c(n,"modules"):n))?s:l.hooks.helperMissing,o={name:"modules",hash:{},fn:l.program(7,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:6,column:0},end:{line:16,column:12}}},p="function"==typeof s?s.call(u,o):s;return null!=(p=!c(e,"modules")?l.hooks.blockHelperMissing.call(n,p,o):p)&&(i+=p),i+"}\n"},useData:!0,useDepths:!0});
+var Handlebars=require("handlebars/runtime"),template=Handlebars.template,templates=Handlebars.templates=Handlebars.templates||{};templates["dot.template.hbs"]=template({1:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return null!=(a="function"==typeof(a=null!=(a=a(e,"graphAttrs")||(null!=n?a(n,"graphAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"graphAttrs",hash:{},data:o,loc:{start:{line:2,column:22},end:{line:2,column:38}}}):a)?a:""},3:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"node ["+(null!=(a="function"==typeof(a=null!=(a=a(e,"nodeAttrs")||(null!=n?a(n,"nodeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"nodeAttrs",hash:{},data:o,loc:{start:{line:3,column:27},end:{line:3,column:42}}}):a)?a:"")+"]"},5:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"edge ["+(null!=(a="function"==typeof(a=null!=(a=a(e,"edgeAttrs")||(null!=n?a(n,"edgeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"edgeAttrs",hash:{},data:o,loc:{start:{line:4,column:27},end:{line:4,column:42}}}):a)?a:"")+"]"},7:function(l,n,e,t,o,a,r){var u=null!=n?n:l.nullContext||{},i=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]},c=null!=(p=i(e,"if").call(u,null!=n?i(n,"folder"):n,{name:"if",hash:{},fn:l.program(8,o,0,a,r),inverse:l.program(18,o,0,a,r),data:o,loc:{start:{line:7,column:4},end:{line:12,column:11}}}))?p:"",s=null!=(s=i(e,"dependencies")||(null!=n?i(n,"dependencies"):n))?s:l.hooks.helperMissing,o={name:"dependencies",hash:{},fn:l.program(20,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:13,column:4},end:{line:15,column:21}}},p="function"==typeof s?s.call(u,o):s;return null!=(p=!i(e,"dependencies")?l.hooks.blockHelperMissing.call(n,p,o):p)&&(c+=p),c},8:function(l,n,e,t,o,a,r){var u,i,c=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return"    "+(null!=(u=m(e,"each").call(c,null!=n?m(n,"path"):n,{name:"each",hash:{},fn:l.program(9,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:8,column:4},end:{line:8,column:201}}}))?u:"")+'"'+(null!=(u=typeof(i=null!=(i=m(e,"source")||(null!=n?m(n,"source"):n))?i:s)==p?i.call(c,{name:"source",hash:{},data:o,loc:{start:{line:9,column:9},end:{line:9,column:21}}}):i)?u:"")+'" [label='+(null!=(u=typeof(i=null!=(i=m(e,"label")||(null!=n?m(n,"label"):n))?i:s)==p?i.call(c,{name:"label",hash:{},data:o,loc:{start:{line:9,column:30},end:{line:9,column:41}}}):i)?u:"")+' tooltip="'+(null!=(u=typeof(i=null!=(i=m(e,"tooltip")||(null!=n?m(n,"tooltip"):n))?i:s)==p?i.call(c,{name:"tooltip",hash:{},data:o,loc:{start:{line:9,column:51},end:{line:9,column:64}}}):i)?u:"")+'" '+(null!=(u=m(e,"if").call(c,null!=n?m(n,"URL"):n,{name:"if",hash:{},fn:l.program(12,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:66},end:{line:9,column:100}}}))?u:"")+(null!=(u=m(e,"if").call(c,null!=n?m(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(14,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:100},end:{line:9,column:141}}}))?u:"")+"]"+(null!=(u=m(e,"each").call(c,null!=n?m(n,"path"):n,{name:"each",hash:{},fn:l.program(16,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:9,column:142},end:{line:9,column:167}}}))?u:"")+"\n"},9:function(l,n,e,t,o,a,r){var u,i,c=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'subgraph "cluster_'+(null!=(u=typeof(i=null!=(i=m(e,"aggregateSnippet")||(null!=n?m(n,"aggregateSnippet"):n))?i:s)==p?i.call(c,{name:"aggregateSnippet",hash:{},data:o,loc:{start:{line:8,column:36},end:{line:8,column:58}}}):i)?u:"")+'" {label="'+(null!=(u=typeof(i=null!=(i=m(e,"snippet")||(null!=n?m(n,"snippet"):n))?i:s)==p?i.call(c,{name:"snippet",hash:{},data:o,loc:{start:{line:8,column:68},end:{line:8,column:81}}}):i)?u:"")+'" '+(null!=(u=m(e,"if").call(c,null!=r[2]?m(r[2],"clustersHaveOwnNode"):r[2],{name:"if",hash:{},fn:l.program(10,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:8,column:83},end:{line:8,column:191}}}))?u:"")},10:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'"'+(null!=(a="function"==typeof(a=null!=(a=a(e,"aggregateSnippet")||(null!=n?a(n,"aggregateSnippet"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"aggregateSnippet",hash:{},data:o,loc:{start:{line:8,column:117},end:{line:8,column:139}}}):a)?a:"")+'" [width="0.05" shape="point" style="invis"] '},12:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'URL="'+(null!=(a="function"==typeof(a=null!=(a=a(e,"URL")||(null!=n?a(n,"URL"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"URL",hash:{},data:o,loc:{start:{line:9,column:82},end:{line:9,column:91}}}):a)?a:"")+'" '},14:function(l,n,e,t,o){var a=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return null!=(a="function"==typeof(a=null!=(a=a(e,"themeAttrs")||(null!=n?a(n,"themeAttrs"):n))?a:l.hooks.helperMissing)?a.call(null!=n?n:l.nullContext||{},{name:"themeAttrs",hash:{},data:o,loc:{start:{line:9,column:118},end:{line:9,column:134}}}):a)?a:""},16:function(l,n,e,t,o){return" }"},18:function(l,n,e,t,o,a,r){var u,i,c=null!=n?n:l.nullContext||{},s=l.hooks.helperMissing,p="function",m=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'    "'+(null!=(u=typeof(i=null!=(i=m(e,"source")||(null!=n?m(n,"source"):n))?i:s)==p?i.call(c,{name:"source",hash:{},data:o,loc:{start:{line:11,column:5},end:{line:11,column:17}}}):i)?u:"")+'" [label='+(null!=(u=typeof(i=null!=(i=m(e,"label")||(null!=n?m(n,"label"):n))?i:s)==p?i.call(c,{name:"label",hash:{},data:o,loc:{start:{line:11,column:26},end:{line:11,column:37}}}):i)?u:"")+' tooltip="'+(null!=(u=typeof(i=null!=(i=m(e,"tooltip")||(null!=n?m(n,"tooltip"):n))?i:s)==p?i.call(c,{name:"tooltip",hash:{},data:o,loc:{start:{line:11,column:47},end:{line:11,column:60}}}):i)?u:"")+'" '+(null!=(u=m(e,"if").call(c,null!=n?m(n,"URL"):n,{name:"if",hash:{},fn:l.program(12,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:11,column:62},end:{line:11,column:96}}}))?u:"")+(null!=(u=m(e,"if").call(c,null!=n?m(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(14,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:11,column:96},end:{line:11,column:137}}}))?u:"")+"]\n"},20:function(l,n,e,t,o,a,r){var u,i,c=null!=n?n:l.nullContext||{},s=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'    "'+(null!=(u=l.lambda(null!=r[1]?s(r[1],"source"):r[1],n))?u:"")+'" -> "'+(null!=(u="function"==typeof(i=null!=(i=s(e,"resolved")||(null!=n?s(n,"resolved"):n))?i:l.hooks.helperMissing)?i.call(c,{name:"resolved",hash:{},data:o,loc:{start:{line:14,column:26},end:{line:14,column:40}}}):i)?u:"")+'"'+(null!=(u=s(e,"if").call(c,null!=n?s(n,"hasExtraAttributes"):n,{name:"if",hash:{},fn:l.program(21,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:41},end:{line:14,column:193}}}))?u:"")+"\n"},21:function(l,n,e,t,o,a,r){var u,i=null!=n?n:l.nullContext||{},c=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return" ["+(null!=(u=c(e,"if").call(i,null!=(u=null!=n?c(n,"rule"):n)?c(u,"name"):u,{name:"if",hash:{},fn:l.program(22,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:69},end:{line:14,column:144}}}))?u:"")+(null!=(u=c(e,"if").call(i,null!=n?c(n,"themeAttrs"):n,{name:"if",hash:{},fn:l.program(14,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:14,column:144},end:{line:14,column:185}}}))?u:"")+"]"},22:function(l,n,e,t,o){var a=l.lambda,r=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]};return'xlabel="'+(null!=(l=a(null!=(l=null!=n?r(n,"rule"):n)?r(l,"name"):l,n))?l:"")+'" tooltip="'+(null!=(l=a(null!=(l=null!=n?r(n,"rule"):n)?r(l,"name"):l,n))?l:"")+'" '},compiler:[8,">= 4.3.0"],main:function(l,n,e,t,o,a,r){var u=null!=n?n:l.nullContext||{},i=l.lookupProperty||function(l,n){if(Object.prototype.hasOwnProperty.call(l,n))return l[n]},c='strict digraph "dependency-cruiser output"{\n    '+(null!=(p=i(e,"if").call(u,null!=n?i(n,"graphAttrs"):n,{name:"if",hash:{},fn:l.program(1,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:2,column:4},end:{line:2,column:45}}}))?p:"")+"\n    "+(null!=(p=i(e,"if").call(u,null!=n?i(n,"nodeAttrs"):n,{name:"if",hash:{},fn:l.program(3,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:3,column:4},end:{line:3,column:50}}}))?p:"")+"\n    "+(null!=(p=i(e,"if").call(u,null!=n?i(n,"edgeAttrs"):n,{name:"if",hash:{},fn:l.program(5,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:4,column:4},end:{line:4,column:50}}}))?p:"")+"\n\n",s=null!=(s=i(e,"modules")||(null!=n?i(n,"modules"):n))?s:l.hooks.helperMissing,o={name:"modules",hash:{},fn:l.program(7,o,0,a,r),inverse:l.noop,data:o,loc:{start:{line:6,column:0},end:{line:16,column:12}}},p="function"==typeof s?s.call(u,o):s;return null!=(p=!i(e,"modules")?l.hooks.blockHelperMissing.call(n,p,o):p)&&(c+=p),c+"}\n"},useData:!0,useDepths:!0});

package/src/report/dot/index.js

@@ -17,7 +17,11 @@ const GRANULARITY2FUNCTION = {
   flat: prepareFlatLevel,
 };
 
-function report(pResults, pGranularity, { theme, collapsePattern, filters }) {
+function report(
+  pResults,
+  pGranularity,
+  { theme, collapsePattern, filters, showMetrics }
+) {
   const lTheme = theming.normalizeTheme(theme);
   const lResults = filters
     ? {
@@ -35,7 +39,8 @@ function report(pResults, pGranularity, { theme, collapsePattern, filters }) {
     modules: (GRANULARITY2FUNCTION[pGranularity] || prepareCustomLevel)(
       lResults,
       lTheme,
-      collapsePattern
+      collapsePattern,
+      showMetrics
     ),
   });
 }

package/src/report/dot/module-utl.js

@@ -1,6 +1,9 @@
 const path = require("path").posix;
+const _has = require("lodash/has");
 const theming = require("./theming");
 
+const PROTOCOL_PREFIX_RE = /^[a-z]+:\/\//;
+
 function attributizeObject(pObject) {
   return (
     Object.keys(pObject)
@@ -12,7 +15,9 @@ function attributizeObject(pObject) {
 
 function extractFirstTransgression(pModule) {
   return {
-    ...(pModule.rules ? { ...pModule, rule: pModule.rules[0] } : pModule),
+    ...(_has(pModule, "rules[0]")
+      ? { ...pModule, tooltip: pModule.rules[0].name }
+      : pModule),
     dependencies: pModule.dependencies.map((pDependency) =>
       pDependency.rules
         ? {
@@ -57,20 +62,37 @@ function aggregate(pPathSnippet, pCounter, pPathArray) {
   };
 }
 
-function folderify(pModule) {
-  let lAdditions = {};
-  let lDirectoryName = path.dirname(pModule.source);
+function makeInstabilityString(pModule, pShowMetrics = false) {
+  let lInstabilityString = "";
 
-  if (lDirectoryName !== ".") {
-    lAdditions.folder = lDirectoryName;
-    lAdditions.path = lDirectoryName.split(path.sep).map(aggregate);
+  if (pShowMetrics && _has(pModule, "instability") && !pModule.consolidated) {
+    lInstabilityString = ` <FONT color="#808080" point-size="8">${Math.round(
+      // eslint-disable-next-line no-magic-numbers
+      100 * pModule.instability
+    )}</FONT>`;
   }
+  return lInstabilityString;
+}
 
-  lAdditions.label = `"${path.basename(pModule.source)}"`;
+function folderify(pShowMetrics) {
+  return (pModule) => {
+    let lAdditions = {};
+    let lDirectoryName = path.dirname(pModule.source);
 
-  return {
-    ...pModule,
-    ...lAdditions,
+    if (lDirectoryName !== ".") {
+      lAdditions.folder = lDirectoryName;
+      lAdditions.path = lDirectoryName.split(path.sep).map(aggregate);
+    }
+
+    lAdditions.label = `<${path.basename(
+      pModule.source
+    )}${makeInstabilityString(pModule, pShowMetrics)}>`;
+    lAdditions.tooltip = path.basename(pModule.source);
+
+    return {
+      ...pModule,
+      ...lAdditions,
+    };
   };
 }
 
@@ -87,7 +109,7 @@ function folderify(pModule) {
  * @return {string} prefix and filename concatenated
  */
 function smartURIConcat(pPrefix, pSource) {
-  if (pPrefix.match(/^[a-z]+:\/\//)) {
+  if (pPrefix.match(PROTOCOL_PREFIX_RE)) {
     return `${pPrefix}${pSource}`;
   } else {
     return path.join(pPrefix, pSource);
@@ -103,15 +125,21 @@ function addURL(pPrefix) {
   });
 }
 
-function flatLabel(pModule) {
-  return {
-    ...pModule,
-    label: `<${path.dirname(pModule.source)}/<BR/><B>${path.basename(
-      pModule.source
-    )}</B>>`,
-  };
+function makeLabel(pModule, pShowMetrics) {
+  return `<${path.dirname(pModule.source)}/<BR/><B>${path.basename(
+    pModule.source
+  )}</B>${makeInstabilityString(pModule, pShowMetrics)}>`;
 }
 
+function flatLabel(pShowMetrics) {
+  return (pModule) => {
+    return {
+      ...pModule,
+      label: makeLabel(pModule, pShowMetrics),
+      tooltip: path.basename(pModule.source),
+    };
+  };
+}
 module.exports = {
   folderify,
   applyTheme,

package/src/report/dot/prepare-custom-level.js

@@ -4,15 +4,15 @@ const compare = require("../../graph-utl/compare");
 const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme, pCollapsePattern) => {
+module.exports = (pResults, pTheme, pCollapsePattern, pShowMetrics) => {
   return (
     pCollapsePattern
       ? consolidateToPattern(pResults.modules, pCollapsePattern)
       : pResults.modules
   )
     .sort(compare.modules)
+    .map(moduleUtl.folderify(pShowMetrics))
     .map(moduleUtl.extractFirstTransgression)
-    .map(moduleUtl.folderify)
     .map(stripSelfTransitions)
     .map(moduleUtl.applyTheme(pTheme))
     .map(moduleUtl.addURL(_get(pResults, "summary.optionsUsed.prefix", "")));

package/src/report/dot/prepare-flat-level.js

@@ -2,10 +2,10 @@ const _get = require("lodash/get");
 const compare = require("../../graph-utl/compare");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme) => {
+module.exports = (pResults, pTheme, _, pShowMetrics) => {
   return pResults.modules
     .sort(compare.modules)
-    .map(moduleUtl.flatLabel)
+    .map(moduleUtl.flatLabel(pShowMetrics))
     .map(moduleUtl.extractFirstTransgression)
     .map(moduleUtl.applyTheme(pTheme))
     .map(moduleUtl.addURL(_get(pResults, "summary.optionsUsed.prefix", "")));

package/src/report/dot/prepare-folder-level.js

@@ -4,11 +4,11 @@ const compare = require("../../graph-utl/compare");
 const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme) => {
+module.exports = (pResults, pTheme, _, pShowMetrics) => {
   return consolidateToFolder(pResults.modules)
     .sort(compare.modules)
     .map(moduleUtl.extractFirstTransgression)
-    .map(moduleUtl.folderify)
+    .map(moduleUtl.folderify(pShowMetrics))
     .map(stripSelfTransitions)
     .map(moduleUtl.applyTheme(pTheme))
     .map(moduleUtl.addURL(_get(pResults, "summary.optionsUsed.prefix", "")));

package/src/report/metrics.js

@@ -1,62 +1,110 @@
-const os = require("os");
+const { EOL } = require("os");
 const chalk = require("chalk");
 
 const DECIMAL_BASE = 10;
 const METRIC_WIDTH = 4;
 const INSTABILITY_DECIMALS = 2;
 const YADDUM = DECIMAL_BASE ** INSTABILITY_DECIMALS;
+const COMPONENT_HEADER = "name";
 
-function transformMetricsToTable(pMetrics) {
+function getHeader(pMaxNameWidth) {
+  return `${COMPONENT_HEADER.padEnd(pMaxNameWidth)} ${"N".padStart(
+    METRIC_WIDTH + 1
+  )} ${"Ca".padStart(METRIC_WIDTH + 1)} ${"Ce".padStart(
+    METRIC_WIDTH + 1
+  )}  ${"I".padEnd(METRIC_WIDTH + 1)}`;
+}
+
+function getDemarcationLine(pMaxNameWidth) {
+  return `${"-".repeat(pMaxNameWidth)} ${"-".repeat(
+    METRIC_WIDTH + 1
+  )} ${"-".repeat(METRIC_WIDTH + 1)} ${"-".repeat(
+    METRIC_WIDTH + 1
+  )}  ${"-".repeat(METRIC_WIDTH + 1)}`;
+}
+
+function getMetricsTable(pMetrics, pMaxNameWidth) {
+  return pMetrics.map(
+    ({
+      name,
+      moduleCount,
+      afferentCouplings,
+      efferentCouplings,
+      instability,
+    }) =>
+      `${name.padEnd(pMaxNameWidth, " ")}  ${moduleCount
+        .toString(DECIMAL_BASE)
+        .padStart(METRIC_WIDTH)}  ${afferentCouplings
+        .toString(DECIMAL_BASE)
+        .padStart(METRIC_WIDTH)}  ${efferentCouplings
+        .toString(DECIMAL_BASE)
+        .padStart(METRIC_WIDTH)}  ${(Math.round(YADDUM * instability) / YADDUM)
+        .toString(DECIMAL_BASE)
+        .padEnd(METRIC_WIDTH)}`
+  );
+}
+
+function metricifyModule({ source, dependents, dependencies, instability }) {
+  return {
+    name: source,
+    moduleCount: 1,
+    afferentCouplings: dependents.length,
+    efferentCouplings: dependencies.length,
+    instability,
+  };
+}
+
+function metricsAreCalculable(pModule) {
+  return Object.prototype.hasOwnProperty.call(pModule, "instability");
+}
+
+function orderByNumber(pAttributeName) {
+  // eslint-disable-next-line security/detect-object-injection
+  return (pLeft, pRight) => pRight[pAttributeName] - pLeft[pAttributeName];
+}
+
+function orderByString(pAttributeName) {
+  return (pLeft, pRight) =>
+    // eslint-disable-next-line security/detect-object-injection
+    pLeft[pAttributeName].localeCompare(pRight[pAttributeName]);
+}
+
+function transformMetricsToTable(
+  { modules, folders },
+  { orderBy, hideFolders, hideModules }
+) {
   // TODO: should probably use a table module for this (i.e. text-table)
-  // to simplify this code; but for this poc not having a dependency (so it's
-  // copy-n-pasteable from a gist) is more important
-  const lMaxNameWidth = pMetrics
-    .map((pMetric) => pMetric.name.length)
+  // to simplify this code
+  let lComponents = [];
+  lComponents = lComponents.concat(hideFolders ? [] : folders);
+  lComponents = lComponents.concat(
+    hideModules ? [] : modules.filter(metricsAreCalculable).map(metricifyModule)
+  );
+  const lMaxNameWidth = lComponents
+    .map(({ name }) => name.length)
+    .concat(COMPONENT_HEADER.length)
     .sort((pLeft, pRight) => pLeft - pRight)
     .pop();
 
-  return [
-    chalk.bold(
-      `${"folder".padEnd(lMaxNameWidth)} ${"N".padStart(
-        METRIC_WIDTH + 1
-      )} ${"Ca".padStart(METRIC_WIDTH + 1)} ${"Ce".padStart(
-        METRIC_WIDTH + 1
-      )}  ${"I".padEnd(METRIC_WIDTH + 1)}`
-    ),
-  ]
-    .concat(
-      `${"-".repeat(lMaxNameWidth)} ${"-".repeat(
-        METRIC_WIDTH + 1
-      )} ${"-".repeat(METRIC_WIDTH + 1)} ${"-".repeat(
-        METRIC_WIDTH + 1
-      )}  ${"-".repeat(METRIC_WIDTH + 1)}`
-    )
+  return [chalk.bold(getHeader(lMaxNameWidth))]
+    .concat(getDemarcationLine(lMaxNameWidth))
     .concat(
-      pMetrics.map((pMetric) => {
-        return `${pMetric.name.padEnd(
-          lMaxNameWidth,
-          " "
-        )}  ${pMetric.moduleCount
-          .toString(DECIMAL_BASE)
-          .padStart(METRIC_WIDTH)}  ${pMetric.afferentCouplings
-          .toString(DECIMAL_BASE)
-          .padStart(METRIC_WIDTH)}  ${pMetric.efferentCouplings
-          .toString(DECIMAL_BASE)
-          .padStart(METRIC_WIDTH)}  ${(
-          Math.round(YADDUM * pMetric.instability) / YADDUM
-        )
-          .toString(DECIMAL_BASE)
-          .padEnd(METRIC_WIDTH)}`;
-      })
+      getMetricsTable(
+        lComponents
+          .sort(orderByString("name"))
+          .sort(orderByNumber(orderBy || "instability")),
+        lMaxNameWidth
+      )
     )
-    .join(os.EOL)
-    .concat(os.EOL);
+    .join(EOL)
+    .concat(EOL);
 }
 
 /**
- * Metrics plugin - to test the waters. If we want to use metrics in other
- * reporters - or use e.g. the Ca/ Ce/ I in rules (e.g. to detect violations
- * of Uncle Bob's variable dependency principle)
+ * returns stability metrics of modules & folders in an ascii table
+ *
+ * Potential future features:
+ * - additional output formats (csv?, html?)
  *
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
@@ -65,17 +113,18 @@ function transformMetricsToTable(pMetrics) {
  *      output: some metrics on folders and dependencies
  *      exitCode: 0
  */
-module.exports = (pCruiseResult) => {
+module.exports = (pCruiseResult, pReporterOptions) => {
+  const lReporterOptions = pReporterOptions || {};
   if (pCruiseResult.folders) {
     return {
-      output: transformMetricsToTable(pCruiseResult.folders),
+      output: transformMetricsToTable(pCruiseResult, lReporterOptions),
       exitCode: 0,
     };
   } else {
     return {
       output:
-        `${os.EOL}ERROR: The cruise result didn't contain any metrics - re-running the cruise with${os.EOL}` +
-        `       the '--metrics' command line option should fix that.${os.EOL}${os.EOL}`,
+        `${EOL}ERROR: The cruise result didn't contain any metrics - re-running the cruise with${EOL}` +
+        `       the '--metrics' command line option should fix that.${EOL}${EOL}`,
       exitCode: 1,
     };
   }

package/src/schema/configuration.schema.js

@@ -168,6 +168,7 @@ module.exports = {
         licenseNot: { $ref: "#/definitions/REAsStringsType" },
         via: { $ref: "#/definitions/REAsStringsType" },
         viaNot: { $ref: "#/definitions/REAsStringsType" },
+        moreUnstable: { type: "boolean" },
       },
     },
     DependentsModuleRestrictionType: {
@@ -348,6 +349,7 @@ module.exports = {
             },
           },
         },
+        metrics: { type: "boolean" },
         baseDir: { type: "string" },
       },
     },
@@ -394,6 +396,7 @@ module.exports = {
         dot: { $ref: "#/definitions/DotReporterOptionsType" },
         ddot: { $ref: "#/definitions/DotReporterOptionsType" },
         flat: { $ref: "#/definitions/DotReporterOptionsType" },
+        metrics: { $ref: "#/definitions/MetricsReporterOptionsType" },
       },
     },
     AnonReporterOptionsType: {
@@ -401,12 +404,31 @@ module.exports = {
       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" },
       },
     },

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

@@ -47,6 +47,7 @@ module.exports = {
           items: { $ref: "#/definitions/RuleSummaryType" },
         },
         consolidated: { type: "boolean" },
+        instability: { type: "number" },
       },
     },
     ReachableType: {
@@ -126,6 +127,7 @@ module.exports = {
           type: "array",
           items: { $ref: "#/definitions/RuleSummaryType" },
         },
+        instability: { type: "number" },
       },
     },
     DependencyTypeType: {
@@ -356,6 +358,7 @@ module.exports = {
         licenseNot: { $ref: "#/definitions/REAsStringsType" },
         via: { $ref: "#/definitions/REAsStringsType" },
         viaNot: { $ref: "#/definitions/REAsStringsType" },
+        moreUnstable: { type: "boolean" },
       },
     },
     DependentsModuleRestrictionType: {
@@ -495,6 +498,7 @@ module.exports = {
             },
           },
         },
+        metrics: { type: "boolean" },
         baseDir: { type: "string" },
         args: { type: "string" },
         rulesFile: { type: "string" },
@@ -570,6 +574,7 @@ module.exports = {
         dot: { $ref: "#/definitions/DotReporterOptionsType" },
         ddot: { $ref: "#/definitions/DotReporterOptionsType" },
         flat: { $ref: "#/definitions/DotReporterOptionsType" },
+        metrics: { $ref: "#/definitions/MetricsReporterOptionsType" },
       },
     },
     AnonReporterOptionsType: {
@@ -577,12 +582,31 @@ module.exports = {
       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" },
       },
     },

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

@@ -40,6 +40,7 @@ function match(pFrom, pTo) {
       matchers.toExoticRequireNot(pRule, pTo) &&
       matchers.toVia(pRule, pTo) &&
       matchers.toViaNot(pRule, pTo) &&
+      matchers.toIsMoreUnstable(pRule, pFrom, pTo) &&
       // preCompilationOnly is not a mandatory attribute, but if the attribute
       // is in the rule but not in the dependency there won't be a match
       // anyway, so we can use the default propertyEquals method regardless

package/src/validate/matchers.js

@@ -1,3 +1,4 @@
+const _has = require("lodash/has");
 const { intersects } = require("../utl/array-util");
 
 function fromPath(pRule, pModule) {
@@ -123,6 +124,16 @@ function toVia(pRule, pDependency) {
   );
 }
 
+function toIsMoreUnstable(pRule, pFrom, pTo) {
+  if (_has(pRule, "to.moreUnstable")) {
+    return (
+      (pRule.to.moreUnstable && pFrom.instability < pTo.instability) ||
+      (!pRule.to.moreUnstable && pFrom.instability >= pTo.instability)
+    );
+  }
+  return true;
+}
+
 module.exports = {
   _replaceGroupPlaceholders,
   fromPath,
@@ -141,4 +152,5 @@ module.exports = {
   toExoticRequireNot,
   toVia,
   toViaNot,
+  toIsMoreUnstable,
 };

package/types/baseline-violations.d.ts

@@ -1,3 +1,3 @@
-import { IViolation } from "./cruise-result";
+import { IViolation } from "./violations";
 
 export type IBaselineViolations = IViolation[];

package/types/cruise-result.d.ts

@@ -1,11 +1,8 @@
 import { ICruiseOptions } from "./options";
 import { IFlattenedRuleSet } from "./rule-set";
-import {
-  DependencyType,
-  ModuleSystemType,
-  SeverityType,
-  ProtocolType,
-} from "./shared-types";
+import { DependencyType, ModuleSystemType, ProtocolType } from "./shared-types";
+import { IViolation } from "./violations";
+import { IRuleSummary } from "./rule-summary";
 
 export interface ICruiseResult {
   /**
@@ -106,6 +103,15 @@ export interface IModule {
    * purposes - it will not be present after a regular cruise.
    */
   consolidated?: boolean;
+  /**
+   * "number of dependents/ (number of dependents + number of dependencies)
+   * A measure for how stable the module is; ranging between 0 (completely
+   * stable module) to 1 (completely instable module). Derived from Uncle
+   * Bob's instability metric - but applied to a single module instead of
+   * to a group of them. This attribute is only present when dependency-cruiser
+   * was asked to calculate metrics.
+   */
+  instability?: number;
 }
 
 export interface IDependency {
@@ -215,27 +221,11 @@ export interface IDependency {
    * will be in the 'rule' object at the same level.
    */
   valid: boolean;
-}
-
-/**
- * If there was a rule violation (valid === false), this object contains the name of the
- * rule and severity of violating it.
- */
-export interface IRuleSummary {
   /**
-   * The (short, eslint style) name of the violated rule. Typically something like
-   * 'no-core-punycode' or 'no-outside-deps'.
+   * the (de-normalized) instability of the dependency - also available in
+   * the module on the 'to' side of this dependency
    */
-  name: string;
-  /**
-   * How severe a violation of a rule is. The 'error' severity will make some reporters return
-   * a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated:
-   * use that. The absence of the 'ignore' severity here is by design; ignored rules don't
-   * show up in the output.
-   *
-   * Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'
-   */
-  severity: SeverityType;
+  instability: number;
 }
 
 export interface IReachable {
@@ -380,29 +370,6 @@ export interface IWebpackConfig {
  */
 export type WebpackEnvType = { [key: string]: any } | string;
 
-export interface IViolation {
-  /**
-   * The violated rule
-   */
-  rule: IRuleSummary;
-  /**
-   * The from part of the dependency this violation is about
-   */
-  from: string;
-  /**
-   * The to part of the dependency this violation is about
-   */
-  to: string;
-  /**
-   * The circular path if the violation is about circularity
-   */
-  cycle?: string[];
-  /**
-   * The path from the from to the to if the violation is transitive
-   */
-  via?: string[];
-}
-
 export interface IFolder {
   /**
    * The name of the folder. FOlder names are normalized to posix (so
@@ -446,3 +413,6 @@ export interface IFolder {
    */
   instability?: number;
 }
+
+export * from "./violations";
+export * from "./rule-summary";

package/types/options.d.ts

@@ -239,4 +239,9 @@ export interface ICruiseOptions {
      */
     type: ProgressType;
   };
+  /**
+   * When this flag is set to true, dependency-cruiser will calculate (stability) metrics
+   * for all modules and folders. Defaults to false.
+   */
+  metrics?: boolean;
 }

package/types/reporter-options.d.ts

@@ -21,6 +21,10 @@ export interface IReporterOptions {
    * Options to tweak the output of the flat /fdot reporter
    */
   flat?: IDotReporterOptions;
+  /**
+   * Options to tweak the output of the metrics reporter
+   */
+  metrics?: IMetricsReporterOptions;
 }
 
 export interface IReporterFiltersType {
@@ -54,6 +58,12 @@ export interface IDotReporterOptions {
    * goal of the report)
    */
   filters?: IReporterFiltersType;
+  /**
+   * When passed the value 'true', shows instability metrics in the
+   * output if dependency-cruiser calculated them. Doesn't show them
+   * in all other cases. Defaults to false",
+   */
+  showMetrics?: boolean;
   /**
    * A bunch of criteria to (conditionally) theme the dot output
    */
@@ -96,3 +106,16 @@ export interface IDotThemeEntry {
   criteria: any;
   attributes: any;
 }
+
+export interface IMetricsReporterOptions {
+  hideModules?: boolean;
+  hideFolders?: boolean;
+  oderBy?: MetricsOrderByType;
+}
+
+export type MetricsOrderByType =
+  | "instability"
+  | "moduleCount"
+  | "afferentCouplings"
+  | "efferentCouplings"
+  | "name";

package/types/restrictions.d.ts

@@ -92,6 +92,18 @@ export interface IToRestriction extends IBaseRestrictionType {
    * licenses. E.g. to flag everyting non MIT use "MIT" here
    */
   licenseNot?: string | string[];
+  /**
+   * When set to true moreUnstable matches for any dependency that has a higher
+   * Instability than the module that depends on it. When set to false it matches
+   * when the opposite is true; the dependency has an equal or lower Instability.
+   *
+   * This attribute is useful when you want to check against Robert C. Martin's
+   * stable dependency * principle. See online documentation for examples and
+   * details.
+   *
+   * Leave this out when you don't care either way.
+   */
+  moreUnstable?: boolean;
 }
 
 export interface IReachabilityToRestrictionType extends IBaseRestrictionType {

package/types/rule-summary.d.ts

@@ -0,0 +1,23 @@
+import { SeverityType } from "./shared-types";
+
+/**
+ * If there was a rule violation (valid === false), this object contains the name of the
+ * rule and severity of violating it.
+ */
+
+export interface IRuleSummary {
+  /**
+   * The (short, eslint style) name of the violated rule. Typically something like
+   * 'no-core-punycode' or 'no-outside-deps'.
+   */
+  name: string;
+  /**
+   * How severe a violation of a rule is. The 'error' severity will make some reporters return
+   * a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated:
+   * use that. The absence of the 'ignore' severity here is by design; ignored rules don't
+   * show up in the output.
+   *
+   * Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'
+   */
+  severity: SeverityType;
+}

package/types/violations.d.ts

@@ -0,0 +1,24 @@
+import { IRuleSummary } from "./rule-summary";
+
+export interface IViolation {
+  /**
+   * The violated rule
+   */
+  rule: IRuleSummary;
+  /**
+   * The from part of the dependency this violation is about
+   */
+  from: string;
+  /**
+   * The to part of the dependency this violation is about
+   */
+  to: string;
+  /**
+   * The circular path if the violation is about circularity
+   */
+  cycle?: string[];
+  /**
+   * The path from the from to the to if the violation is transitive
+   */
+  via?: string[];
+}

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

@@ -1,12 +0,0 @@
-const getStabilityMetrics = require("./get-stability-metrics");
-
-function shouldDeriveFolders(pOptions) {
-  return pOptions.metrics || pOptions.outputType === "metrics";
-}
-
-module.exports = function deriveFolders(pModules, pOptions) {
-  if (shouldDeriveFolders(pOptions)) {
-    return { folders: getStabilityMetrics(pModules) };
-  }
-  return {};
-};