dependency-cruiser 10.7.0 → 10.8.0-beta-1

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-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

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/folders/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/folders/index.js

@@ -0,0 +1,12 @@
+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 {};
+};

package/src/enrich/derive/folders/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/folders/utl.js

@@ -0,0 +1,23 @@
+/* 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],
+  }));
+}
+
+module.exports = {
+  getParentFolders,
+  foldersObject2folderArray,
+};

package/src/enrich/index.js

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

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "10.7.0",
+  version: "10.8.0-beta-1",
   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,82 @@
+const os = require("os");
+const chalk = require("chalk");
+
+const DECIMAL_BASE = 10;
+const METRIC_WIDTH = 4;
+const INSTABILITY_DECIMALS = 2;
+const YADDUM = DECIMAL_BASE ** INSTABILITY_DECIMALS;
+
+function transformMetricsToTable(pMetrics) {
+  // 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)
+    .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)}`
+    )
+    .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)}`;
+      })
+    )
+    .join(os.EOL)
+    .concat(os.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)
+ *
+ * @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) => {
+  if (pCruiseResult.folders) {
+    return {
+      output: transformMetricsToTable(pCruiseResult.folders),
+      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}`,
+      exitCode: 1,
+    };
+  }
+};

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: {
@@ -158,6 +159,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 +526,7 @@ module.exports = {
             "teamcity",
             "anon",
             "text",
+            "metrics",
           ],
         },
         { type: "string", pattern: "^plugin:[^:]+$" },

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
    */
@@ -393,3 +402,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/shared-types.d.ts

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