dependency-cruiser 10.6.0 → 10.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.6.0",
+  "version": "10.7.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -170,7 +170,7 @@
     "eslint": "^7.32.0",
     "eslint-config-moving-meadow": "2.0.9",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-budapestian": "2.3.0",
+    "eslint-plugin-budapestian": "3.0.1",
     "eslint-plugin-import": "2.25.2",
     "eslint-plugin-mocha": "9.0.0",
     "eslint-plugin-node": "11.1.0",
@@ -199,11 +199,6 @@
         "policy": "wanted",
         "because": "some eslint plugins (eslint-plugin-budapestian) are not compatible with eslint 8 yet "
       },
-      {
-        "package": "eslint-plugin-budapestian",
-        "policy": "pin",
-        "because": "eslint-plugin-budapestian 3.0.0 is a bit too enthousiastic flagging things it shouldn't - keeping at 2.3.0 for the time being"
-      },
       {
         "package": "figures",
         "policy": "wanted",

package/src/cli/validate-node-environment.js

@@ -5,7 +5,7 @@ module.exports = function validateNodeEnvironment(pNodeVersion) {
   // not using default parameter here because the check should run
   // run on node 4 as well
   const lNodeVersion = pNodeVersion || process.versions.node;
-  const VERSION_ERR = `\nERROR: Your node version (${lNodeVersion}) is not supported. dependency-cruiser
+  const lVersionError = `\nERROR: Your node version (${lNodeVersion}) is not supported. dependency-cruiser
        follows the node.js release cycle and runs on these node versions:
        ${engines.node}
        See https://nodejs.org/en/about/releases/ for details.
@@ -13,6 +13,6 @@ module.exports = function validateNodeEnvironment(pNodeVersion) {
 `;
 
   if (!satisfies(lNodeVersion, engines.node)) {
-    throw new Error(VERSION_ERR);
+    throw new Error(lVersionError);
   }
 };

package/src/main/options/normalize.js

@@ -54,12 +54,12 @@ function normalizeFilterOptions(pOptions, pFilterOptionKeys) {
 function normalizeCollapse(pCollapse) {
   let lReturnValue = pCollapse;
   const lOneOrMoreNonSlashes = "[^/]+";
-  const FOLDER_PATTERN = `${lOneOrMoreNonSlashes}/`;
-  const FOLDER_BELOW_NODE_MODULES = `node_modules/${lOneOrMoreNonSlashes}`;
+  const lFolderPattern = `${lOneOrMoreNonSlashes}/`;
+  const lFolderBelowNodeModules = `node_modules/${lOneOrMoreNonSlashes}`;
   const lSingleDigitRe = /^\d$/;
 
   if (typeof pCollapse === "number" || pCollapse.match(lSingleDigitRe)) {
-    lReturnValue = `${FOLDER_BELOW_NODE_MODULES}|^${FOLDER_PATTERN.repeat(
+    lReturnValue = `${lFolderBelowNodeModules}|^${lFolderPattern.repeat(
       Number.parseInt(pCollapse, 10)
     )}`;
   }

package/src/meta.js

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

package/src/report/teamcity.js

@@ -45,10 +45,26 @@ function reportAllowedRule(pAllowedRule, pViolations) {
   return lReturnValue;
 }
 
-function reportViolatedRules(pRuleSetUsed, pViolations) {
+function reportIgnoredRules(pIgnoredCount) {
+  let lReturnValue = [];
+
+  if (pIgnoredCount > 0) {
+    lReturnValue = tsm.inspectionType({
+      id: "ignored-known-violations",
+      name: "ignored-known-violations",
+      description:
+        "some dependency violations were ignored; run without --ignore-known to see them",
+      category: CATEGORY,
+    });
+  }
+  return lReturnValue;
+}
+
+function reportViolatedRules(pRuleSetUsed, pViolations, pIgnoredCount) {
   return reportRules(_get(pRuleSetUsed, "forbidden", []), pViolations)
     .concat(reportAllowedRule(_get(pRuleSetUsed, "allowed", []), pViolations))
-    .concat(reportRules(_get(pRuleSetUsed, "required", []), pViolations));
+    .concat(reportRules(_get(pRuleSetUsed, "required", []), pViolations))
+    .concat(reportIgnoredRules(pIgnoredCount));
 }
 
 function determineTo(pViolation) {
@@ -66,15 +82,31 @@ function bakeViolationMessage(pViolation) {
     ? pViolation.from
     : `${pViolation.from} -> ${determineTo(pViolation)}`;
 }
-function reportViolations(pViolations) {
-  return pViolations.map((pViolation) =>
-    tsm.inspection({
-      typeId: pViolation.rule.name,
-      message: bakeViolationMessage(pViolation),
-      file: pViolation.from,
-      SEVERITY: severity2teamcitySeverity(pViolation.rule.severity),
-    })
-  );
+
+function reportIgnoredViolation(pIgnoredCount) {
+  let lReturnValue = [];
+
+  if (pIgnoredCount > 0) {
+    lReturnValue = tsm.inspection({
+      typeId: "ignored-known-violations",
+      message: `${pIgnoredCount} known violations ignored. Run without --ignore-known to see them.`,
+      SEVERITY: "WARNING",
+    });
+  }
+  return lReturnValue;
+}
+
+function reportViolations(pViolations, pIgnoredCount) {
+  return pViolations
+    .map((pViolation) =>
+      tsm.inspection({
+        typeId: pViolation.rule.name,
+        message: bakeViolationMessage(pViolation),
+        file: pViolation.from,
+        SEVERITY: severity2teamcitySeverity(pViolation.rule.severity),
+      })
+    )
+    .concat(reportIgnoredViolation(pIgnoredCount));
 }
 
 /**
@@ -96,11 +128,14 @@ module.exports = (pResults) => {
   tsm.stdout = false;
 
   const lRuleSet = _get(pResults, "summary.ruleSetUsed", []);
-  const lViolations = _get(pResults, "summary.violations", []);
+  const lViolations = _get(pResults, "summary.violations", []).filter(
+    (pViolation) => pViolation.rule.severity !== "ignore"
+  );
+  const lIgnoredCount = _get(pResults, "summary.ignore", 0);
 
   return {
-    output: reportViolatedRules(lRuleSet, lViolations)
-      .concat(reportViolations(lViolations))
+    output: reportViolatedRules(lRuleSet, lViolations, lIgnoredCount)
+      .concat(reportViolations(lViolations, lIgnoredCount))
       .reduce((pAll, pCurrent) => `${pAll}${pCurrent}\n`, ""),
     exitCode: pResults.summary.error,
   };

package/src/utl/wrap-and-indent.js

@@ -4,7 +4,7 @@ const wrapAnsi = require("wrap-ansi");
 const DEFAULT_INDENT = 4;
 module.exports = function wrapAndIndent(pString, pIndent = DEFAULT_INDENT) {
   const lDogmaticMaxConsoleWidth = 78;
-  const MAX_WIDTH = lDogmaticMaxConsoleWidth - pIndent;
+  const lMaxWidth = lDogmaticMaxConsoleWidth - pIndent;
 
-  return indentString(wrapAnsi(pString, MAX_WIDTH), pIndent);
+  return indentString(wrapAnsi(pString, lMaxWidth), pIndent);
 };