dependency-cruiser/src/report/dot/module-utl.mjs

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

import { basename, sep, dirname } from "node:path/posix";
import { formatPercentage, getURLForModule } from "../utl/index.mjs";

export function attributizeObject(pObject) {
	return (
		Object.keys(pObject)
			// eslint-disable-next-line security/detect-object-injection
			.map((pKey) => `${pKey}="${pObject[pKey]}"`)
			.join(" ")
	);
}

export function extractFirstTransgression(pModule) {
	return {
		...(pModule?.rules?.[0]
			? { ...pModule, tooltip: pModule.rules[0].name }
			: pModule),
		dependencies: pModule.dependencies.map((pDependency) =>
			pDependency.rules
				? {
						...pDependency,
						rule: pDependency.rules[0],
					}
				: pDependency,
		),
	};
}

function toFullPath(pAll, pCurrent) {
	return `${pAll}${pCurrent}${sep}`;
}

function aggregate(pPathSnippet, pCounter, pPathArray) {
	return {
		snippet: pPathSnippet,
		aggregateSnippet: `${pPathArray
			.slice(0, pCounter)
			.reduce(toFullPath, "")}${pPathSnippet}`,
	};
}

function makeInstabilityString(pModule, pShowMetrics = false) {
	let lInstabilityString = "";

	if (
		pShowMetrics &&
		Object.hasOwn(pModule, "instability") &&
		!pModule.consolidated
	) {
		lInstabilityString = ` <FONT color="#808080" point-size="8">${formatPercentage(
			pModule.instability,
		)}</FONT>`;
	}
	return lInstabilityString;
}

export function folderify(pShowMetrics) {
	/** @param {import("../../../types/cruise-result").IModule} pModule*/
	return (pModule) => {
		let lAdditions = {};
		let lDirectoryName = dirname(pModule.source);

		if (lDirectoryName !== ".") {
			lAdditions.folder = lDirectoryName;
			lAdditions.path = lDirectoryName.split(sep).map(aggregate);
		}

		lAdditions.label = `<${basename(pModule.source)}${makeInstabilityString(
			pModule,
			pShowMetrics,
		)}>`;
		lAdditions.tooltip = basename(pModule.source);

		return {
			...pModule,
			...lAdditions,
		};
	};
}

/**
 * @param {string} pPrefix
 * @param {string} pSuffix
 * @returns {URL?: string}
 */
export function addURL(pPrefix, pSuffix) {
	return (pModule) => {
		if (pModule.couldNotResolve) {
			return pModule;
		}

		return {
			...pModule,
			URL: getURLForModule(pModule, pPrefix, pSuffix),
		};
	};
}

function makeLabel(pModule, pShowMetrics) {
	return `<${dirname(pModule.source)}/<BR/><B>${basename(
		pModule.source,
	)}</B>${makeInstabilityString(pModule, pShowMetrics)}>`;
}

export function flatLabel(pShowMetrics) {
	return (pModule) => ({
		...pModule,
		label: makeLabel(pModule, pShowMetrics),
		tooltip: basename(pModule.source),
	});
}