dependency-cruiser 10.8.0-beta-2 → 10.8.0-beta-3

package/package.json

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

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

@@ -1,13 +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,
-      instability:
-        pModule.dependencies.length /
-          (pModule.dependents.length + pModule.dependencies.length) || 0,
+      ...(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/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-2",
+  version: "10.8.0-beta-3",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/src/report/metrics.js

@@ -1,4 +1,4 @@
-const os = require("os");
+const { EOL } = require("os");
 const chalk = require("chalk");
 
 const DECIMAL_BASE = 10;
@@ -24,19 +24,24 @@ function getDemarcationLine(pMaxNameWidth) {
 }
 
 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)}`;
-  });
+  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 }) {
@@ -50,22 +55,33 @@ function metricifyModule({ source, dependents, dependencies, instability }) {
 }
 
 function metricsAreCalculable(pModule) {
-  return (
-    !pModule.coreModule &&
-    !pModule.couldNotResolve &&
-    !pModule.matchesDoNotFollow
-  );
+  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 orderByInstability(pLeft, pRight) {
-  return pRight.instability - pLeft.instability;
+function orderByString(pAttributeName) {
+  return (pLeft, pRight) =>
+    // eslint-disable-next-line security/detect-object-injection
+    pLeft[pAttributeName].localeCompare(pRight[pAttributeName]);
 }
-function transformMetricsToTable({ modules, folders }) {
+
+function transformMetricsToTable(
+  { modules, folders },
+  { orderBy, hideFolders, hideModules }
+) {
   // TODO: should probably use a table module for this (i.e. text-table)
   // to simplify this code
-  const lMaxNameWidth = folders
-    .map((pFolder) => pFolder.name.length)
-    .concat(modules.map((pModule) => pModule.source.length))
+  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();
@@ -74,20 +90,21 @@ function transformMetricsToTable({ modules, folders }) {
     .concat(getDemarcationLine(lMaxNameWidth))
     .concat(
       getMetricsTable(
-        folders
-          .concat(modules.filter(metricsAreCalculable).map(metricifyModule))
-          .sort(orderByInstability),
+        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
@@ -96,17 +113,18 @@ function transformMetricsToTable({ modules, folders }) {
  *      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),
+      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

@@ -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

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