dependency-cruiser 17.3.10 → 17.4.2

package/src/report/error.mjs

@@ -3,6 +3,7 @@ import { styleText } from "node:util";
 import {
 	formatPercentage,
 	formatViolation as _formatViolation,
+	formatDependencyTo,
 } from "./utl/index.mjs";
 import { findRuleByName } from "#graph-utl/rule-set.mjs";
 import wrapAndIndent from "#utl/wrap-and-indent.mjs";
@@ -29,8 +30,8 @@ function formatModuleViolation(pViolation) {
 	return styleText("bold", pViolation.from);
 }
 
-function formatDependencyViolation(pViolation) {
-	return `${styleText("bold", pViolation.from)} → ${styleText("bold", pViolation.to)}`;
+function formatDependencyViolation(pViolation, pOptions) {
+	return `${styleText("bold", pViolation.from)} → ${styleText("bold", formatDependencyTo(pViolation, pOptions))}`;
 }
 
 function formatCycleViolation(pViolation) {
@@ -41,8 +42,8 @@ function formatReachabilityViolation(pViolation) {
 	return `${styleText("bold", pViolation.from)} → ${styleText("bold", pViolation.to)}${formatMiniDependency(pViolation.via)}`;
 }
 
-function formatInstabilityViolation(pViolation) {
-	return `${formatDependencyViolation(pViolation)}${EOL}${styleText(
+function formatInstabilityViolation(pViolation, pOptions) {
+	return `${formatDependencyViolation(pViolation, pOptions)}${EOL}${styleText(
 		"dim",
 		wrapAndIndent(
 			`instability: ${formatPercentage(pViolation.metrics.from.instability)} → ${formatPercentage(pViolation.metrics.to.instability)}`,
@@ -51,7 +52,7 @@ function formatInstabilityViolation(pViolation) {
 	)}`;
 }
 
-function formatViolation(pViolation) {
+function formatViolation(pViolation, pOptions) {
 	const lViolationType2Formatter = {
 		module: formatModuleViolation,
 		dependency: formatDependencyViolation,
@@ -63,6 +64,7 @@ function formatViolation(pViolation) {
 		pViolation,
 		lViolationType2Formatter,
 		formatDependencyViolation,
+		pOptions,
 	);
 
 	return (
@@ -115,7 +117,13 @@ function formatIgnoreWarning(pNumberOfIgnoredViolations) {
 	return "";
 }
 
-function report(pResults, pLong) {
+function report(pResults, pOptions) {
+	const lOptions = {
+		long: false,
+		showExternalModulesUnresolved: false,
+		showAliasedModulesUnresolved: false,
+		...pOptions,
+	};
 	const lNonIgnorableViolations = pResults.summary.violations.filter(
 		(pViolation) => pViolation.rule.severity !== "ignore",
 	);
@@ -132,8 +140,11 @@ function report(pResults, pLong) {
 
 	return lNonIgnorableViolations
 		.reverse()
-		.map(addExplanation(pResults.summary.ruleSetUsed, pLong))
-		.reduce((pAll, pThis) => `${pAll}  ${formatViolation(pThis)}${EOL}`, EOL)
+		.map(addExplanation(pResults.summary.ruleSetUsed, lOptions.long))
+		.reduce(
+			(pAll, pThis) => `${pAll}  ${formatViolation(pThis, lOptions)}${EOL}`,
+			EOL,
+		)
 		.concat(formatSummary(pResults.summary))
 		.concat(formatIgnoreWarning(pResults.summary.ignore))
 		.concat(EOL);
@@ -154,7 +165,7 @@ function report(pResults, pLong) {
  */
 export default function error(pResults, pOptions) {
 	return {
-		output: report(pResults, (pOptions || {}).long),
+		output: report(pResults, pOptions || {}),
 		exitCode: pResults.summary.error,
 	};
 }

package/src/report/markdown.mjs

@@ -22,6 +22,8 @@ const REPORT_DEFAULTS = {
 	detailsHeader: "### :fire: All violations",
 	collapseDetails: true,
 	collapsedMessage: "Violations found - click to expand",
+	showExternalModulesUnresolved: false,
+	showAliasedModulesUnresolved: false,
 	noViolationsMessage:
 		":revolving_hearts: No violations found. Get gummy bears to celebrate.",
 
@@ -84,20 +86,21 @@ function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
 /**
  *
  * @param {import("../../types/cruise-result.mjs").IViolation[]} pViolations
- * @param {boolean} pIncludeIgnoredInDetails
+ * @param {object} pOptions
  * @return {string}
  */
-function formatViolations(pViolations, pIncludeIgnoredInDetails) {
+function formatViolations(pViolations, pOptions) {
 	const lTableHead = "|violated rule|module|to|\n|:---|:---|:---|\n";
 
 	return pViolations
 		.filter(
 			(pViolation) =>
-				pViolation.rule.severity !== "ignore" || pIncludeIgnoredInDetails,
+				pViolation.rule.severity !== "ignore" ||
+				pOptions.includeIgnoredInDetails,
 		)
 		.reduce((pAll, pViolation) => {
 			const lFromExtras = determineFromExtras(pViolation);
-			const lTo = determineTo(pViolation);
+			const lTo = determineTo(pViolation, pOptions);
 
 			return `${pAll}|${severity2Icon(pViolation.rule.severity)} _${
 				pViolation.rule.name
@@ -116,7 +119,7 @@ function details(pResults, pOptions) {
 		}
 		lReturnValue += `${formatViolations(
 			pResults.summary.violations,
-			pOptions.includeIgnoredInDetails,
+			pOptions,
 		)}\n\n`;
 		if (pOptions.collapseDetails) {
 			lReturnValue += "</details>\n\n";

package/src/report/utl/index.mjs

@@ -14,9 +14,11 @@ export function formatViolation(
 	pViolation,
 	pViolationType2Formatter,
 	pDefaultFormatter,
+	pOptions,
 ) {
 	return (pViolationType2Formatter[pViolation.type] || pDefaultFormatter)(
 		pViolation,
+		pOptions,
 	);
 }
 
@@ -105,3 +107,61 @@ export function getURLForModule(pModule, pPrefix, pSuffix) {
 	}
 	return pModule.source;
 }
+
+/**
+ *
+ * @param {import("../../../types/shared-types.mjs").DependencyType[]} pDependencyTypes
+ * @returns {string}
+ */
+export function getOneLetterDependencyType(pDependencyTypes) {
+	if (pDependencyTypes) {
+		if (
+			pDependencyTypes.some((pDependencyType) =>
+				pDependencyType.startsWith("npm"),
+			)
+		) {
+			return "n";
+		}
+		if (pDependencyTypes.includes("aliased-subpath-import")) {
+			return "#";
+		}
+		if (pDependencyTypes.includes("aliased")) {
+			return "@";
+		}
+		if (pDependencyTypes.includes("core")) {
+			return "c";
+		}
+		if (pDependencyTypes.includes("export")) {
+			return "x";
+		}
+		if (pDependencyTypes.includes("local")) {
+			return ".";
+		}
+		if (
+			pDependencyTypes.some((pDependencyType) =>
+				pDependencyType.startsWith("type-"),
+			)
+		) {
+			return "T";
+		}
+	}
+
+	return "";
+}
+export function formatDependencyTo(pViolation, pOptions) {
+	if (pViolation.unresolvedTo) {
+		const lDependencyTypes = pViolation?.dependencyTypes ?? [];
+		const lShowUnresolvedExternal =
+			pOptions?.showExternalModulesUnresolved &&
+			lDependencyTypes.some((pDependencyType) =>
+				pDependencyType.startsWith("npm"),
+			);
+		const lShowUnresolvedAliased =
+			pOptions?.showAliasedModulesUnresolved &&
+			lDependencyTypes.includes("aliased");
+		return lShowUnresolvedExternal || lShowUnresolvedAliased
+			? pViolation.unresolvedTo
+			: pViolation.to;
+	}
+	return pViolation.to;
+}