dependency-cruiser 10.3.0-beta-4 → 10.3.0-beta-8

package/bin/depcruise-baseline.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+const validateNodeEnvironment = require("../src/cli/validate-node-environment");
+
+function formatError(pError) {
+  process.stderr.write(pError.message);
+  process.exitCode = 1;
+}
+
+try {
+  validateNodeEnvironment();
+
+  // importing things only after the validateNodeEnv check so we can show an understandable
+  // error. Otherwise, on unsupported platforms we would show a stack trace, which is
+  // not so nice
+  /* eslint-disable node/global-require */
+  const program = require("commander");
+  const { version } = require("../src/meta.js");
+  const cli = require("../src/cli");
+
+  program
+    .description(
+      "Writes all known violations of rules in a .dependency-cruiser.js to a file.\nAlias for depcruise -c -T baseline -f .dependency-cruiser-known-violations.json [files-or-directories]\nDetails: 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(version)
+    .arguments("<files-or-directories>")
+    .parse(process.argv);
+
+  if (Boolean(program.args[0])) {
+    process.exitCode = cli(program.args, {
+      ...program.opts(),
+      outputType: "baseline",
+    });
+  } else {
+    program.help();
+  }
+} catch (pError) {
+  formatError(pError);
+  process.exitCode = 1;
+}

package/bin/depcruise-fmt.js

@@ -28,7 +28,7 @@ try {
     )
     .option(
       "-T, --output-type <type>",
-      "output type; e.g. err, err-html, dot, ddot, archi, flat or json",
+      "output type; e.g. err, err-html, dot, ddot, archi, flat, baseline or json",
       "err"
     )
     .option(

package/bin/dependency-cruise.js

@@ -26,7 +26,7 @@ try {
     )
     .option(
       "-T, --output-type <type>",
-      "output type; e.g. err, err-html, dot, ddot, archi, flat or json\n(default: err)"
+      "output type; e.g. err, err-html, dot, ddot, archi, flat, baseline or json\n(default: err)"
     )
     .option(
       "-f, --output-to <file>",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.3.0-beta-4",
+  "version": "10.3.0-beta-8",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -39,6 +39,7 @@
     "dependency-cruiser": "bin/dependency-cruise.js",
     "dependency-cruise": "bin/dependency-cruise.js",
     "depcruise": "bin/dependency-cruise.js",
+    "depcruise-baseline": "bin/depcruise-baseline.js",
     "depcruise-fmt": "bin/depcruise-fmt.js",
     "depcruise-wrap-stream-in-html": "bin/wrap-stream-in-html.js"
   },
@@ -73,7 +74,7 @@
     "check:full": "npm-run-all check test:glob test:yarn-pnp",
     "depcruise": "node ./bin/dependency-cruise.js src bin test configs types tools --config --ignore-known",
     "depcruise:all": "node ./bin/dependency-cruise.js src bin test configs types tools --config",
-    "depcruise:baseline": "node ./bin/dependency-cruise.js src bin test configs types tools --config --output-type baseline --progress --output-to .dependency-cruiser-known-violations.json",
+    "depcruise:baseline": "node ./bin/depcruise-baseline.js src bin test configs types tools",
     "depcruise:explain": "node ./bin/dependency-cruise.js src bin test configs types tools --output-type err-long --config --progress none",
     "depcruise:graph:dev": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config --output-type dot --progress cli-feedback | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
     "depcruise:graph:doc": "npm-run-all depcruise:graph:doc:json --parallel depcruise:graph:doc:fmt-* depcruise:graph:doc:samples",
@@ -121,8 +122,8 @@
     "test:yarn-pnp:run": "cd test/integration/yarn-pnp.testing-ground && yarn dependency-cruise:json",
     "test:yarn-pnp:test": "cd test/integration/yarn-pnp.testing-ground && yarn test",
     "test:yarn-pnp:cleanup": "shx rm -rf test/integration/yarn-pnp.testing-ground dependency-cruiser*.tgz",
-    "test:load": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.js --validate -- src bin test configs types tools\"",
-    "test:load:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.js --validate -- src bin test configs types tools\"",
+    "test:load": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.js --ignore-known --validate -- src bin test configs types tools\"",
+    "test:load:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.js --ignore-known --validate -- src bin test configs types tools\"",
     "test:watch": "mocha --watch --watch-extensions=json --reporter=min test/\\*\\*/\\*.spec.js",
     "update-dependencies": "npm-run-all upem:update upem:install build:clean build lint:fix depcruise test:cover",
     "upem:install": "npm install",

package/src/cli/index.js

@@ -1,5 +1,3 @@
-const { readFileSync } = require("fs");
-const json5 = require("json5");
 const glob = require("glob");
 const _get = require("lodash/get");
 const _clone = require("lodash/clone");
@@ -11,7 +9,7 @@ const bus = require("../utl/bus");
 const extractTSConfig = require("../config-utl/extract-ts-config");
 const extractBabelConfig = require("../config-utl/extract-babel-config");
 const extractWebpackResolveConfig = require("../config-utl/extract-webpack-resolve-config");
-const makeAbsolute = require("../config-utl/make-absolute");
+const extractKnownViolations = require("../config-utl/extract-known-violations");
 const validateFileExistence = require("./utl/validate-file-existence");
 const normalizeCliOptions = require("./normalize-cli-options");
 const io = require("./utl/io");
@@ -39,16 +37,15 @@ function extractResolveOptions(pCruiseOptions) {
 
 function addKnownViolations(pCruiseOptions) {
   if (pCruiseOptions.knownViolationsFile) {
-    const lKnownViolations = json5.parse(
-      readFileSync(makeAbsolute(pCruiseOptions.knownViolationsFile), "utf-8")
+    const lKnownViolations = extractKnownViolations(
+      pCruiseOptions.knownViolationsFile
     );
+
     // Check against json schema is already done in src/main/options/validate
     // so here we can just concentrate on the io
-    if (Boolean(lKnownViolations)) {
-      let lCruiseOptions = _clone(pCruiseOptions);
-      _set(lCruiseOptions, "ruleSet.options.knownViolations", lKnownViolations);
-      return lCruiseOptions;
-    }
+    let lCruiseOptions = _clone(pCruiseOptions);
+    _set(lCruiseOptions, "ruleSet.options.knownViolations", lKnownViolations);
+    return lCruiseOptions;
   }
   return pCruiseOptions;
 }
@@ -130,6 +127,12 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
   return lReportingResult.exitCode;
 }
 
+/**
+ *
+ * @param {string[]} pFileDirectoryArray
+ * @param {import("../../types/options").ICruiseOptions} pCruiseOptions
+ * @returns {number}
+ */
 module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
   pCruiseOptions = pCruiseOptions || {};
   let lExitCode = 0;

package/src/config-utl/extract-known-violations.js

@@ -0,0 +1,27 @@
+const { readFileSync } = require("fs");
+const json5 = require("json5");
+const makeAbsolute = require("./make-absolute");
+
+module.exports = function extractKnownViolations(pKnownViolationsFileName) {
+  try {
+    return json5.parse(
+      readFileSync(makeAbsolute(pKnownViolationsFileName), "utf-8")
+    );
+    // TODO: apparently node12 native coverage doesn't see this is covered with UT
+    //      (node 14 and 16 do), so c8 doesn't either. The ignore can be removed
+    //      once we stop supporting node 12
+    /* c8 ignore start */
+  } catch (pError) {
+    if (pError instanceof SyntaxError) {
+      throw new SyntaxError(
+        `'${pKnownViolationsFileName}' should be valid json\n          ${pError}`
+      );
+    }
+    throw pError;
+  }
+  /* c8 ignore stop */
+
+  // TODO: validate the json against the schme? (might be more clear to do it here,
+  // even if (in context of the cli) it's done again when validating the whole
+  // config
+};

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

@@ -19,24 +19,21 @@ function softenModuleViolation(
   };
 }
 
-// eslint-disable-next-line max-params
 function softenDependencyViolation(
-  pRule,
-  pModuleSource,
-  pDependencyResolved,
+  pViolationKey,
   pKnownDependencyViolations,
   pSoftenedSeverity
 ) {
   return {
-    ...pRule,
+    ...pViolationKey.rule,
     severity: pKnownDependencyViolations.some(
       (pKnownError) =>
-        pKnownError.from === pModuleSource &&
-        pKnownError.to === pDependencyResolved &&
-        pKnownError.rule.name === pRule.name
+        pKnownError.from === pViolationKey.from &&
+        pKnownError.to === pViolationKey.to &&
+        pKnownError.rule.name === pViolationKey.rule.name
     )
       ? pSoftenedSeverity
-      : pRule.severity,
+      : pViolationKey.rule.severity,
   };
 }
 
@@ -51,9 +48,7 @@ function softenDependencyViolations(
       ...pDependency,
       rules: pDependency.rules.map((pRule) =>
         softenDependencyViolation(
-          pRule,
-          pModuleSource,
-          pDependency.resolved,
+          { rule: pRule, from: pModuleSource, to: pDependency.resolved },
           pKnownDependencyViolations,
           pSoftenedSeverity
         )

package/src/enrich/summarize/summarize-modules.js

@@ -129,10 +129,10 @@ function extractModuleViolations(pModules, pRuleSet) {
 
 module.exports = function summarizeModules(pModules, pRuleSet) {
   const lViolations = deDuplicateViolations(
-    extractDependencyViolations(pModules, pRuleSet).concat(
-      extractModuleViolations(pModules, pRuleSet)
-    )
-  ).sort(compare.violations);
+    extractDependencyViolations(pModules, pRuleSet)
+      .concat(extractModuleViolations(pModules, pRuleSet))
+      .sort(compare.violations)
+  );
 
   return {
     violations: lViolations,

package/src/extract/gather-initial-sources.js

@@ -113,5 +113,6 @@ module.exports = function gatherInitialSources(
       } else {
         return pAll.concat(pathToPosix(pFileOrDirectory));
       }
-    }, []);
+    }, [])
+    .sort();
 };

package/src/meta.js

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

package/src/report/error.js

@@ -64,7 +64,7 @@ function formatSummary(pSummary) {
     pSummary
   )} dependency violations (${formatMeta(pSummary)}). ${
     pSummary.totalCruised
-  } modules, ${pSummary.totalDependenciesCruised} dependencies cruised.\n\n`;
+  } modules, ${pSummary.totalDependenciesCruised} dependencies cruised.\n`;
 
   return pSummary.error > 0 ? chalk.red(lMessage) : lMessage;
 }
@@ -82,6 +82,19 @@ function addExplanation(pRuleSet, pLong) {
     : (pViolation) => pViolation;
 }
 
+function formatIgnoreWarning(pViolations) {
+  const lIgnoredViolations = pViolations.filter(
+    (pViolation) => pViolation.rule.severity === "ignore"
+  );
+
+  if (lIgnoredViolations.length > 0) {
+    return chalk.yellow(
+      `${figures.warning} ${lIgnoredViolations.length} known violations ignored. Run without --ignore-known to see them.\n`
+    );
+  }
+  return "";
+}
+
 function report(pResults, pLong) {
   const lNonIgnorableViolations = pResults.summary.violations.filter(
     (pViolation) => pViolation.rule.severity !== "ignore"
@@ -92,14 +105,18 @@ function report(pResults, pLong) {
       pResults.summary.totalCruised
     } modules, ${
       pResults.summary.totalDependenciesCruised
-    } dependencies cruised)\n\n`;
+    } dependencies cruised)\n${formatIgnoreWarning(
+      pResults.summary.violations
+    )}\n\n`;
   }
 
   return lNonIgnorableViolations
     .reverse()
     .map(addExplanation(pResults.summary.ruleSetUsed, pLong))
     .reduce((pAll, pThis) => `${pAll}  ${formatViolation(pThis)}\n`, "\n")
-    .concat(formatSummary(pResults.summary));
+    .concat(formatSummary(pResults.summary))
+    .concat(formatIgnoreWarning(pResults.summary.violations))
+    .concat(`\n`);
 }
 
 /**