dependency-cruiser 10.8.0-beta-1 → 10.8.0-beta-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.8.0-beta-1",
+  "version": "10.8.0-beta-2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

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/module.js

@@ -0,0 +1,13 @@
+const { shouldDeriveMetrics } = require("./utl");
+
+module.exports = function deriveModuleMetrics(pModules, pOptions) {
+  if (shouldDeriveMetrics(pOptions)) {
+    return pModules.map((pModule) => ({
+      ...pModule,
+      instability:
+        pModule.dependencies.length /
+          (pModule.dependents.length + pModule.dependencies.length) || 0,
+    }));
+  }
+  return pModules;
+};

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

@@ -17,7 +17,12 @@ function foldersObject2folderArray(pObject) {
   }));
 }
 
+function shouldDeriveMetrics(pOptions) {
+  return pOptions.metrics || pOptions.outputType === "metrics";
+}
+
 module.exports = {
   getParentFolders,
   foldersObject2folderArray,
+  shouldDeriveMetrics,
 };

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,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/meta.js

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

package/src/report/metrics.js

@@ -5,49 +5,80 @@ 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((pMetric) => {
+    return `${pMetric.name.padEnd(pMaxNameWidth, " ")}  ${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)}`;
+  });
+}
+
+function metricifyModule({ source, dependents, dependencies, instability }) {
+  return {
+    name: source,
+    moduleCount: 1,
+    afferentCouplings: dependents.length,
+    efferentCouplings: dependencies.length,
+    instability,
+  };
+}
+
+function metricsAreCalculable(pModule) {
+  return (
+    !pModule.coreModule &&
+    !pModule.couldNotResolve &&
+    !pModule.matchesDoNotFollow
+  );
+}
+
+function orderByInstability(pLeft, pRight) {
+  return pRight.instability - pLeft.instability;
+}
+function transformMetricsToTable({ modules, folders }) {
   // 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
+  const lMaxNameWidth = folders
+    .map((pFolder) => pFolder.name.length)
+    .concat(modules.map((pModule) => pModule.source.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(
+        folders
+          .concat(modules.filter(metricsAreCalculable).map(metricifyModule))
+          .sort(orderByInstability),
+        lMaxNameWidth
+      )
     )
     .join(os.EOL)
     .concat(os.EOL);
@@ -68,7 +99,7 @@ function transformMetricsToTable(pMetrics) {
 module.exports = (pCruiseResult) => {
   if (pCruiseResult.folders) {
     return {
-      output: transformMetricsToTable(pCruiseResult.folders),
+      output: transformMetricsToTable(pCruiseResult),
       exitCode: 0,
     };
   } else {

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

@@ -47,6 +47,7 @@ module.exports = {
           items: { $ref: "#/definitions/RuleSummaryType" },
         },
         consolidated: { type: "boolean" },
+        instability: { type: "number" },
       },
     },
     ReachableType: {

package/types/cruise-result.d.ts

@@ -106,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 {

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 {};
-};