dependency-cruiser 18.0.0 → 18.1.1

package/src/main/options/normalize.mjs

@@ -45,7 +45,7 @@ function normalizeReporterOptions(pReporterOptions) {
 }
 
 function normalizeFilterOptions(pOptions, pFilterOptionKeys) {
-	let lReturnValue = { ...pOptions };
+	const lReturnValue = { ...pOptions };
 
 	for (const lFilterOptionKey of pFilterOptionKeys) {
 		if (pOptions[lFilterOptionKey]) {
@@ -74,7 +74,7 @@ function normalizeCollapse(pCollapse) {
 
 function normalizeFocusDepth(pFormatOptions) {
 	/** @type {IFormatOptions}*/
-	let lFormatOptions = structuredClone(pFormatOptions);
+	const lFormatOptions = structuredClone(pFormatOptions);
 	if (Object.hasOwn(lFormatOptions, "focusDepth")) {
 		if (lFormatOptions?.focus) {
 			lFormatOptions.focus.depth = Number.parseInt(

package/src/main/report-wrap.mjs

@@ -39,6 +39,7 @@ function reSummarizeResults(pResult, pFormatOptions) {
 				// TODO: apply filters to the folders too
 				pResult.folders,
 			),
+			environment: pResult.summary.environment,
 		},
 		modules: lModules,
 	};

package/src/main/resolve-options/normalize.mjs

@@ -37,7 +37,7 @@ const DEFAULT_RESOLVE_OPTIONS = {
 
 function omit(pObject, pProperty) {
 	const lObject = structuredClone(pObject);
-	// eslint-disable-next-line security/detect-object-injection
+	/* oxlint-disable-next-line no-dynamic-delete */
 	delete lObject[pProperty];
 	return lObject;
 }
@@ -71,7 +71,7 @@ async function compileResolveOptions(
 	pTSConfig,
 	pResolveOptionsFromDCConfig,
 ) {
-	let lResolveOptions = {};
+	const lResolveOptions = {};
 
 	// There's a performance impact of ~1 ms per resolve even when there
 	// are 0 paths in the tsconfig, so not loading it when not necessary

package/src/main/rule-set/assert-validity.mjs

@@ -76,7 +76,7 @@ function assertRuleSafety(pRule) {
  * Throws an Error in all other cases.
  *
  * @param  {IConfiguration} pConfiguration The configuration to validate
- * @return {IConfiguration} The configuration as passed
+ * @returns {IConfiguration} The configuration as passed
  * @throws {Error}          An error with the reason for the error as a message
  */
 export default function assertRuleSetValid(pConfiguration) {

package/src/main/rule-set/normalize.mjs

@@ -111,7 +111,7 @@ function normalizeRule(pRule) {
  * - severity (default 'warn')
  *
  * @param  {IFlattenedRuleSet} pRuleSet
- * @return {IStrictRuleSet}
+ * @returns {IStrictRuleSet}
  */
 export default function normalizeRuleSet(pRuleSet) {
 	bus.debug("startup: parse rule set: normalize");

package/src/meta.cjs

@@ -1,6 +1,6 @@
 /* generated - don't edit */
 module.exports = {
-	version: "18.0.0",
+	version: "18.1.1",
 	engines: {
 		node: "^22||^24||>=26",
 	},

package/src/report/anon/anonymize-path-element.mjs

@@ -37,7 +37,7 @@ function replaceFromWordList(pPathElement, pWordList, pCached) {
  * @param {string[]} pWordList words to pick from
  * @param {RegExp} pWhiteListRE pattern not to anonymize
  * @param {boolean} pCached caches the replaced value, with pPathElement as the key
- * @return {string} the path element, anonymized if it isn't whitelisted
+ * @returns {string} the path element, anonymized if it isn't whitelisted
  */
 export function anonymizePathElement(
 	pPathElement,

package/src/report/anon/index.mjs

@@ -179,7 +179,7 @@ function sanitizeWordList(pWordList) {
  */
 export default function reportAnonymous(pResults, pAnonymousReporterOptions) {
 	/** @type {{wordlist?: String[]}} */
-	let lAnonymousReporterOptions = pAnonymousReporterOptions || {};
+	const lAnonymousReporterOptions = pAnonymousReporterOptions || {};
 	if (!lAnonymousReporterOptions.wordlist) {
 		lAnonymousReporterOptions.wordlist =
 			pResults?.summary?.optionsUsed?.reporterOptions?.anon?.wordlist ?? [];

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

@@ -51,7 +51,7 @@ function getRandomChar(pChar) {
  * pulp2slurp => jgyb3guyow
  *
  * @param {string} pString - any string
- * @return {string} - a random string with above specs
+ * @returns {string} - a random string with above specs
  */
 export default function getRandomString(pString) {
 	return Array.from(pString).map(getRandomChar).join("");

package/src/report/azure-devops.mjs

@@ -80,7 +80,7 @@ function formatViolation(pViolation) {
 		reachability: formatReachabilityViolation,
 		instability: formatInstabilityViolation,
 	};
-	let lFormattedViolators = _formatViolation(
+	const lFormattedViolators = _formatViolation(
 		pViolation,
 		lViolationType2Formatter,
 		formatDependencyViolation,
@@ -133,7 +133,7 @@ function formatIgnoreWarning(pNumberOfIgnored) {
  * @returns {string}
  */
 function formatResultMessage(pSummary) {
-	let lStatSummary = `${pSummary.totalCruised} modules, ${
+	const lStatSummary = `${pSummary.totalCruised} modules, ${
 		pSummary?.totalDependenciesCruised ?? 0
 	} dependencies cruised`;
 

package/src/report/baseline.mjs

@@ -7,7 +7,7 @@ const EOL = "\n";
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @returns {import('../../types/dependency-cruiser').IReporterOutput} -
  *      output: some stats on modules and dependencies in json format
  *      exitCode: 0
  */

package/src/report/d2.mjs

@@ -32,7 +32,7 @@ function getMaxSeverity(pRules) {
 
 /**
  * @param {string} pSource
- * @return {string}
+ * @returns {string}
  */
 function getVertexName(pSource) {
 	const lFolderName = dirname(pSource)
@@ -117,7 +117,7 @@ function getDependencyAttributes(pDependency) {
 
 /**
  * @param {import('../../types/cruise-result').ICruiseResult} pCruiseResult
- * @return {string}
+ * @returns {string}
  */
 function renderD2Source(pCruiseResult) {
 	const lVertices = pCruiseResult.modules
@@ -153,7 +153,7 @@ function renderD2Source(pCruiseResult) {
  * d2 reporter
  *
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
- * @return {import('../../types/dependency-cruiser').IReporterOutput}
+ * @returns {import('../../types/dependency-cruiser').IReporterOutput}
  */
 export default function d2(pCruiseResult) {
 	return {

package/src/report/dot/index.mjs

@@ -193,7 +193,7 @@ function normalizeDotReporterOptions(
 	pGranularity,
 	pResults,
 ) {
-	let lDotReporterOptions = pDotReporterOptions || {};
+	const lDotReporterOptions = pDotReporterOptions || {};
 
 	return {
 		theme:

package/src/report/dot/module-utl.mjs

@@ -57,8 +57,8 @@ function makeInstabilityString(pModule, pShowMetrics = false) {
 export function folderify(pShowMetrics) {
 	/** @param {import("../../../types/cruise-result").IModule} pModule*/
 	return (pModule) => {
-		let lAdditions = {};
-		let lDirectoryName = dirname(pModule.source);
+		const lAdditions = {};
+		const lDirectoryName = dirname(pModule.source);
 
 		if (lDirectoryName !== ".") {
 			lAdditions.folder = lDirectoryName;

package/src/report/dot/theming.mjs

@@ -47,12 +47,18 @@ function moduleOrDependencyMatchesCriteria(pSchemeEntry, pModule) {
 }
 
 export function getThemeAttributes(pModuleOrDependency, pAttributeCriteria) {
-	return (pAttributeCriteria || [])
-		.filter((pSchemeEntry) =>
-			moduleOrDependencyMatchesCriteria(pSchemeEntry, pModuleOrDependency),
-		)
-		.map((pSchemeEntry) => pSchemeEntry.attributes)
-		.reduce((pAll, pCurrent) => ({ ...pCurrent, ...pAll }), {});
+	return (
+		(pAttributeCriteria || [])
+			.filter((pSchemeEntry) =>
+				moduleOrDependencyMatchesCriteria(pSchemeEntry, pModuleOrDependency),
+			)
+			.map((pSchemeEntry) => pSchemeEntry.attributes)
+			/* oxlint-disable-next-line no-accumulating-spread - 
+       replacing it with alternatives is going to yield the same O(n^2)
+       complexity, just with more lines of code
+     */
+			.reduce((pAll, pCurrent) => ({ ...pCurrent, ...pAll }), {})
+	);
 }
 
 export function normalizeTheme(pTheme) {

package/src/report/dot-webpage/svg-in-html-snippets/script.cjs

@@ -84,7 +84,7 @@ function Mode() {
  *
  * @param {SVGGelement[]} pEdges
  * @param {SVGGElement[]} pNodes
- * @return {{get: (pTitleText:string) => SVGGElement[]}}
+ * @returns {{get: (pTitleText:string) => SVGGElement[]}}
  */
 function Title2ElementMap(pEdges, pNodes) {
 	/* {{[key: string]: SVGGElement[]}} */
@@ -93,7 +93,7 @@ function Title2ElementMap(pEdges, pNodes) {
 	/**
 	 * @param {NodeListOf<SVGGElement>} pEdges
 	 * @param {NodeListOf<SVGGElement>} pNodes
-	 * @return {{[key: string]: SVGGElement[]}}
+	 * @returns {{[key: string]: SVGGElement[]}}
 	 */
 	function buildMap(pEdges, pNodes) {
 		var title2NodeMap = buildTitle2NodeMap(pNodes);
@@ -102,7 +102,7 @@ function Title2ElementMap(pEdges, pNodes) {
 	}
 	/**
 	 * @param {NodeListOf<SVGGElement>} pNodes
-	 * @return {{[key: string]: SVGGElement}}
+	 * @returns {{[key: string]: SVGGElement}}
 	 */
 	function buildTitle2NodeMap(pNodes) {
 		return nodeListToArray(pNodes).reduce(addNodeToMap, {});
@@ -136,7 +136,7 @@ function Title2ElementMap(pEdges, pNodes) {
 	/**
 	 *
 	 * @param {string} pString
-	 * @return {{from?: string; to?:string;}}
+	 * @returns {{from?: string; to?:string;}}
 	 */
 	function pryEdgeFromTitle(pString) {
 		var nodeNames = pString.split(/\s*->\s*/);
@@ -149,7 +149,7 @@ function Title2ElementMap(pEdges, pNodes) {
 	/**
 	 *
 	 * @param {string} pTitleText
-	 * @return {SVGGElement[]}
+	 * @returns {SVGGElement[]}
 	 */
 	function get(pTitleText) {
 		return (pTitleText && elementMap[pTitleText]) || [];
@@ -161,7 +161,7 @@ function Title2ElementMap(pEdges, pNodes) {
 
 /**
  * @param {SVGGElement} pGElement
- * @return {string?}
+ * @returns {string?}
  */
 function getTitleText(pGElement) {
 	/** @type {SVGTitleElement} */
@@ -177,7 +177,7 @@ function getTitleText(pGElement) {
 
 /**
  * @param {NodeListOf<Element>} pNodeList
- * @return {Element[]}
+ * @returns {Element[]}
  */
 function nodeListToArray(pNodeList) {
 	var lReturnValue = [];

package/src/report/error-html/error-html-template.mjs

@@ -42,6 +42,13 @@ export default `<!DOCTYPE html>
       width: 100%;
     }
 
+    th { 
+      position: sticky; 
+      top: 0; 
+      z-index: 2; 
+      background-color: white 
+    }
+
     th,
     td {
       text-align: left;

package/src/report/error.mjs

@@ -15,6 +15,13 @@ const SEVERITY2COLOR = new Map([
 	["ignore", "gray"],
 ]);
 
+const SEVERITY2ICON = new Map([
+	["error", "x"],
+	["warn", "‼"],
+	["info", "i"],
+	["ignore", "-"],
+]);
+
 const EXTRA_PATH_INFORMATION_INDENT = 6;
 
 function formatMiniDependency(pMiniDependency) {
@@ -89,7 +96,7 @@ function sumMeta(pMeta) {
 }
 
 function formatSummary(pSummary) {
-	let lMessage = `${EOL}x ${sumMeta(
+	const lMessage = `${EOL}x ${sumMeta(
 		pSummary,
 	)} dependency violations (${formatMeta(pSummary)}). ${
 		pSummary.totalCruised
@@ -116,6 +123,29 @@ function formatIgnoreWarning(pNumberOfIgnoredViolations) {
 	}
 	return "";
 }
+/**
+ * @param {import("../../types/cruise-result.mjs").IEnvironmentIssue} pEnvironmentIssue
+ * @returns {string}
+ */
+function formatEnvironmentIssue(pEnvironmentIssue) {
+	return styleText(
+		SEVERITY2COLOR.get(pEnvironmentIssue.severity),
+		`${SEVERITY2ICON.get(pEnvironmentIssue.severity)} ${styleText("bold", pEnvironmentIssue.name)}: ${pEnvironmentIssue.description}`,
+	);
+}
+
+/**
+ * @param {import("../../types/cruise-result.mjs").IEnvironmentIssue[]} pEnvironmentIssues
+ * @returns {string}
+ */
+function formatEnvironmentIssues(pEnvironmentIssues) {
+	const lEnvironmentIssues = pEnvironmentIssues ?? [];
+
+	return (
+		(lEnvironmentIssues.length > 0 ? EOL : "") +
+		lEnvironmentIssues.map(formatEnvironmentIssue).join(EOL)
+	);
+}
 
 function report(pResults, pOptions) {
 	const lOptions = {
@@ -135,7 +165,7 @@ function report(pResults, pOptions) {
 			pResults.summary.totalDependenciesCruised
 		} dependencies cruised)${EOL}${formatIgnoreWarning(
 			pResults.summary.ignore,
-		)}${EOL}`;
+		)}${formatEnvironmentIssues(pResults.summary.environment?.issues)}${EOL}`;
 	}
 
 	return lNonIgnorableViolations
@@ -147,6 +177,7 @@ function report(pResults, pOptions) {
 		)
 		.concat(formatSummary(pResults.summary))
 		.concat(formatIgnoreWarning(pResults.summary.ignore))
+		.concat(formatEnvironmentIssues(pResults.summary.environment?.issues))
 		.concat(EOL);
 }
 

package/src/report/html/index.mjs

@@ -17,7 +17,7 @@ function addShowTitle(pDependencyEntry) {
 }
 
 function getClasses(pModule, pOtherClasses) {
-	let lClasses = pOtherClasses || [];
+	const lClasses = pOtherClasses || [];
 	if (pModule.coreModule) {
 		lClasses.push("cell-core-module");
 	}
@@ -37,7 +37,7 @@ function constructTableHead(pModules) {
 }
 
 function constructTableCellTitle(pModule, pIncidence) {
-	let lTitleLines = [];
+	const lTitleLines = [];
 	if (pIncidence.rule) {
 		lTitleLines.push(`${pIncidence.rule}:`);
 	}

package/src/report/index.mjs

@@ -36,6 +36,7 @@ const TYPE2MODULE = new Map([
  *                       and returns an IReporterOutput
  */
 export async function getReporter(pOutputType) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = {};
 	if (pOutputType?.startsWith("plugin:")) {
 		lReturnValue = await getExternalPluginReporter(pOutputType);

package/src/report/markdown.mjs

@@ -49,7 +49,7 @@ function severity2Icon(pSeverity) {
 
 /**
  * @param {import("../../types/cruise-result.mjs").ISummary} pSummary
- * @return {string}
+ * @returns {string}
  */
 function formatStatsSummary(pSummary) {
 	const lSpacerLength = 4;
@@ -60,7 +60,7 @@ function formatStatsSummary(pSummary) {
 /**
  * @param {import("../../types/cruise-result.mjs").ICruiseResult} pCruiseResult
  * @param {Boolean} pIncludeIgnoredInSummary
- * @return {string}
+ * @returns {string}
  */
 function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
 	const lTableHead =
@@ -87,7 +87,7 @@ function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
  *
  * @param {import("../../types/cruise-result.mjs").IViolation[]} pViolations
  * @param {object} pOptions
- * @return {string}
+ * @returns {string}
  */
 function formatViolations(pViolations, pOptions) {
 	const lTableHead = "|violated rule|module|to|\n|:---|:---|:---|\n";

package/src/report/mermaid.mjs

@@ -63,7 +63,7 @@ function renderSubgraphs(pSource, pOptions, pDepth = 0) {
  * @param {Map<string, string>} pNamesHashMap
  */
 function convertSubgraphSources(pCruiseResult, pNamesHashMap) {
-	let lTree = {};
+	const lTree = {};
 
 	for (const lModule of pCruiseResult.modules) {
 		const lPaths = lModule.source.split("/");
@@ -114,7 +114,7 @@ const hashToReadableNodeName = (pNode) =>
 /**
  * @param {import("../../types/cruise-result").IModule[]} pModules
  * @param {Boolean} pMinify
- * @return {Map<string, string>}
+ * @returns {Map<string, string>}
  */
 function hashModuleNames(pModules, pMinify) {
 	const lBase = 36;
@@ -173,7 +173,7 @@ ${focusHighlights(pCruiseResult.modules, lNamesHashMap)}`;
  *
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
  * @param {import("../../types/reporter-options").IMermaidReporterOptions} pOptions
- * @return {import('../../types/dependency-cruiser').IReporterOutput}
+ * @returns {import('../../types/dependency-cruiser').IReporterOutput}
  */
 export default function mermaid(pCruiseResult, pOptions) {
 	return {

package/src/report/metrics.mjs

@@ -249,7 +249,7 @@ function transformMetricsToTable(
 			largeIntegerWidth: METRIC_WIDTH + METRIC_WIDTH,
 		},
 	);
-	let lComponents = lObject.data
+	const lComponents = lObject.data
 		.filter(
 			(pComponent) =>
 				(!hideModules && pComponent.type === "module") ||
@@ -268,7 +268,7 @@ function transformMetricsToTable(
  *
  * @param {import('../../types/dependency-cruiser.js').ICruiseResult} pCruiseResult -
  * @param {import("../../types/reporter-options.js").IMetricsReporterOptions} pReporterOptions
- * @return {import('../../types/dependency-cruiser.js').IReporterOutput} -
+ * @returns {import('../../types/dependency-cruiser.js').IReporterOutput} -
  */
 export default function metrics(pCruiseResult, pReporterOptions) {
 	const lReporterOptions = pReporterOptions || {};

package/src/report/plugins.mjs

@@ -25,12 +25,13 @@ export function isValidPlugin(pPluginFunction) {
 }
 
 async function getPluginReporter(pOutputType) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = false;
 
 	try {
 		const lModule = await import(pOutputType);
 		lReturnValue = lModule.default;
-	} catch (pError) {
+	} catch {
 		throw new Error(
 			`Could not find reporter plugin '${pOutputType}' (or it isn't valid)`,
 		);

package/src/report/teamcity.mjs

@@ -16,7 +16,7 @@ const EOL = "\n";
  * Copied from https://github.com/pifantastic/teamcity-service-messages/blob/master/lib/message.js#L72
  *
  * @param  {String} pMessageString the string to escape
- * @return {String}
+ * @returns {String}
  */
 function escape(pMessageString) {
 	if (pMessageString === null) {
@@ -48,7 +48,7 @@ function escape(pMessageString) {
  * but this is what teamcity-service-messages used, so as
  * per the rule of least surprise, this is what we use as well.
  *
- * @return {string} 10 random numeric digits
+ * @returns {string} 10 random numeric digits
  */
 function getRandomFlowId() {
 	const lFlowIdLength = 10;

package/src/report/utl/dependency-to-incidence-transformer.mjs

@@ -8,7 +8,7 @@ function compareOnSource(pOne, pTwo) {
 
 function determineIncidenceType(pFromListEntry) {
 	return (pModule) => {
-		let lDependency = pModule.dependencies.find(
+		const lDependency = pModule.dependencies.find(
 			(pDependency) => pDependency.resolved === pFromListEntry.source,
 		);
 

package/src/report/utl/index.mjs

@@ -32,7 +32,7 @@ export function formatViolation(
  *
  * @param {string} pPrefix - prefix
  * @param {string} pSource - filename
- * @return {string} prefix and filename concatenated
+ * @returns {string} prefix and filename concatenated
  */
 function smartURIConcat(pPrefix, pSource) {
 	if (PROTOCOL_PREFIX_RE.test(pPrefix)) {