dependency-cruiser 16.10.2 → 16.10.4-beta-1

package/bin/depcruise-baseline.mjs

@@ -1,43 +1,69 @@
 #!/usr/bin/env node
-import { program } from "commander";
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
+import { parseArgs } from "node:util";
 import assertNodeEnvironmentSuitable from "#cli/assert-node-environment-suitable.mjs";
 import cli from "#cli/index.mjs";
 import meta from "#meta.cjs";
 
-function formatError(pError) {
-  process.stderr.write(pError.message);
-  process.exitCode = 1;
+function showHelp() {
+  process.stdout
+    .write(`Usage: depcruise-baseline [options] <files-or-directories...>
+
+Writes all known violations of rules in a .dependency-cruiser.js to a file.
+Alias for depcruise -c -T baseline -f .dependency-cruiser-known-violations.json [files-or-directories]
+Details: https://github.com/sverweij/dependency-cruiser
+
+Options:
+  -c, --config [file]       read rules and options from [file] (default: true)
+  -f, --output-to [file]    file to write output to; - for stdout (default: ".dependency-cruiser-known-violations.json")
+  -V, --version             display version number
+  -h, --help                display help for command
+`);
 }
 
 try {
   assertNodeEnvironmentSuitable();
 
-  program
-    .description(
-      "Writes all known violations of rules in a .dependency-cruiser.js to a file.\n" +
-        "Alias for depcruise -c -T baseline -f .dependency-cruiser-known-violations.json [files-or-directories]\n" +
-        "Details: https://github.com/sverweij/dependency-cruiser",
-    )
-    .option("-c, --config [file]", "read rules and options from [file]", true)
-    .option(
-      "-f, --output-to [file]",
-      "file to write output to; - for stdout",
-      ".dependency-cruiser-known-violations.json",
-    )
-    .version(meta.version)
-    .argument("<files-or-directories...>")
-    .parse(process.argv);
+  const { values: options, positionals } = parseArgs({
+    options: {
+      config: {
+        type: "string",
+        short: "c",
+        default: "",
+      },
+      "output-to": {
+        type: "string",
+        short: "f",
+        default: ".dependency-cruiser-known-violations.json",
+      },
+      version: {
+        type: "boolean",
+        short: "V",
+      },
+      help: {
+        type: "boolean",
+        short: "h",
+      },
+    },
+    allowPositionals: true,
+  });
 
-  if (program.args[0]) {
-    process.exitCode = await cli(program.args, {
-      ...program.opts(),
+  if (options.version) {
+    process.stdout.write(`${meta.version}\n`);
+  } else if (options.help || positionals.length === 0) {
+    showHelp();
+  } else {
+    if (options.config === "") {
+      options.config = true;
+    }
+    process.exitCode = await cli(positionals, {
+      config: options.config,
+      outputTo: options["output-to"],
       cache: false,
       outputType: "baseline",
     });
-  } else {
-    program.help();
   }
 } catch (pError) {
-  formatError(pError);
+  process.stderr.write(pError.message);
   process.exitCode = 1;
 }

package/bin/depcruise-fmt.mjs

@@ -1,82 +1,126 @@
 #!/usr/bin/env node
-
-import { program } from "commander";
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
+import { parseArgs } from "node:util";
 import assertNodeEnvironmentSuitable from "#cli/assert-node-environment-suitable.mjs";
 import format from "#cli/format.mjs";
 import meta from "#meta.cjs";
 
-function formatError(pError) {
-  process.stderr.write(pError.message);
-  process.exitCode = 1;
+function showHelp() {
+  process.stdout.write(`Usage: depcruise-fmt [options] <dependency-cruiser-json>
+
+Format dependency-cruiser output json.
+Details: https://github.com/sverweij/dependency-cruiser
+
+Options:
+  -f, --output-to <file>      file to write output to; - for stdout (default: "-")
+  -T, --output-type <type>    output type; e.g. err, err-html, dot, ddot, archi, flat, 
+                              d2, mermaid or json (default: "err")
+  -I, --include-only <regex>  only include modules matching the regex
+  -F, --focus <regex>         only include modules matching the regex + their direct neighbours
+      --focus-depth <number>  the depth to focus on - only applied when --focus is passed too.
+                              1= direct neighbors, 2=neighbours of neighbours etc. (default: 1)
+  -R, --reaches <regex>       only include modules matching the regex + all modules that can reach it
+  -H, --highlight <regex>     mark modules matching the regex as 'highlighted'
+  -x, --exclude <regex>       exclude all modules matching the regex
+  -S, --collapse <regex>      collapse to a folder depth by passing a single digit (e.g. 2). Or 
+                              pass a regex to collapse to a pattern E.g. ^packages/[^/]+/ would 
+                              collapse to modules/ folders directly under your packages folder.
+  -P, --prefix <prefix>       prefix to use for links in the dot and err-html reporters
+  -e, --exit-code             exit with a non-zero exit code when the input json contains error 
+                              level dependency violations. Works for err, err-long and teamcity 
+                              output types
+  -V, --version               display version number
+  -h, --help                  display help for command
+`);
 }
 
 try {
   assertNodeEnvironmentSuitable();
 
-  program
-    .description(
-      "Format dependency-cruiser output json.\nDetails: https://github.com/sverweij/dependency-cruiser",
-    )
-    .option(
-      "-f, --output-to <file>",
-      "file to write output to; - for stdout",
-      "-",
-    )
-    .option(
-      "-T, --output-type <type>",
-      "output type; e.g. err, err-html, dot, ddot, archi, flat, d2, mermaid or json",
-      "err",
-    )
-    .option(
-      "-I, --include-only <regex>",
-      "only include modules matching the regex",
-    )
-    .option(
-      "-F, --focus <regex>",
-      "only include modules matching the regex + their direct neighbours",
-    )
-    .option(
-      "--focus-depth <number>",
-      "the depth to focus on - only applied when --focus is passed too. " +
-        "1= direct neighbors, 2=neighbours of neighbours etc.",
-      1,
-    )
-    .option(
-      "-R, --reaches <regex>",
-      "only include modules matching the regex + all modules that can reach it",
-    )
-    .option(
-      "-H, --highlight <regex>",
-      "mark modules matching the regex as 'highlighted'",
-    )
-    .option("-x, --exclude <regex>", "exclude all modules matching the regex")
-    .option(
-      "-S, --collapse <regex>",
-      "collapse to a folder depth by passing a single digit (e.g. 2). Or pass a " +
-        "regex to collapse to a pattern E.g. ^packages/[^/]+/ would collapse to " +
-        "modules/ folders directly under your packages folder. ",
-    )
-    .option(
-      "-P, --prefix <prefix>",
-      "prefix to use for links in the dot and err-html reporters",
-    )
-    .option(
-      "-e, --exit-code",
-      "exit with a non-zero exit code when the input json contains error level " +
-        "dependency violations. Works for err, err-long and teamcity output types",
-    )
-    .version(meta.version)
-    .argument("<dependency-cruiser-json>")
-    .parse(process.argv);
+  const { values: options, positionals } = parseArgs({
+    options: {
+      "output-to": {
+        type: "string",
+        short: "f",
+        default: "-",
+      },
+      "output-type": {
+        type: "string",
+        short: "T",
+        default: "err",
+      },
+      "include-only": {
+        type: "string",
+        short: "I",
+      },
+      focus: {
+        type: "string",
+        short: "F",
+      },
+      "focus-depth": {
+        type: "string",
+        default: "1",
+      },
+      reaches: {
+        type: "string",
+        short: "R",
+      },
+      highlight: {
+        type: "string",
+        short: "H",
+      },
+      exclude: {
+        type: "string",
+        short: "x",
+      },
+      collapse: {
+        type: "string",
+        short: "S",
+      },
+      prefix: {
+        type: "string",
+        short: "P",
+      },
+      "exit-code": {
+        type: "boolean",
+        short: "e",
+      },
+      version: {
+        type: "boolean",
+        short: "V",
+      },
+      help: {
+        type: "boolean",
+        short: "h",
+      },
+    },
+    allowPositionals: true,
+  });
 
-  if (program.args[0]) {
-    const lExitCode = await format(program.args[0], program.opts());
-    if (program.opts().exitCode) {
+  if (options.version) {
+    process.stdout.write(`${meta.version}\n`);
+  } else if (options.help || positionals.length === 0) {
+    showHelp();
+  } else {
+    const lFormatOptions = {
+      ...options,
+      outputTo: options["output-to"],
+      outputType: options["output-type"],
+      includeOnly: options["include-only"],
+      focusDepth: options["focus-depth"],
+      exitCode: options["exit-code"],
+    };
+    delete lFormatOptions["output-to"];
+    delete lFormatOptions["output-type"];
+    delete lFormatOptions["include-only"];
+    delete lFormatOptions["focus-depth"];
+    delete lFormatOptions["exit-code"];
+    const lExitCode = await format(positionals[0], lFormatOptions);
+    if (lFormatOptions.exitCode) {
       process.exitCode = lExitCode;
     }
-  } else {
-    program.help();
   }
 } catch (pError) {
-  formatError(pError);
+  process.stderr.write(pError.message);
+  process.exitCode = 1;
 }

package/configs/plugins/stats-reporter-plugin.mjs

@@ -76,7 +76,7 @@ export default (pCruiseResult) => ({
   output: JSON.stringify(
     samplePluginReporter(pCruiseResult),
     null,
-    DEFAULT_JSON_INDENT
+    DEFAULT_JSON_INDENT,
   ),
   exitCode: 0,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.10.2",
+  "version": "16.10.4-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -140,15 +140,15 @@
     "README.md"
   ],
   "dependencies": {
-    "acorn": "^8.14.1",
+    "acorn": "^8.15.0",
     "acorn-jsx": "^5.3.2",
     "acorn-jsx-walk": "^2.0.0",
-    "acorn-loose": "^8.5.0",
+    "acorn-loose": "^8.5.1",
     "acorn-walk": "^8.3.4",
     "ajv": "^8.17.1",
     "commander": "^13.1.0",
     "enhanced-resolve": "^5.18.1",
-    "ignore": "^7.0.4",
+    "ignore": "^7.0.5",
     "interpret": "^3.1.1",
     "is-installed-globally": "^1.0.0",
     "json5": "^2.2.3",
@@ -158,7 +158,7 @@
     "prompts": "^2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "^2.1.1",
-    "semver": "^7.7.1",
+    "semver": "^7.7.2",
     "teamcity-service-messages": "^0.1.14",
     "tsconfig-paths-webpack-plugin": "^4.2.0",
     "watskeburt": "^4.2.3"

package/src/enrich/derive/folders/utl.mjs

@@ -7,13 +7,13 @@ export function findFolderByName(pAllFolders, pName) {
 
 export function getAfferentCouplings(pModule, pDirname) {
   return pModule.dependents.filter(
-    (pDependent) => !pDependent.startsWith(pDirname.concat(sep))
+    (pDependent) => !pDependent.startsWith(pDirname.concat(sep)),
   );
 }
 
 export function getEfferentCouplings(pModule, pDirname) {
   return pModule.dependencies.filter(
-    (pDependency) => !pDependency.resolved.startsWith(pDirname.concat(sep))
+    (pDependency) => !pDependency.resolved.startsWith(pDirname.concat(sep)),
   );
 }
 

package/src/enrich/derive/module-utl.mjs

@@ -1,7 +1,7 @@
 export function isDependent(pResolvedName) {
   return (pModule) =>
     pModule.dependencies.some(
-      (pDependency) => pDependency.resolved === pResolvedName
+      (pDependency) => pDependency.resolved === pResolvedName,
     );
 }
 
@@ -23,7 +23,7 @@ export function metricsAreCalculable(pModule) {
  */
 export function calculateInstability(
   pEfferentCouplingCount,
-  pAfferentCouplingCount
+  pAfferentCouplingCount,
 ) {
   // when both afferentCouplings and efferentCouplings equal 0 instability will
   // yield NaN. Judging Bob Martin's intention, a component with no outgoing

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

@@ -59,11 +59,12 @@ function softenDependencyViolations(
   }
   return pDependency;
 }
+
 /**
  *
  * @param {import("../../types/cruise-result.mjs").IModule} pModule
- * @param {import("../../types/baseline-violations.js").IBaselineViolations} pKnownViolations
- * @param {import("../../types/shared-types.js").SeverityType} pSoftenedSeverity
+ * @param {import("../../types/baseline-violations.mjs").IBaselineViolations} pKnownViolations
+ * @param {import("../../types/shared-types.mjs").SeverityType} pSoftenedSeverity
  * @returns {import("../../types/cruise-result.mjs").IModule}
  */
 function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
@@ -76,9 +77,8 @@ function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
         softenModuleViolation(
           pRule,
           pModule.source,
-          pKnownViolations.filter(
-            (pKnownError) =>
-              pKnownError.from === pKnownError.to && !pKnownError.cycle,
+          pKnownViolations.filter((pKnownViolation) =>
+            ["module", "reachability"].includes(pKnownViolation.type),
           ),
           pSoftenedSeverity,
         ),
@@ -92,23 +92,26 @@ function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
       softenDependencyViolations(
         pDependency,
         pModule.source,
-        pKnownViolations.filter(
-          (pKnownError) =>
-            pKnownError.from !== pKnownError.to || pKnownError.cycle,
+        pKnownViolations.filter((pKnownViolation) =>
+          ["dependency", "cycle", "instability"].includes(pKnownViolation.type),
         ),
         pSoftenedSeverity,
       ),
     ),
   };
 
+  // TODO: folder level violations (e.g. with 'instability' rules - these need
+  // to be softened within the "folders" node, which lives next to the "modules"
+  // one)
+
   return lReturnValue;
 }
 
 /**
  *
  * @param {import("../../types/cruise-result.mjs").IModule[]} pModules
- * @param {import("../../types/baseline-violations.js").IBaselineViolations} pKnownViolations
- * @param {import("../../types/shared-types.js").SeverityType} pSoftenedSeverity
+ * @param {import("../../types/baseline-violations.mjs").IBaselineViolations} pKnownViolations
+ * @param {import("../../types/shared-types.mjs").SeverityType} pSoftenedSeverity
  * @returns {import("../../types/cruise-result.mjs").IModule[]}
  */
 export default function softenKnownViolations(

package/src/enrich/summarize/get-stats.mjs

@@ -9,7 +9,7 @@ export function getViolationStats(pViolations) {
       warn: 0,
       info: 0,
       ignore: 0,
-    }
+    },
   );
 }
 
@@ -20,6 +20,6 @@ export function getModulesCruised(pModules) {
 export function getDependenciesCruised(pModules) {
   return pModules.reduce(
     (pAll, pModule) => pAll + pModule.dependencies.length,
-    0
+    0,
   );
 }

package/src/enrich/summarize/is-same-violation.mjs

@@ -3,22 +3,31 @@ function pluckName({ name }) {
 }
 
 export default function isSameViolation(pLeftViolation, pRightViolation) {
-  let lReturnValue = false;
-
   if (pLeftViolation.rule.name === pRightViolation.rule.name) {
     if (pRightViolation.cycle && pLeftViolation.cycle) {
-      lReturnValue =
+      return (
         pLeftViolation.cycle.length === pRightViolation.cycle.length &&
         pLeftViolation.cycle
           .map(pluckName)
           .every((pModule) =>
             pRightViolation.cycle.map(pluckName).includes(pModule),
-          );
-    } else {
-      lReturnValue =
-        pLeftViolation.from === pRightViolation.from &&
-        pLeftViolation.to === pRightViolation.to;
+          )
+      );
+    }
+    if (pRightViolation.via && pLeftViolation.via) {
+      return (
+        pLeftViolation.via.length === pRightViolation.via.length &&
+        pLeftViolation.via
+          .map(pluckName)
+          .every((pModule) =>
+            pRightViolation.via.map(pluckName).includes(pModule),
+          )
+      );
     }
+    return (
+      pLeftViolation.from === pRightViolation.from &&
+      pLeftViolation.to === pRightViolation.to
+    );
   }
-  return lReturnValue;
+  return false;
 }

package/src/graph-utl/consolidate-to-folder.mjs

@@ -19,6 +19,6 @@ function squashModuleToDirectory(pModule) {
 
 export default function consolidateToFolder(pModules) {
   return consolidateModules(pModules.map(squashModuleToDirectory)).map(
-    consolidateModuleDependencies
+    consolidateModuleDependencies,
   );
 }

package/src/graph-utl/consolidate-to-pattern.mjs

@@ -35,10 +35,10 @@ function squashModuleToPattern(pCollapsePattern) {
       consolidated: determineConsolidatedness(
         pModule.consolidated,
         lCollapseMatch,
-        pModule.source
+        pModule.source,
       ),
       dependencies: pModule.dependencies.map(
-        squashDependencyToPattern(pCollapsePattern)
+        squashDependencyToPattern(pCollapsePattern),
       ),
     };
   };
@@ -46,6 +46,6 @@ function squashModuleToPattern(pCollapsePattern) {
 
 export default function consolidateToPattern(pModules, pCollapsePattern) {
   return consolidateModules(
-    pModules.map(squashModuleToPattern(pCollapsePattern))
+    pModules.map(squashModuleToPattern(pCollapsePattern)),
   ).map(consolidateModuleDependencies);
 }

package/src/graph-utl/strip-self-transitions.mjs

@@ -2,7 +2,7 @@ export default function stripSelfTransitions(pModule) {
   return {
     ...pModule,
     dependencies: pModule.dependencies.filter(
-      (pDependency) => pModule.source !== pDependency.resolved
+      (pDependency) => pModule.source !== pDependency.resolved,
     ),
   };
 }

package/src/meta.cjs

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "16.10.2",
+  version: "16.10.4-beta-1",
   engines: {
     node: "^18.17||>=20",
   },

package/src/report/utl/dependency-to-incidence-transformer.mjs

@@ -9,7 +9,7 @@ function compareOnSource(pOne, pTwo) {
 function determineIncidenceType(pFromListEntry) {
   return (pModule) => {
     let lDependency = pModule.dependencies.find(
-      (pDependency) => pDependency.resolved === pFromListEntry.source
+      (pDependency) => pDependency.resolved === pFromListEntry.source,
     );
 
     if (lDependency) {

package/src/utl/find-all-files.mjs

@@ -26,7 +26,7 @@ function fileIsDirectory(pFullPathToFile, pBaseDirectory) {
  */
 function walk(
   pDirectoryName,
-  { baseDir, ignoreFilterFn, excludeFilterFn, includeOnlyFilterFn }
+  { baseDir, ignoreFilterFn, excludeFilterFn, includeOnlyFilterFn },
 ) {
   return readdirSync(join(baseDir, pDirectoryName))
     .map((pFileName) => join(pDirectoryName, pFileName))
@@ -51,12 +51,12 @@ function walk(
               ignoreFilterFn,
               excludeFilterFn,
               includeOnlyFilterFn,
-            })
+            }),
           );
         }
         return pSum.concat(fullPathToFile);
       },
-      []
+      [],
     )
     .map((pFullPathToFile) => pathToPosix(pFullPathToFile));
 }
@@ -90,7 +90,7 @@ export default function findAllFiles(
     additionalIgnorePatterns,
     excludeFilterFn,
     includeOnlyFilterFn,
-  }
+  },
 ) {
   const lIgnoreFileContents =
     ignoreFileContents ?? readIgnoreFile(join(baseDir, ".gitignore"));