dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/report/markdown.mjs

@@ -1,34 +1,34 @@
 import {
-  aggregateViolations,
-  determineTo,
-  determineFromExtras,
+	aggregateViolations,
+	determineTo,
+	determineFromExtras,
 } from "./error-html/utl.mjs";
 import meta from "#meta.cjs";
 
 const REPORT_DEFAULTS = {
-  showTitle: true,
-  title: "## Forbidden dependency check - results",
-
-  showSummary: true,
-  showSummaryHeader: true,
-  summaryHeader: "### :chart_with_upwards_trend: Summary",
-  showStatsSummary: true,
-  showRulesSummary: true,
-  includeIgnoredInSummary: true,
-
-  showDetails: true,
-  includeIgnoredInDetails: true,
-  showDetailsHeader: true,
-  detailsHeader: "### :fire: All violations",
-  collapseDetails: true,
-  collapsedMessage: "Violations found - click to expand",
-  noViolationsMessage:
-    ":revolving_hearts: No violations found. Get gummy bears to celebrate.",
-
-  showFooter: true,
-  footer: `---\n[dependency-cruiser@${
-    meta.version
-  }](https://www.github.com/sverweij/dependency-cruiser) / ${new Date().toISOString()}`,
+	showTitle: true,
+	title: "## Forbidden dependency check - results",
+
+	showSummary: true,
+	showSummaryHeader: true,
+	summaryHeader: "### :chart_with_upwards_trend: Summary",
+	showStatsSummary: true,
+	showRulesSummary: true,
+	includeIgnoredInSummary: true,
+
+	showDetails: true,
+	includeIgnoredInDetails: true,
+	showDetailsHeader: true,
+	detailsHeader: "### :fire: All violations",
+	collapseDetails: true,
+	collapsedMessage: "Violations found - click to expand",
+	noViolationsMessage:
+		":revolving_hearts: No violations found. Get gummy bears to celebrate.",
+
+	showFooter: true,
+	footer: `---\n[dependency-cruiser@${
+		meta.version
+	}](https://www.github.com/sverweij/dependency-cruiser) / ${new Date().toISOString()}`,
 };
 
 /**
@@ -36,13 +36,13 @@ const REPORT_DEFAULTS = {
  * @returns {string}
  */
 function severity2Icon(pSeverity) {
-  const lSeverity2IconMap = new Map([
-    ["error", ":exclamation:"],
-    ["info", ":grey_exclamation:"],
-    ["ignore", ":see_no_evil:"],
-  ]);
+	const lSeverity2IconMap = new Map([
+		["error", ":exclamation:"],
+		["info", ":grey_exclamation:"],
+		["ignore", ":see_no_evil:"],
+	]);
 
-  return lSeverity2IconMap.get(pSeverity) || ":warning:";
+	return lSeverity2IconMap.get(pSeverity) || ":warning:";
 }
 
 /**
@@ -50,9 +50,9 @@ function severity2Icon(pSeverity) {
  * @return {string}
  */
 function formatStatsSummary(pSummary) {
-  const lSpacerLength = 4;
-  const lSpacer = " ".repeat(lSpacerLength);
-  return `**${pSummary.totalCruised}** modules${lSpacer}**${pSummary.totalDependenciesCruised}** dependencies${lSpacer}**${pSummary.error}** errors${lSpacer}**${pSummary.warn}** warnings${lSpacer}**${pSummary.info}** informational${lSpacer}**${pSummary.ignore}** ignored\n`;
+	const lSpacerLength = 4;
+	const lSpacer = " ".repeat(lSpacerLength);
+	return `**${pSummary.totalCruised}** modules${lSpacer}**${pSummary.totalDependenciesCruised}** dependencies${lSpacer}**${pSummary.error}** errors${lSpacer}**${pSummary.warn}** warnings${lSpacer}**${pSummary.info}** informational${lSpacer}**${pSummary.ignore}** ignored\n`;
 }
 
 /**
@@ -61,24 +61,24 @@ function formatStatsSummary(pSummary) {
  * @return {string}
  */
 function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
-  const lTableHead =
-    "|rule|violations|ignored|explanation\n|:---|:---:|:---:|:---|\n";
-
-  return aggregateViolations(
-    pCruiseResult.summary.violations,
-    pCruiseResult.summary.ruleSetUsed,
-  )
-    .filter(
-      (pRule) =>
-        pRule.count > 0 || (pIncludeIgnoredInSummary && pRule.ignoredCount > 0),
-    )
-    .reduce(
-      (pAll, pRule) =>
-        `${pAll}|${severity2Icon(pRule.severity)} _${pRule.name}_|**${
-          pRule.count
-        }**|**${pRule.ignoredCount}**|${pRule.comment}|\n`,
-      lTableHead,
-    );
+	const lTableHead =
+		"|rule|violations|ignored|explanation\n|:---|:---:|:---:|:---|\n";
+
+	return aggregateViolations(
+		pCruiseResult.summary.violations,
+		pCruiseResult.summary.ruleSetUsed,
+	)
+		.filter(
+			(pRule) =>
+				pRule.count > 0 || (pIncludeIgnoredInSummary && pRule.ignoredCount > 0),
+		)
+		.reduce(
+			(pAll, pRule) =>
+				`${pAll}|${severity2Icon(pRule.severity)} _${pRule.name}_|**${
+					pRule.count
+				}**|**${pRule.ignoredCount}**|${pRule.comment}|\n`,
+			lTableHead,
+		);
 }
 
 /**
@@ -88,60 +88,60 @@ function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
  * @return {string}
  */
 function formatViolations(pViolations, pIncludeIgnoredInDetails) {
-  const lTableHead = "|violated rule|module|to|\n|:---|:---|:---|\n";
-
-  return pViolations
-    .filter(
-      (pViolation) =>
-        pViolation.rule.severity !== "ignore" || pIncludeIgnoredInDetails,
-    )
-    .reduce((pAll, pViolation) => {
-      const lFromExtras = determineFromExtras(pViolation);
-      const lTo = determineTo(pViolation);
-
-      return `${pAll}|${severity2Icon(pViolation.rule.severity)} _${
-        pViolation.rule.name
-      }_|${pViolation.from}${lFromExtras}|${lTo}|\n`;
-    }, lTableHead);
+	const lTableHead = "|violated rule|module|to|\n|:---|:---|:---|\n";
+
+	return pViolations
+		.filter(
+			(pViolation) =>
+				pViolation.rule.severity !== "ignore" || pIncludeIgnoredInDetails,
+		)
+		.reduce((pAll, pViolation) => {
+			const lFromExtras = determineFromExtras(pViolation);
+			const lTo = determineTo(pViolation);
+
+			return `${pAll}|${severity2Icon(pViolation.rule.severity)} _${
+				pViolation.rule.name
+			}_|${pViolation.from}${lFromExtras}|${lTo}|\n`;
+		}, lTableHead);
 }
 
 function details(pResults, pOptions) {
-  let lReturnValue = "";
-  if (pResults.summary.violations.length > 0) {
-    if (pOptions.showDetailsHeader) {
-      lReturnValue += `${pOptions.detailsHeader}\n\n`;
-    }
-    if (pOptions.collapseDetails) {
-      lReturnValue += `<details><summary>${pOptions.collapsedMessage}</summary>\n\n`;
-    }
-    lReturnValue += `${formatViolations(
-      pResults.summary.violations,
-      pOptions.includeIgnoredInDetails,
-    )}\n\n`;
-    if (pOptions.collapseDetails) {
-      lReturnValue += "</details>\n\n";
-    }
-  } else {
-    lReturnValue += `${pOptions.noViolationsMessage}\n\n`;
-  }
-  return lReturnValue;
+	let lReturnValue = "";
+	if (pResults.summary.violations.length > 0) {
+		if (pOptions.showDetailsHeader) {
+			lReturnValue += `${pOptions.detailsHeader}\n\n`;
+		}
+		if (pOptions.collapseDetails) {
+			lReturnValue += `<details><summary>${pOptions.collapsedMessage}</summary>\n\n`;
+		}
+		lReturnValue += `${formatViolations(
+			pResults.summary.violations,
+			pOptions.includeIgnoredInDetails,
+		)}\n\n`;
+		if (pOptions.collapseDetails) {
+			lReturnValue += "</details>\n\n";
+		}
+	} else {
+		lReturnValue += `${pOptions.noViolationsMessage}\n\n`;
+	}
+	return lReturnValue;
 }
 
 function summary(pResults, pOptions) {
-  let lReturnValue = "";
-
-  if (pOptions.showSummaryHeader) {
-    lReturnValue += `${pOptions.summaryHeader}\n\n`;
-  }
-  lReturnValue += `${formatStatsSummary(pResults.summary)}\n\n`;
-
-  if (pResults.summary.violations.length > 0 && pOptions.showRulesSummary) {
-    lReturnValue += `${formatRulesSummary(
-      pResults,
-      pOptions.includeIgnoredInSummary,
-    )}\n\n`;
-  }
-  return lReturnValue;
+	let lReturnValue = "";
+
+	if (pOptions.showSummaryHeader) {
+		lReturnValue += `${pOptions.summaryHeader}\n\n`;
+	}
+	lReturnValue += `${formatStatsSummary(pResults.summary)}\n\n`;
+
+	if (pResults.summary.violations.length > 0 && pOptions.showRulesSummary) {
+		lReturnValue += `${formatRulesSummary(
+			pResults,
+			pOptions.includeIgnoredInSummary,
+		)}\n\n`;
+	}
+	return lReturnValue;
 }
 
 /**
@@ -150,26 +150,26 @@ function summary(pResults, pOptions) {
  * @returns {string}
  */
 function report(pResults, pOptions) {
-  const lOptions = { ...REPORT_DEFAULTS, ...(pOptions || {}) };
-  let lReturnValue = "";
+	const lOptions = { ...REPORT_DEFAULTS, ...(pOptions || {}) };
+	let lReturnValue = "";
 
-  if (lOptions.showTitle) {
-    lReturnValue += `${lOptions.title}\n\n`;
-  }
+	if (lOptions.showTitle) {
+		lReturnValue += `${lOptions.title}\n\n`;
+	}
 
-  if (lOptions.showSummary) {
-    lReturnValue += summary(pResults, lOptions);
-  }
+	if (lOptions.showSummary) {
+		lReturnValue += summary(pResults, lOptions);
+	}
 
-  if (lOptions.showDetails) {
-    lReturnValue += details(pResults, lOptions);
-  }
+	if (lOptions.showDetails) {
+		lReturnValue += details(pResults, lOptions);
+	}
 
-  if (lOptions.showFooter) {
-    lReturnValue += `${lOptions.footer}\n\n`;
-  }
+	if (lOptions.showFooter) {
+		lReturnValue += `${lOptions.footer}\n\n`;
+	}
 
-  return lReturnValue;
+	return lReturnValue;
 }
 
 /**
@@ -180,8 +180,8 @@ function report(pResults, pOptions) {
  * @returns {import("../../types/dependency-cruiser.js").IReporterOutput}
  */
 export default function markdown(pResults, pOptions) {
-  return {
-    output: report(pResults, pOptions),
-    exitCode: 0,
-  };
+	return {
+		output: report(pResults, pOptions),
+		exitCode: 0,
+	};
 }

package/src/report/mermaid.mjs

@@ -1,61 +1,61 @@
 /* eslint-disable security/detect-object-injection */
 const ACORN_DUMMY_VALUE = "✖";
 const REPORT_DEFAULTS = {
-  minify: true,
+	minify: true,
 };
 
 const renderNode = (pNode, pText) =>
-  `${pNode}["${pText.length > 0 ? pText : " "}"]`;
+	`${pNode}["${pText.length > 0 ? pText : " "}"]`;
 
 const renderEdge = (pFrom, pTo) => `${pFrom.node}-->${pTo.node}`;
 
 const renderEdges = (pEdges) =>
-  pEdges.map((pEdge) => renderEdge(pEdge.from, pEdge.to)).join("\n");
+	pEdges.map((pEdge) => renderEdge(pEdge.from, pEdge.to)).join("\n");
 
 /**
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
  * @param {Map<string, string>} pNamesHashMap
  */
 function convertEdgeSources(pCruiseResult, pNamesHashMap) {
-  return pCruiseResult.modules.flatMap((pModule) => {
-    const lFromNode = pNamesHashMap.get(pModule.source);
-    const lFrom = {
-      node: lFromNode,
-      text: pModule.source.split("/").slice(-1)[0],
-    };
-
-    return pModule.dependencies.map((pDependency) => {
-      const lToNode = pNamesHashMap.get(pDependency.resolved);
-      return {
-        from: lFrom,
-        to: {
-          node: lToNode,
-          text: pDependency.resolved.split("/").slice(-1)[0],
-        },
-      };
-    });
-  });
+	return pCruiseResult.modules.flatMap((pModule) => {
+		const lFromNode = pNamesHashMap.get(pModule.source);
+		const lFrom = {
+			node: lFromNode,
+			text: pModule.source.split("/").slice(-1)[0],
+		};
+
+		return pModule.dependencies.map((pDependency) => {
+			const lToNode = pNamesHashMap.get(pDependency.resolved);
+			return {
+				from: lFrom,
+				to: {
+					node: lToNode,
+					text: pDependency.resolved.split("/").slice(-1)[0],
+				},
+			};
+		});
+	});
 }
 
 const indent = (pDepth, pMinify) => (pMinify ? "" : "  ".repeat(pDepth));
 
 const renderSubgraph = (pNode, pText, pChildren, pIndent) =>
-  `${pIndent}subgraph ${renderNode(pNode, pText)}
+	`${pIndent}subgraph ${renderNode(pNode, pText)}
 ${pChildren}
 ${pIndent}end`;
 
 function renderSubgraphs(pSource, pOptions, pDepth = 0) {
-  return Object.keys(pSource)
-    .map((pName) => {
-      const lIndent = indent(pDepth, pOptions.minify);
-      const source = pSource[pName];
-      const children = renderSubgraphs(source.children, pOptions, pDepth + 1);
-      if (children === "")
-        return `${lIndent}${renderNode(source.node, source.text)}`;
-
-      return renderSubgraph(source.node, source.text, children, lIndent);
-    })
-    .join("\n");
+	return Object.keys(pSource)
+		.map((pName) => {
+			const lIndent = indent(pDepth, pOptions.minify);
+			const source = pSource[pName];
+			const children = renderSubgraphs(source.children, pOptions, pDepth + 1);
+			if (children === "")
+				return `${lIndent}${renderNode(source.node, source.text)}`;
+
+			return renderSubgraph(source.node, source.text, children, lIndent);
+		})
+		.join("\n");
 }
 
 /**
@@ -63,25 +63,25 @@ function renderSubgraphs(pSource, pOptions, pDepth = 0) {
  * @param {Map<string, string>} pNamesHashMap
  */
 function convertSubgraphSources(pCruiseResult, pNamesHashMap) {
-  let lTree = {};
-
-  for (const lModule of pCruiseResult.modules) {
-    const lPaths = lModule.source.split("/");
-
-    lPaths.reduce((pChildren, pCurrentPath, pIndex) => {
-      if (!pChildren[pCurrentPath]) {
-        const node = lPaths.slice(0, pIndex + 1).join("/");
-        pChildren[pCurrentPath] = {
-          node: pNamesHashMap.get(node),
-          text: pCurrentPath,
-          children: {},
-        };
-      }
-      return pChildren[pCurrentPath].children;
-    }, lTree);
-  }
-
-  return lTree;
+	let lTree = {};
+
+	for (const lModule of pCruiseResult.modules) {
+		const lPaths = lModule.source.split("/");
+
+		lPaths.reduce((pChildren, pCurrentPath, pIndex) => {
+			if (!pChildren[pCurrentPath]) {
+				const node = lPaths.slice(0, pIndex + 1).join("/");
+				pChildren[pCurrentPath] = {
+					node: pNamesHashMap.get(node),
+					text: pCurrentPath,
+					children: {},
+				};
+			}
+			return pChildren[pCurrentPath].children;
+		}, lTree);
+	}
+
+	return lTree;
 }
 
 /**
@@ -89,27 +89,27 @@ function convertSubgraphSources(pCruiseResult, pNamesHashMap) {
  * @param {Map<string, string>} pNamesHashMap
  */
 function focusHighlights(pModules, pNamesHashMap) {
-  const lHighLightStyle = "fill:lime,color:black";
-
-  return pModules
-    .filter(
-      (pModule) =>
-        pModule.matchesFocus ||
-        pModule.matchesReaches ||
-        pModule.matchesHighlight,
-    )
-    .reduce((pAll, pModule) => {
-      const lSource = pNamesHashMap.get(pModule.source);
-      return `${pAll}\nstyle ${lSource} ${lHighLightStyle}`;
-    }, "");
+	const lHighLightStyle = "fill:lime,color:black";
+
+	return pModules
+		.filter(
+			(pModule) =>
+				pModule.matchesFocus ||
+				pModule.matchesReaches ||
+				pModule.matchesHighlight,
+		)
+		.reduce((pAll, pModule) => {
+			const lSource = pNamesHashMap.get(pModule.source);
+			return `${pAll}\nstyle ${lSource} ${lHighLightStyle}`;
+		}, "");
 }
 
 const hashToReadableNodeName = (pNode) =>
-  pNode
-    .replace(ACORN_DUMMY_VALUE, "__unknown__")
-    .replace(/^\.$|^\.\//g, "__currentPath__")
-    .replace(/^\.{2}$|^\.{2}\//g, "__prevPath__")
-    .replace(/[[\]/.@~-]/g, "_");
+	pNode
+		.replace(ACORN_DUMMY_VALUE, "__unknown__")
+		.replace(/^\.$|^\.\//g, "__currentPath__")
+		.replace(/^\.{2}$|^\.{2}\//g, "__prevPath__")
+		.replace(/[[\]/.@~-]/g, "_");
 
 /**
  * @param {import("../../types/cruise-result").IModule[]} pModules
@@ -117,38 +117,38 @@ const hashToReadableNodeName = (pNode) =>
  * @return {Map<string, string>}
  */
 function hashModuleNames(pModules, pMinify) {
-  const lBase = 36;
-  const lNamesHashMap = new Map();
-  let lCount = 0;
-
-  for (const lModule of pModules) {
-    const lPaths = lModule.source.split("/");
-
-    for (let lIndex = 0; lIndex < lPaths.length; lIndex += 1) {
-      const lName = lPaths.slice(0, lIndex + 1).join("/");
-      if (!lNamesHashMap.has(lName)) {
-        // eslint-disable-next-line max-depth
-        if (pMinify) {
-          // toUpperCase because otherwise we generate e.g. o-->a and x-->a
-          // which are ambiguous in mermaid (o--> and x--> are edge shapes
-          // whereas e.g. a--> is node 'a' + the arrow shape -->). The only
-          // collision within alphanums are 'o' and 'x', so upper casing
-          // saves us...
-          // ref: https://mermaid.js.org/syntax/flowchart.html#new-arrow-types
-          // another way to solve this would be to place a space between the
-          // node name and the edge shape (x --> a) - however, this would make
-          // for a larger output, running into the mermaid max source size
-          // earlier
-          lNamesHashMap.set(lName, lCount.toString(lBase).toUpperCase());
-          lCount += 1;
-        } else {
-          lNamesHashMap.set(lName, hashToReadableNodeName(lName));
-        }
-      }
-    }
-  }
-
-  return lNamesHashMap;
+	const lBase = 36;
+	const lNamesHashMap = new Map();
+	let lCount = 0;
+
+	for (const lModule of pModules) {
+		const lPaths = lModule.source.split("/");
+
+		for (let lIndex = 0; lIndex < lPaths.length; lIndex += 1) {
+			const lName = lPaths.slice(0, lIndex + 1).join("/");
+			if (!lNamesHashMap.has(lName)) {
+				// eslint-disable-next-line max-depth
+				if (pMinify) {
+					// toUpperCase because otherwise we generate e.g. o-->a and x-->a
+					// which are ambiguous in mermaid (o--> and x--> are edge shapes
+					// whereas e.g. a--> is node 'a' + the arrow shape -->). The only
+					// collision within alphanums are 'o' and 'x', so upper casing
+					// saves us...
+					// ref: https://mermaid.js.org/syntax/flowchart.html#new-arrow-types
+					// another way to solve this would be to place a space between the
+					// node name and the edge shape (x --> a) - however, this would make
+					// for a larger output, running into the mermaid max source size
+					// earlier
+					lNamesHashMap.set(lName, lCount.toString(lBase).toUpperCase());
+					lCount += 1;
+				} else {
+					lNamesHashMap.set(lName, hashToReadableNodeName(lName));
+				}
+			}
+		}
+	}
+
+	return lNamesHashMap;
 }
 
 /**
@@ -156,12 +156,12 @@ function hashModuleNames(pModules, pMinify) {
  * @param {import("../../types/reporter-options").IMermaidReporterOptions} pOptions
  */
 function renderMermaidSource(pCruiseResult, pOptions) {
-  const lOptions = { ...REPORT_DEFAULTS, ...(pOptions || {}) };
-  const lNamesHashMap = hashModuleNames(pCruiseResult.modules, lOptions.minify);
-  const lSubgraphs = convertSubgraphSources(pCruiseResult, lNamesHashMap);
-  const lEdges = convertEdgeSources(pCruiseResult, lNamesHashMap);
+	const lOptions = { ...REPORT_DEFAULTS, ...(pOptions || {}) };
+	const lNamesHashMap = hashModuleNames(pCruiseResult.modules, lOptions.minify);
+	const lSubgraphs = convertSubgraphSources(pCruiseResult, lNamesHashMap);
+	const lEdges = convertEdgeSources(pCruiseResult, lNamesHashMap);
 
-  return `flowchart LR
+	return `flowchart LR
 
 ${renderSubgraphs(lSubgraphs, lOptions)}
 ${renderEdges(lEdges)}
@@ -176,8 +176,8 @@ ${focusHighlights(pCruiseResult.modules, lNamesHashMap)}`;
  * @return {import('../../types/dependency-cruiser').IReporterOutput}
  */
 export default function mermaid(pCruiseResult, pOptions) {
-  return {
-    output: renderMermaidSource(pCruiseResult, pOptions),
-    exitCode: 0,
-  };
+	return {
+		output: renderMermaidSource(pCruiseResult, pOptions),
+		exitCode: 0,
+	};
 }