dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/report/anon/random-string.mjs

@@ -6,38 +6,38 @@ const UPPERCASE = 2;
 const NOTHING_SPECIAL = 3;
 
 function isSeparator(pChar) {
-  const lSeparatorsRe = /[-_.]/;
+	const lSeparatorsRe = /[-_.]/;
 
-  return lSeparatorsRe.test(pChar);
+	return lSeparatorsRe.test(pChar);
 }
 
 function isUpperCase(pChar) {
-  return pChar.toUpperCase() === pChar;
+	return pChar.toUpperCase() === pChar;
 }
 
 function classifyChar(pChar) {
-  if (/\d/.test(pChar)) return NUMBER;
-  if (isSeparator(pChar)) return SEPARATOR;
-  if (isUpperCase(pChar)) return UPPERCASE;
-  return NOTHING_SPECIAL;
+	if (/\d/.test(pChar)) return NUMBER;
+	if (isSeparator(pChar)) return SEPARATOR;
+	if (isUpperCase(pChar)) return UPPERCASE;
+	return NOTHING_SPECIAL;
 }
 
 function getRandomChar(pChar) {
-  const lLowerCaseChars = "abcdefghijklmnopqrstuvwxyz";
-  const lMaxDecimalChar = 9;
-
-  switch (classifyChar(pChar)) {
-    case SEPARATOR:
-      return pChar;
-    case NUMBER:
-      return randomInt(0, lMaxDecimalChar);
-    case UPPERCASE:
-      return lLowerCaseChars[
-        randomInt(0, lLowerCaseChars.length - 1)
-      ].toUpperCase();
-    default:
-      return lLowerCaseChars[randomInt(0, lLowerCaseChars.length - 1)];
-  }
+	const lLowerCaseChars = "abcdefghijklmnopqrstuvwxyz";
+	const lMaxDecimalChar = 9;
+
+	switch (classifyChar(pChar)) {
+		case SEPARATOR:
+			return pChar;
+		case NUMBER:
+			return randomInt(0, lMaxDecimalChar);
+		case UPPERCASE:
+			return lLowerCaseChars[
+				randomInt(0, lLowerCaseChars.length - 1)
+			].toUpperCase();
+		default:
+			return lLowerCaseChars[randomInt(0, lLowerCaseChars.length - 1)];
+	}
 }
 
 /**
@@ -54,5 +54,5 @@ function getRandomChar(pChar) {
  * @return {string} - a random string with above specs
  */
 export default function getRandomString(pString) {
-  return Array.from(pString).map(getRandomChar).join("");
+	return Array.from(pString).map(getRandomChar).join("");
 }

package/src/report/azure-devops.mjs

@@ -1,16 +1,15 @@
 import { EOL } from "node:os";
 import {
-  formatPercentage,
-  formatViolation as _formatViolation,
+	formatPercentage,
+	formatViolation as _formatViolation,
 } from "./utl/index.mjs";
 
 const SEVERITY2VSO_TYPE = new Map([
-  // "error" | "warn" | "info" | "ignore"
-  ["error", "error"],
-  ["warn", "warning"],
-  // azure devops doesn't seem to know 'info'. We still want to
-  // show them, though, hence:
-  ["info", "warning"],
+	["error", "error"],
+	["warn", "warning"],
+	// azure devops doesn't seem to know 'info'. We still want to
+	// show them, though, hence:
+	["info", "warning"],
 ]);
 
 /**
@@ -18,7 +17,7 @@ const SEVERITY2VSO_TYPE = new Map([
  * @returns {string}
  */
 function formatSeverity(pSeverity) {
-  return SEVERITY2VSO_TYPE.get(pSeverity) ?? "warning";
+	return SEVERITY2VSO_TYPE.get(pSeverity) ?? "warning";
 }
 
 /**
@@ -26,7 +25,7 @@ function formatSeverity(pSeverity) {
  * @returns {string}
  */
 function formatModuleViolation(pViolation) {
-  return pViolation.from;
+	return pViolation.from;
 }
 
 /**
@@ -34,7 +33,7 @@ function formatModuleViolation(pViolation) {
  * @returns {string}
  */
 function formatDependencyViolation(pViolation) {
-  return `${pViolation.from} -> ${pViolation.to}`;
+	return `${pViolation.from} -> ${pViolation.to}`;
 }
 
 /**
@@ -42,9 +41,9 @@ function formatDependencyViolation(pViolation) {
  * @returns {string}
  */
 function formatCycleViolation(pViolation) {
-  return `${pViolation.from} -> ${pViolation.cycle
-    .map(({ name }) => name)
-    .join(" -> ")}`;
+	return `${pViolation.from} -> ${pViolation.cycle
+		.map(({ name }) => name)
+		.join(" -> ")}`;
 }
 
 /**
@@ -52,9 +51,9 @@ function formatCycleViolation(pViolation) {
  * @returns {string}
  */
 function formatReachabilityViolation(pViolation) {
-  return `${pViolation.from} -> ${pViolation.to} (via ${pViolation.via
-    .map(({ name }) => name)
-    .join(" -> ")})`;
+	return `${pViolation.from} -> ${pViolation.to} (via ${pViolation.via
+		.map(({ name }) => name)
+		.join(" -> ")})`;
 }
 
 /**
@@ -62,11 +61,11 @@ function formatReachabilityViolation(pViolation) {
  * @returns {string}
  */
 function formatInstabilityViolation(pViolation) {
-  return `${pViolation.from} -> ${
-    pViolation.to
-  } (instability: ${formatPercentage(
-    pViolation.metrics.from.instability,
-  )} -> ${formatPercentage(pViolation.metrics.to.instability)})`;
+	return `${pViolation.from} -> ${
+		pViolation.to
+	} (instability: ${formatPercentage(
+		pViolation.metrics.from.instability,
+	)} -> ${formatPercentage(pViolation.metrics.to.instability)})`;
 }
 
 /**
@@ -74,23 +73,23 @@ function formatInstabilityViolation(pViolation) {
  * @returns {string}
  */
 function formatViolation(pViolation) {
-  const lViolationType2Formatter = {
-    module: formatModuleViolation,
-    dependency: formatDependencyViolation,
-    cycle: formatCycleViolation,
-    reachability: formatReachabilityViolation,
-    instability: formatInstabilityViolation,
-  };
-  let lFormattedViolators = _formatViolation(
-    pViolation,
-    lViolationType2Formatter,
-    formatDependencyViolation,
-  );
-  return `##vso[task.logissue type=${formatSeverity(
-    pViolation.rule.severity,
-  )};sourcepath=${pViolation.from};code=${
-    pViolation.rule.name
-  };]${lFormattedViolators}${EOL}`;
+	const lViolationType2Formatter = {
+		module: formatModuleViolation,
+		dependency: formatDependencyViolation,
+		cycle: formatCycleViolation,
+		reachability: formatReachabilityViolation,
+		instability: formatInstabilityViolation,
+	};
+	let lFormattedViolators = _formatViolation(
+		pViolation,
+		lViolationType2Formatter,
+		formatDependencyViolation,
+	);
+	return `##vso[task.logissue type=${formatSeverity(
+		pViolation.rule.severity,
+	)};sourcepath=${pViolation.from};code=${
+		pViolation.rule.name
+	};]${lFormattedViolators}${EOL}`;
 }
 
 /**
@@ -99,7 +98,7 @@ function formatViolation(pViolation) {
  * @returns {string}
  */
 function formatResultStatus(pNumberOfErrors) {
-  return pNumberOfErrors > 0 ? "Failed" : "Succeeded";
+	return pNumberOfErrors > 0 ? "Failed" : "Succeeded";
 }
 
 /**
@@ -107,16 +106,16 @@ function formatResultStatus(pNumberOfErrors) {
  * @returns {string}
  */
 function formatMeta(pMeta) {
-  const lWarningCount = pMeta.warn + pMeta.info;
-  const lError = `${pMeta.error} error`;
-  const lWarn = `${lWarningCount} warning/ informational`;
-  const lIgnore = (pMeta?.ignore ?? 0) > 0 ? `, ${pMeta.ignore} ignored` : "";
+	const lWarningCount = pMeta.warn + pMeta.info;
+	const lError = `${pMeta.error} error`;
+	const lWarn = `${lWarningCount} warning/ informational`;
+	const lIgnore = (pMeta?.ignore ?? 0) > 0 ? `, ${pMeta.ignore} ignored` : "";
 
-  return `${lError}, ${lWarn}${lIgnore}`;
+	return `${lError}, ${lWarn}${lIgnore}`;
 }
 
 function sumMeta(pMeta) {
-  return pMeta.error + pMeta.warn + pMeta.info;
+	return pMeta.error + pMeta.warn + pMeta.info;
 }
 
 /**
@@ -124,9 +123,9 @@ function sumMeta(pMeta) {
  * @returns {string}
  */
 function formatIgnoreWarning(pNumberOfIgnored) {
-  return (pNumberOfIgnored ?? 0) > 0
-    ? ` - ${pNumberOfIgnored} violations ignored `
-    : "";
+	return (pNumberOfIgnored ?? 0) > 0
+		? ` - ${pNumberOfIgnored} violations ignored `
+		: "";
 }
 
 /**
@@ -134,19 +133,19 @@ function formatIgnoreWarning(pNumberOfIgnored) {
  * @returns {string}
  */
 function formatResultMessage(pSummary) {
-  let lStatSummary = `${pSummary.totalCruised} modules, ${
-    pSummary?.totalDependenciesCruised ?? 0
-  } dependencies cruised`;
-
-  if (sumMeta(pSummary) > 0) {
-    return `${sumMeta(pSummary)} dependency violations (${formatMeta(
-      pSummary,
-    )}). ${lStatSummary}`;
-  } else {
-    return `no dependency violations found${formatIgnoreWarning(
-      pSummary.ignore,
-    )} (${lStatSummary})`;
-  }
+	let lStatSummary = `${pSummary.totalCruised} modules, ${
+		pSummary?.totalDependenciesCruised ?? 0
+	} dependencies cruised`;
+
+	if (sumMeta(pSummary) > 0) {
+		return `${sumMeta(pSummary)} dependency violations (${formatMeta(
+			pSummary,
+		)}). ${lStatSummary}`;
+	} else {
+		return `no dependency violations found${formatIgnoreWarning(
+			pSummary.ignore,
+		)} (${lStatSummary})`;
+	}
 }
 
 /**
@@ -154,9 +153,9 @@ function formatResultMessage(pSummary) {
  * @returns {string}
  */
 function formatSummary(pSummary) {
-  return `##vso[task.complete result=${formatResultStatus(
-    pSummary.error,
-  )};]${formatResultMessage(pSummary)}${EOL}`;
+	return `##vso[task.complete result=${formatResultStatus(
+		pSummary.error,
+	)};]${formatResultMessage(pSummary)}${EOL}`;
 }
 
 /**
@@ -172,38 +171,15 @@ function formatSummary(pSummary) {
  */
 // eslint-disable-next-line unicorn/prevent-abbreviations
 export default function azureDevOps(pResults) {
-  const lViolations = (pResults?.summary?.violations ?? []).filter(
-    (pViolation) => pViolation.rule.severity !== "ignore",
-  );
-
-  return {
-    output: lViolations
-      .map(formatViolation)
-      .join("")
-      .concat(formatSummary(pResults.summary)),
-    exitCode: pResults.summary.error,
-  };
+	const lViolations = (pResults?.summary?.violations ?? []).filter(
+		(pViolation) => pViolation.rule.severity !== "ignore",
+	);
+
+	return {
+		output: lViolations
+			.map(formatViolation)
+			.join("")
+			.concat(formatSummary(pResults.summary)),
+		exitCode: pResults.summary.error,
+	};
 }
-
-/*
-Some notes from the documentation over at https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#task-commands
-
-Warnings and errors:
-
-##vso[task.logissue type=warning;sourcepath=consoleapp/main.cs;linenumber=1;columnnumber=1;code=100;]Found something that could be a problem.
-
-Progress
-##vso[task.setprogress]current operation
-
-Complete
-##vso[task.complete]current operation
-
-Message grouping
-##[group]Beginning of a group
-##[warning]Warning message
-##[error]Error message
-##[section]Start of a section
-##[debug]Debug text
-##[command]Command-line being run
-##[endgroup]
-*/

package/src/report/baseline.mjs

@@ -12,13 +12,13 @@ const EOL = "\n";
  *      exitCode: 0
  */
 export default function baseline(pCruiseResult) {
-  return {
-    output:
-      JSON.stringify(
-        pCruiseResult.summary.violations,
-        null,
-        DEFAULT_JSON_INDENT,
-      ) + EOL,
-    exitCode: 0,
-  };
+	return {
+		output:
+			JSON.stringify(
+				pCruiseResult.summary.violations,
+				null,
+				DEFAULT_JSON_INDENT,
+			) + EOL,
+		exitCode: 0,
+	};
 }

package/src/report/csv.mjs

@@ -2,24 +2,24 @@ import { EOL } from "node:os";
 import dependencyToIncidenceTransformer from "./utl/dependency-to-incidence-transformer.mjs";
 
 function renderHeader(pModules) {
-  return pModules.map((pModule) => `"${pModule.source}"`).join(",");
+	return pModules.map((pModule) => `"${pModule.source}"`).join(",");
 }
 
 function mapIncidences(pIncidences) {
-  return pIncidences.map((pIncidence) => `"${pIncidence.incidence}"`).join(",");
+	return pIncidences.map((pIncidence) => `"${pIncidence.incidence}"`).join(",");
 }
 
 function renderBody(pModules) {
-  return pModules
-    .map(
-      (pModule) =>
-        `"${pModule.source}",${mapIncidences(pModule.incidences)},""`,
-    )
-    .join(EOL);
+	return pModules
+		.map(
+			(pModule) =>
+				`"${pModule.source}",${mapIncidences(pModule.incidences)},""`,
+		)
+		.join(EOL);
 }
 
 function report(pModules) {
-  return `"",${renderHeader(pModules)},""${EOL}${renderBody(pModules)}${EOL}`;
+	return `"",${renderHeader(pModules)},""${EOL}${renderBody(pModules)}${EOL}`;
 }
 
 /**
@@ -30,8 +30,8 @@ function report(pModules) {
  * @returns {import("../../types/dependency-cruiser.js").IReporterOutput}
  */
 export default function csv(pResults) {
-  return {
-    output: report(dependencyToIncidenceTransformer(pResults.modules)),
-    exitCode: 0,
-  };
+	return {
+		output: report(dependencyToIncidenceTransformer(pResults.modules)),
+		exitCode: 0,
+	};
 }

package/src/report/d2.mjs

@@ -3,9 +3,9 @@ import { basename, dirname } from "node:path";
 import { getURLForModule } from "./utl/index.mjs";
 
 const severity2color = new Map([
-  ["error", "red"],
-  ["warn", "orange"],
-  ["info", "blue"],
+	["error", "red"],
+	["warn", "orange"],
+	["info", "blue"],
 ]);
 
 /**
@@ -13,21 +13,21 @@ const severity2color = new Map([
  * @returns {string}
  */
 function getMaxSeverity(pRules) {
-  const lSeverity2Number = new Map([
-    // eslint-disable-next-line no-magic-numbers
-    ["error", 3],
-    // eslint-disable-next-line no-magic-numbers
-    ["warn", 2],
-    ["info", 1],
-  ]);
-  return pRules
-    .map((pRule) => pRule.severity)
-    .reduce((pMax, pCurrent) => {
-      return (lSeverity2Number.get(pMax) ?? 0) >
-        (lSeverity2Number.get(pCurrent) ?? 0)
-        ? pMax
-        : pCurrent;
-    });
+	const lSeverity2Number = new Map([
+		// eslint-disable-next-line no-magic-numbers
+		["error", 3],
+		// eslint-disable-next-line no-magic-numbers
+		["warn", 2],
+		["info", 1],
+	]);
+	return pRules
+		.map((pRule) => pRule.severity)
+		.reduce((pMax, pCurrent) => {
+			return (lSeverity2Number.get(pMax) ?? 0) >
+				(lSeverity2Number.get(pCurrent) ?? 0)
+				? pMax
+				: pCurrent;
+		});
 }
 
 /**
@@ -35,15 +35,15 @@ function getMaxSeverity(pRules) {
  * @return {string}
  */
 function getVertexName(pSource) {
-  const lFolderName = dirname(pSource)
-    .split("/")
-    .map((pPart) => `"${pPart}"`)
-    .join(".");
-  const lBaseName = `"${basename(pSource)}"`;
-  if (lFolderName === `"."`) {
-    return lBaseName;
-  }
-  return `${lFolderName}.${lBaseName}`;
+	const lFolderName = dirname(pSource)
+		.split("/")
+		.map((pPart) => `"${pPart}"`)
+		.join(".");
+	const lBaseName = `"${basename(pSource)}"`;
+	if (lFolderName === `"."`) {
+		return lBaseName;
+	}
+	return `${lFolderName}.${lBaseName}`;
 }
 
 /**
@@ -54,38 +54,38 @@ function getVertexName(pSource) {
 
 // eslint-disable-next-line complexity
 function getModuleAttributes(pModule, pOptions) {
-  let lReturnValue = "class: module";
-  if (pModule.consolidated) {
-    lReturnValue = `${lReturnValue}; style.multiple: true`;
-  }
-  if (
-    pModule.matchesFocus ||
-    pModule.matchesHighlight ||
-    pModule.matchesReaches
-  ) {
-    lReturnValue = `${lReturnValue}; style.fill: yellow`;
-  }
-  if (pModule.valid === false) {
-    lReturnValue = `${lReturnValue}; style.stroke: ${
-      severity2color.get(getMaxSeverity(pModule.rules)) ?? "orange"
-    }`;
-    lReturnValue = `${lReturnValue}; tooltip: "${pModule.rules
-      .map((pRule) => pRule.name)
-      .join("\\n")}"`;
-  }
-  if (
-    pModule.dependencyTypes?.some((pDependencyType) =>
-      pDependencyType.includes("npm"),
-    )
-  ) {
-    lReturnValue = `${lReturnValue}; shape: package`;
-  }
-  lReturnValue = `${lReturnValue}; link: "${getURLForModule(
-    pModule,
-    pOptions?.prefix,
-    pOptions?.suffix,
-  )}"`;
-  return lReturnValue;
+	let lReturnValue = "class: module";
+	if (pModule.consolidated) {
+		lReturnValue = `${lReturnValue}; style.multiple: true`;
+	}
+	if (
+		pModule.matchesFocus ||
+		pModule.matchesHighlight ||
+		pModule.matchesReaches
+	) {
+		lReturnValue = `${lReturnValue}; style.fill: yellow`;
+	}
+	if (pModule.valid === false) {
+		lReturnValue = `${lReturnValue}; style.stroke: ${
+			severity2color.get(getMaxSeverity(pModule.rules)) ?? "orange"
+		}`;
+		lReturnValue = `${lReturnValue}; tooltip: "${pModule.rules
+			.map((pRule) => pRule.name)
+			.join("\\n")}"`;
+	}
+	if (
+		pModule.dependencyTypes?.some((pDependencyType) =>
+			pDependencyType.includes("npm"),
+		)
+	) {
+		lReturnValue = `${lReturnValue}; shape: package`;
+	}
+	lReturnValue = `${lReturnValue}; link: "${getURLForModule(
+		pModule,
+		pOptions?.prefix,
+		pOptions?.suffix,
+	)}"`;
+	return lReturnValue;
 }
 
 /**
@@ -94,25 +94,25 @@ function getModuleAttributes(pModule, pOptions) {
  */
 
 function getDependencyAttributes(pDependency) {
-  let lThing = "";
-  if (pDependency.valid === false) {
-    lThing =
-      `style: {stroke: ${
-        severity2color.get(getMaxSeverity(pDependency.rules)) ?? "orange"
-      }}; ` +
-      `label: "${pDependency.rules.map((pRule) => pRule.name).join("\\n")}"`;
-  }
-  if (pDependency.circular) {
-    lThing = `${
-      lThing ? `${lThing};` : lThing
-    } target-arrowhead: {shape: circle}`;
-  }
-  if (pDependency.dynamic) {
-    lThing = `${
-      lThing ? `${lThing};` : lThing
-    } target-arrowhead: {shape: arrow}`;
-  }
-  return lThing ? `: {${lThing}}` : lThing;
+	let lThing = "";
+	if (pDependency.valid === false) {
+		lThing =
+			`style: {stroke: ${
+				severity2color.get(getMaxSeverity(pDependency.rules)) ?? "orange"
+			}}; ` +
+			`label: "${pDependency.rules.map((pRule) => pRule.name).join("\\n")}"`;
+	}
+	if (pDependency.circular) {
+		lThing = `${
+			lThing ? `${lThing};` : lThing
+		} target-arrowhead: {shape: circle}`;
+	}
+	if (pDependency.dynamic) {
+		lThing = `${
+			lThing ? `${lThing};` : lThing
+		} target-arrowhead: {shape: arrow}`;
+	}
+	return lThing ? `: {${lThing}}` : lThing;
 }
 
 /**
@@ -120,34 +120,34 @@ function getDependencyAttributes(pDependency) {
  * @return {string}
  */
 function renderD2Source(pCruiseResult) {
-  const lVertices = pCruiseResult.modules
-    .map((pModule) => {
-      return `${getVertexName(pModule.source)}: {${getModuleAttributes(
-        pModule,
-        pCruiseResult.summary.optionsUsed,
-      )}}`;
-    })
-    .join(EOL);
-  const lEdges = pCruiseResult.modules
-    .flatMap((pModule) => {
-      return pModule.dependencies.map((pDependency) => {
-        return `${getVertexName(pModule.source)} -> ${getVertexName(
-          pDependency.resolved,
-        )}${getDependencyAttributes(pDependency)}`;
-      });
-    })
-    .join(EOL);
-  const lStyles = `classes: {
+	const lVertices = pCruiseResult.modules
+		.map((pModule) => {
+			return `${getVertexName(pModule.source)}: {${getModuleAttributes(
+				pModule,
+				pCruiseResult.summary.optionsUsed,
+			)}}`;
+		})
+		.join(EOL);
+	const lEdges = pCruiseResult.modules
+		.flatMap((pModule) => {
+			return pModule.dependencies.map((pDependency) => {
+				return `${getVertexName(pModule.source)} -> ${getVertexName(
+					pDependency.resolved,
+				)}${getDependencyAttributes(pDependency)}`;
+			});
+		})
+		.join(EOL);
+	const lStyles = `classes: {
   module: {
     height: 30;
     style.border-radius: 10;
   }
 }`;
-  return (
-    `# modules${EOL}${EOL}${lVertices}${EOL}${EOL}` +
-    `# dependencies${EOL}${EOL}${lEdges}${EOL}${EOL}` +
-    `# styling${EOL}${EOL}${lStyles}${EOL}`
-  );
+	return (
+		`# modules${EOL}${EOL}${lVertices}${EOL}${EOL}` +
+		`# dependencies${EOL}${EOL}${lEdges}${EOL}${EOL}` +
+		`# styling${EOL}${EOL}${lStyles}${EOL}`
+	);
 }
 /**
  * d2 reporter
@@ -156,8 +156,8 @@ function renderD2Source(pCruiseResult) {
  * @return {import('../../types/dependency-cruiser').IReporterOutput}
  */
 export default function d2(pCruiseResult) {
-  return {
-    output: renderD2Source(pCruiseResult),
-    exitCode: 0,
-  };
+	return {
+		output: renderD2Source(pCruiseResult),
+		exitCode: 0,
+	};
 }