dependency-cruiser 10.7.0 → 10.8.0

package/bin/dependency-cruise.js

@@ -28,6 +28,7 @@ try {
       "-T, --output-type <type>",
       "output type; e.g. err, err-html, dot, ddot, archi, flat, baseline or json\n(default: err)"
     )
+    .option("-m, --metrics", "calculate stability metrics", false)
     .option(
       "-f, --output-to <file>",
       "file to write output to; - for stdout",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.7.0",
+  "version": "10.8.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -131,13 +131,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",
@@ -152,17 +152,17 @@
     "semver": "^7.3.5",
     "semver-try-require": "^5.0.1",
     "teamcity-service-messages": "0.1.11",
-    "tsconfig-paths-webpack-plugin": "3.5.1",
+    "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.0",
+    "@babel/plugin-transform-modules-commonjs": "7.16.0",
+    "@babel/preset-typescript": "7.16.0",
+    "@swc/core": "1.2.113",
+    "@typescript-eslint/eslint-plugin": "5.4.0",
+    "@typescript-eslint/parser": "5.4.0",
+    "@vue/compiler-sfc": "3.2.23",
     "c8": "7.10.0",
     "chai": "4.3.4",
     "chai-json-schema": "1.5.1",
@@ -171,23 +171,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-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.0",
     "proxyquire": "2.1.3",
     "shx": "0.3.3",
-    "svelte": "3.44.0",
+    "svelte": "3.44.2",
     "symlink-dir": "5.0.1",
-    "typescript": "4.4.4",
+    "typescript": "4.5.2",
     "upem": "^7.0.0",
     "vue-template-compiler": "2.6.14",
     "yarn": "1.22.17"
@@ -199,6 +199,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",

package/src/cli/normalize-cli-options.js

@@ -21,6 +21,7 @@ const KNOWN_DEPCRUISE_CLI_OPTIONS = [
   "info",
   "init",
   "maxDepth",
+  "metrics",
   "moduleSystems",
   "outputTo",
   "outputType",

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

@@ -11,7 +11,12 @@ function hasDependentsRule(pOptions) {
 }
 
 function shouldAddDependents(pOptions) {
-  return Boolean(pOptions.forceDeriveDependents) || hasDependentsRule(pOptions);
+  return (
+    Boolean(pOptions.forceDeriveDependents) ||
+    Boolean(pOptions.metrics) ||
+    pOptions.outputType === "metrics" ||
+    hasDependentsRule(pOptions)
+  );
 }
 
 module.exports = function addDependents(pModules, pOptions) {

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

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

package/src/enrich/derive/metrics/get-stability-metrics.js

@@ -0,0 +1,97 @@
+/* eslint-disable security/detect-object-injection */
+const path = require("path").posix;
+const { foldersObject2folderArray, getParentFolders } = require("./utl");
+const {
+  getAfferentCouplings,
+  getEfferentCouplings,
+  metricsAreCalculable,
+} = require("./module-utl");
+
+function upsertCouplings(pAllDependents, pNewDependents) {
+  pNewDependents.forEach((pNewDependent) => {
+    pAllDependents[pNewDependent] = pAllDependents[pNewDependent] || {
+      count: 0,
+    };
+    pAllDependents[pNewDependent].count += 1;
+  });
+}
+
+function upsertFolderAttributes(pAllMetrics, pModule, pDirname) {
+  pAllMetrics[pDirname] = pAllMetrics[pDirname] || {
+    dependencies: {},
+    dependents: {},
+    moduleCount: 0,
+  };
+
+  upsertCouplings(
+    pAllMetrics[pDirname].dependents,
+    getAfferentCouplings(pModule, pDirname)
+  );
+  upsertCouplings(
+    pAllMetrics[pDirname].dependencies,
+    getEfferentCouplings(pModule, pDirname).map(
+      (pDependency) => pDependency.resolved
+    )
+  );
+  pAllMetrics[pDirname].moduleCount += 1;
+
+  return pAllMetrics;
+}
+
+function orderFolderMetrics(pLeftMetric, pRightMetric) {
+  // return pLeft.name.localeCompare(pRight.name);
+  // For intended use in a table it's probably more useful to sort by
+  // instability. Might need to be either configurable or flexible
+  // in the output, though
+  return pRightMetric.instability - pLeftMetric.instability;
+}
+
+function sumCounts(pAll, pCurrent) {
+  return pAll + pCurrent.count;
+}
+
+function getFolderLevelCouplings(pCouplingArray) {
+  return Array.from(
+    new Set(
+      pCouplingArray.map((pCoupling) =>
+        path.dirname(pCoupling.name) === "."
+          ? pCoupling.name
+          : path.dirname(pCoupling.name)
+      )
+    )
+  );
+}
+
+function calculateFolderMetrics(pFolder) {
+  const lModuleDependents = foldersObject2folderArray(pFolder.dependents);
+  const lModuleDependencies = foldersObject2folderArray(pFolder.dependencies);
+  const lAfferentCouplings = lModuleDependents.reduce(sumCounts, 0);
+  const lEfferentCouplings = lModuleDependencies.reduce(sumCounts, 0);
+
+  return {
+    ...pFolder,
+    afferentCouplings: lAfferentCouplings,
+    efferentCouplings: lEfferentCouplings,
+    // when both afferentCouplings and efferentCouplings equal 0 instability will
+    // yield NaN. Judging Bob Martin's intention, a component with no outgoing
+    // dependencies is maximum stable (0)
+    instability:
+      lEfferentCouplings / (lEfferentCouplings + lAfferentCouplings) || 0,
+    dependents: getFolderLevelCouplings(lModuleDependents),
+    dependencies: getFolderLevelCouplings(lModuleDependencies),
+  };
+}
+
+module.exports = function getStabilityMetrics(pModules) {
+  return foldersObject2folderArray(
+    pModules.filter(metricsAreCalculable).reduce((pAllFolders, pModule) => {
+      getParentFolders(path.dirname(pModule.source)).forEach(
+        (pParentDirectory) =>
+          upsertFolderAttributes(pAllFolders, pModule, pParentDirectory)
+      );
+      return pAllFolders;
+    }, {})
+  )
+    .map(calculateFolderMetrics)
+    .sort(orderFolderMetrics);
+};

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

@@ -0,0 +1,27 @@
+const path = require("path").posix;
+
+function getAfferentCouplings(pModule, pDirname) {
+  return pModule.dependents.filter(
+    (pDependent) => !pDependent.startsWith(pDirname.concat(path.sep))
+  );
+}
+
+function getEfferentCouplings(pModule, pDirname) {
+  return pModule.dependencies.filter(
+    (pDependency) => !pDependency.resolved.startsWith(pDirname.concat(path.sep))
+  );
+}
+
+function metricsAreCalculable(pModule) {
+  return (
+    !pModule.coreModule &&
+    !pModule.couldNotResolve &&
+    !pModule.matchesDoNotFollow
+  );
+}
+
+module.exports = {
+  getAfferentCouplings,
+  getEfferentCouplings,
+  metricsAreCalculable,
+};

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

@@ -0,0 +1,29 @@
+// const { findModuleByName, clearCache } = require("../utl");
+const { metricsAreCalculable } = require("./module-utl");
+const { shouldDeriveMetrics } = require("./utl");
+
+module.exports = function deriveModuleMetrics(pModules, pOptions) {
+  if (shouldDeriveMetrics(pOptions)) {
+    return 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/metrics/utl.js

@@ -0,0 +1,28 @@
+/* eslint-disable security/detect-object-injection */
+function getParentFolders(pPath) {
+  let lFragments = pPath.split("/");
+  let lReturnValue = [];
+
+  while (lFragments.length > 0) {
+    lReturnValue.push(lFragments.join("/"));
+    lFragments.pop();
+  }
+  return lReturnValue.reverse();
+}
+
+function foldersObject2folderArray(pObject) {
+  return Object.keys(pObject).map((pKey) => ({
+    name: pKey,
+    ...pObject[pKey],
+  }));
+}
+
+function shouldDeriveMetrics(pOptions) {
+  return pOptions.metrics || pOptions.outputType === "metrics";
+}
+
+module.exports = {
+  getParentFolders,
+  foldersObject2folderArray,
+  shouldDeriveMetrics,
+};

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: calculating 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,4 +1,5 @@
 const enrichModules = require("./enrich-modules");
+const deriveFolderMetrics = require("./derive/metrics/folder.js");
 const summarize = require("./summarize");
 const clearCaches = require("./clear-caches");
 
@@ -9,6 +10,7 @@ module.exports = function enrich(pModules, pOptions, pFileAndDirectoryArray) {
   clearCaches();
   return {
     modules: lModules,
+    ...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/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.7.0",
+  version: "10.8.0",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/src/report/index.js

@@ -13,6 +13,7 @@ const json = require("./json");
 const teamcity = require("./teamcity");
 const text = require("./text");
 const baseline = require("./baseline");
+const metrics = require("./metrics");
 const { getExternalPluginReporter } = require("./plugins");
 
 const TYPE2REPORTER = {
@@ -32,6 +33,7 @@ const TYPE2REPORTER = {
   teamcity,
   text,
   baseline,
+  metrics,
 };
 
 /**

package/src/report/metrics.js

@@ -0,0 +1,131 @@
+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 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
+  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(getHeader(lMaxNameWidth))]
+    .concat(getDemarcationLine(lMaxNameWidth))
+    .concat(
+      getMetricsTable(
+        lComponents
+          .sort(orderByString("name"))
+          .sort(orderByNumber(orderBy || "instability")),
+        lMaxNameWidth
+      )
+    )
+    .join(EOL)
+    .concat(EOL);
+}
+
+/**
+ * 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
+ *      cruise result schema
+ * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ *      output: some metrics on folders and dependencies
+ *      exitCode: 0
+ */
+module.exports = (pCruiseResult, pReporterOptions) => {
+  const lReporterOptions = pReporterOptions || {};
+  if (pCruiseResult.folders) {
+    return {
+      output: transformMetricsToTable(pCruiseResult, lReporterOptions),
+      exitCode: 0,
+    };
+  } else {
+    return {
+      output:
+        `${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

@@ -394,6 +394,7 @@ module.exports = {
         dot: { $ref: "#/definitions/DotReporterOptionsType" },
         ddot: { $ref: "#/definitions/DotReporterOptionsType" },
         flat: { $ref: "#/definitions/DotReporterOptionsType" },
+        metrics: { $ref: "#/definitions/MetricsReporterOptionsType" },
       },
     },
     AnonReporterOptionsType: {
@@ -401,6 +402,24 @@ 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,

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

@@ -9,6 +9,7 @@ module.exports = {
   additionalProperties: false,
   properties: {
     modules: { $ref: "#/definitions/ModulesType" },
+    folders: { $ref: "#/definitions/FoldersType" },
     summary: { $ref: "#/definitions/SummaryType" },
   },
   definitions: {
@@ -46,6 +47,7 @@ module.exports = {
           items: { $ref: "#/definitions/RuleSummaryType" },
         },
         consolidated: { type: "boolean" },
+        instability: { type: "number" },
       },
     },
     ReachableType: {
@@ -158,6 +160,21 @@ module.exports = {
       },
     },
     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: "string" } },
+        dependencies: { type: "array", items: { type: "string" } },
+        moduleCount: { type: "number" },
+        afferentCouplings: { type: "number" },
+        efferentCouplings: { type: "number" },
+        instability: { type: "number" },
+      },
+    },
     SummaryType: {
       type: "object",
       required: [
@@ -510,6 +527,7 @@ module.exports = {
             "teamcity",
             "anon",
             "text",
+            "metrics",
           ],
         },
         { type: "string", pattern: "^plugin:[^:]+$" },
@@ -553,6 +571,7 @@ module.exports = {
         dot: { $ref: "#/definitions/DotReporterOptionsType" },
         ddot: { $ref: "#/definitions/DotReporterOptionsType" },
         flat: { $ref: "#/definitions/DotReporterOptionsType" },
+        metrics: { $ref: "#/definitions/MetricsReporterOptionsType" },
       },
     },
     AnonReporterOptionsType: {
@@ -560,6 +579,24 @@ 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,

package/types/cruise-result.d.ts

@@ -12,6 +12,15 @@ export interface ICruiseResult {
    * A list of modules, with for each module the modules it depends upon
    */
   modules: IModule[];
+  /**
+   * A list of folders, as derived from the detected modules, with for each
+   * "folder a bunch of metrics (adapted from 'Agile software development:
+   * "principles, patterns, and practices' by Robert C Martin (ISBN 0-13-597444-5).
+   * "Note: these metrics substitute 'components' and 'classes' from that book
+   * "with 'folders' and 'modules'; the closest relatives that work for the most
+   * "programming styles in JavaScript (and its derivative languages).
+   */
+  folders?: IFolder[];
   /**
    * Data summarizing the found dependencies
    */
@@ -97,6 +106,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 {
@@ -393,3 +411,47 @@ export interface IViolation {
    */
   via?: string[];
 }
+
+export interface IFolder {
+  /**
+   * The name of the folder. FOlder names are normalized to posix (so
+   * separated by forward slashes e.g.: src/things/morethings)
+   */
+  name: string;
+  /**
+   * List of folders depending on this folder
+   */
+  dependents?: string[];
+  /**
+   * List of folders this folder depends upon
+   */
+  dependencies?: string[];
+  /**
+   * The total number of modules detected in this folder and its sub-folders
+   */
+  moduleCount: number;
+  /**
+   * The number of modules outside this folder that depend on modules
+   * within this folder. Only present when dependency-cruiser was
+   * "asked to calculate it.
+   */
+  afferentCouplings?: number;
+  /**
+   * The number of modules inside this folder that depend on modules
+   * outside this folder. Only present when dependency-cruiser was
+   * asked to calculate it.
+   */
+  efferentCouplings?: number;
+  /**
+   * efferentCouplings/ (afferentCouplings + efferentCouplings)
+   *
+   * A measure for how stable the folder is; ranging between 0
+   * (completely stable folder) to 1 (completely instable folder)
+   * Note that while 'instability' has a negative connotation it's also
+   * (unavoidable in any meaningful system. It's the basis of Martin's
+   * variable component stability principle: 'the instability of a folder
+   * should be larger than the folders it depends on'. Only present when
+   * dependency-cruiser was asked to calculate it.,
+   */
+  instability?: number;
+}

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 {
@@ -96,3 +100,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/shared-types.d.ts

@@ -18,6 +18,7 @@ export type OutputType =
   | "teamcity"
   | "anon"
   | "text"
+  | "metrics"
   | string;
 
 export type SeverityType = "error" | "warn" | "info" | "ignore";