dependency-cruiser 18.1.0 → 18.1.1

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.mjs

@@ -96,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

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)) {

package/src/utl/array-util.mjs

@@ -4,7 +4,7 @@
  *
  * @param {string[]} pLeftArray an array of strings
  * @param {string[]} pRightArray another array of strings
- * @return {boolean} true if there's at least one element in pLeftArray also in pRightArray
+ * @returns {boolean} true if there's at least one element in pLeftArray also in pRightArray
  */
 export function intersects(pLeftArray, pRightArray) {
 	if (pLeftArray.length === 0 || pRightArray.length === 0) {

package/src/utl/find-all-files.mjs

@@ -56,7 +56,7 @@ function walk(
 function readIgnoreFile(pFileName) {
 	try {
 		return readFileSync(pFileName, "utf8");
-	} catch (pError) {
+	} catch {
 		return "";
 	}
 }

package/src/utl/get-extension.mjs

@@ -13,7 +13,7 @@ const EXTENSION_RE = /(?<extension>(?:(?:\.d\.(?:[cm])?ts)|\.coffee\.md)$)/;
  * .ts, .cts and .mts
  *
  * @param {string} pFileName path to the file to be parsed
- * @return {string}          extension
+ * @returns {string}          extension
  */
 export default function getExtension(pFileName) {
 	const lMatchResult = EXTENSION_RE.exec(pFileName);

package/src/utl/path-to-posix.mjs

@@ -17,7 +17,7 @@ import path from "node:path";
  * @param  {string} pFilePath   the path to transform
  * @param  {path} pPathModule? optional - the path module/ object to use (for testing
  *                              this module on posix platforms only; defaults to require('path'))
- * @return {string}             the transformed path
+ * @returns {string}             the transformed path
  */
 export default function pathToPosix(pFilePath, pPathModule = path) {
 	const lPathModule = pPathModule || path;

package/src/utl/regex-util.mjs

@@ -41,7 +41,9 @@ export function extractGroups(pFromRestriction, pActualPath) {
 		// except before it enters here it has already been 'normalized' to a string
 		// so it can be safely passed to match. The right solution here (TODO)
 		// is to create a separate type for NormalizedFromRestriction
-		let lMatchResult = getCachedRegExp(pFromRestriction.path).exec(pActualPath);
+		const lMatchResult = getCachedRegExp(pFromRestriction.path).exec(
+			pActualPath,
+		);
 
 		if (lMatchResult && lMatchResult.length > 1) {
 			lReturnValue = lMatchResult.filter(

package/src/utl/try-import.mjs

@@ -60,7 +60,7 @@ export default async function tryImport(pModuleName, pSemanticVersion) {
 		}
 		const lModule = await import(pModuleName);
 		return lModule.default ? lModule.default : lModule;
-	} catch (pError) {
+	} catch {
 		return false;
 	}
 }

package/src/utl/try-require.cjs

@@ -6,7 +6,7 @@ const extractRootModuleName = require("./extract-root-module-name.cjs");
 /**
  * @throws {Error}
  * @param pModuleName the name of the module to get the version for
- * @return the version of the module identified by pModuleName
+ * @returns the version of the module identified by pModuleName
  */
 function getVersion(pModuleName) {
 	// @ts-expect-error TS2345 extractRootModuleName can return either a string or
@@ -26,7 +26,7 @@ function getVersion(pModuleName) {
  *
  * @param {string} pModuleName      the name of the module to resolve
  * @param {string} [pSemanticVersion] (optional) a semantic version (range)
- * @return {NodeModule | false }the (resolved) module identified by pModuleName or false
+ * @returns {NodeModule | false }the (resolved) module identified by pModuleName or false
  */
 function tryRequire(pModuleName, pSemanticVersion) {
 	try {
@@ -43,7 +43,7 @@ function tryRequire(pModuleName, pSemanticVersion) {
 		}
 		// eslint-disable-next-line import/no-dynamic-require, n/global-require, security/detect-non-literal-require
 		return require(pModuleName);
-	} catch (pError) {
+	} catch {
 		return false;
 	}
 }

package/src/validate/index.mjs

@@ -18,7 +18,7 @@ function compareSeverity(pFirst, pSecond) {
 }
 
 function validateAgainstAllowedRules(pRuleSet, pMatchModule, pFrom, pTo) {
-	let lFoundRuleViolations = [];
+	const lFoundRuleViolations = [];
 
 	if (pRuleSet.allowed) {
 		const lInterestingAllowedRules = pRuleSet.allowed.filter(
@@ -75,7 +75,7 @@ function validateAgainstRequiredRules(pRuleSet, pModule, pMatchModule) {
  */
 function validateAgainstRules(pRuleSet, pFrom, pTo, pMatchModule) {
 	/** @type {IValidationResult} */
-	let lReturnValue = { valid: true };
+	const lReturnValue = { valid: true };
 
 	const lFoundRuleViolations = validateAgainstAllowedRules(
 		pRuleSet,

package/types/config-utl/extract-babel-config.d.mts

@@ -5,7 +5,7 @@
  * Silently fails if a supported @babel/core version can't be found
  *
  * @param pBabelConfigFileName
- * @return babel config as an object
+ * @returns babel config as an object
  * @throws when the babel config has an unknown extension OR
  *         when the babel config is invalid OR
  *         when dependency-cruiser can't yet process it

package/types/config-utl/extract-depcruise-config.d.mts

@@ -17,7 +17,7 @@ import type { IConfiguration } from "../configuration.mjs";
  * @param pConfigFileName
  * @param pAlreadyVisited
  * @param pBaseDirectory
- * @return dependency-cruiser configuration
+ * @returns dependency-cruiser configuration
  * @throws when the config is not valid (/ does not exist/ isn't readable)
  */
 export default function extractDepcruiseConfig(

package/types/config-utl/extract-depcruise-options.d.mts

@@ -10,7 +10,7 @@ import type { ICruiseOptions } from "../options.mjs";
  * ```
  *
  * @param pConfigFileName
- * @return dependency-cruiser options
+ * @returns dependency-cruiser options
  * @throws when the config is not valid (/ does not exist/ isn't readable)
  */
 export default function extractDepcruiseOptions(

package/types/config-utl/extract-ts-config.d.mts

@@ -7,7 +7,7 @@ import type { ParsedCommandLine } from "typescript";
  * Silently fails if a supported version of the typescript compiler isn't available
  *
  * @param pTSConfigFileName
- * @return tsconfig as an object
+ * @returns tsconfig as an object
  * @throws {Error} when the tsconfig is invalid/ has errors
  * @throws {TypeError} when the tsconfig is unreadable
  */

package/types/config-utl/extract-webpack-resolve-config.d.mts

@@ -8,7 +8,7 @@ import type { ResolveOptions } from "enhanced-resolve";
  * @param pWebpackConfigFilename
  * @param pEnvironment
  * @param pArguments
- * @return webpack resolve config as an object
+ * @returns webpack resolve config as an object
  * @throws when the webpack config isn't usable (e.g. because it
  *         doesn't exist, or because it's invalid)
  */

package/types/plugins/3d-reporter-plugin.d.mts

@@ -5,7 +5,7 @@ declare module "3d-reporter-plugin" {
 	 * Sample plugin: 3d representation
 	 *
 	 * @param {ICruiseResult} pCruiseResult - the output of a dependency-cruise adhering to dependency-cruiser's cruise result schema
-	 * @return {IReporterOutput} - output: a string, exitCode: 0
+	 * @returns {IReporterOutput} - output: a string, exitCode: 0
 	 */
 	export default function ThreeDReporterPlugin(
 		pCruiseResult: ICruiseResult,

package/types/plugins/mermaid-reporter-plugin.d.mts

@@ -6,7 +6,7 @@ declare module "mermaid-reporter-plugin" {
 	 *
 	 * @deprecated use the mermaid reporter baked into the dependency-cruiser itself (--output-type mermaid)
 	 * @param {ICruiseResult} pCruiseResult - the output of a dependency-cruise adhering to dependency-cruiser's cruise result schema
-	 * @return {IReporterOutput} - output: the module graph in mermaid format, exitCode: 0
+	 * @returns {IReporterOutput} - output: the module graph in mermaid format, exitCode: 0
 	 */
 	export default function statsReporterPlugin(
 		pCruiseResult: ICruiseResult,

package/types/plugins/stats-reporter-plugin.d.mts

@@ -5,7 +5,7 @@ declare module "stats-reporter-plugin" {
 	 * Sample plugin: stats in json format
 	 *
 	 * @param {ICruiseResult} pCruiseResult - the output of a dependency-cruise adhering to dependency-cruiser's cruise result schema
-	 * @return {IReporterOutput} - output: output: some stats on modules and dependencies in json format, exitCode: 0
+	 * @returns {IReporterOutput} - output: output: some stats on modules and dependencies in json format, exitCode: 0
 	 */
 	export default function statsReporterPlugin(
 		pCruiseResult: ICruiseResult,