dependency-cruiser 17.3.10 → 17.4.0

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;
+}