dependency-cruiser 17.3.3-beta-4 → 17.3.4-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dependency-cruiser",
-	"version": "17.3.3-beta-4",
+	"version": "17.3.4-beta-1",
 	"description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
 	"keywords": [
 		"static analysis",
@@ -149,7 +149,7 @@
 		"acorn-loose": "8.5.2",
 		"acorn-walk": "8.3.4",
 		"commander": "14.0.2",
-		"enhanced-resolve": "5.18.3",
+		"enhanced-resolve": "5.18.4",
 		"ignore": "7.0.5",
 		"interpret": "3.1.1",
 		"is-installed-globally": "1.0.0",

package/src/cache/metadata-strategy.mjs

@@ -21,6 +21,7 @@ export default class MetaDataStrategy {
 	/**
 	 * @param {string} _pDirectory
 	 * @param {ICruiseResult} _pCachedCruiseResult
+	 * @param {IStrictCruiseOptions} pCruiseOptions
 	 * @param {Object} pOptions
 	 * @param {Set<string>} pOptions.extensions
 	 * @param {Set<changeType>=} pOptions.interestingChangeTypes

package/src/cli/init-config/environment-helpers.mjs

@@ -11,10 +11,10 @@ import { DEFAULT_CONFIG_FILE_NAME } from "../defaults.mjs";
 const LIKELY_SOURCE_FOLDERS = ["src", "lib", "app", "bin", "sources"];
 const LIKELY_TEST_FOLDERS = ["test", "spec", "tests", "specs", "bdd"];
 const LIKELY_PACKAGES_FOLDERS = ["packages"];
-const TSCONFIG_CANDIDATE_PATTERN = /.*tsconfig.*\.json$/gi;
-const JSCONFIG_CANDIDATE_PATTERN = /.*jsconfig.*\.json$/gi;
-const WEBPACK_CANDIDATE_PATTERN = /.*webpack.*\.(c?js|json5?|ts|ya?ml)$/gi;
-const BABEL_CONFIG_CANDIDATE_PATTERN = /^\.babelrc$|.*babel.*\.json/gi;
+const TSCONFIG_CANDIDATE_PATTERN = /.*tsconfig.*\.json$/i;
+const JSCONFIG_CANDIDATE_PATTERN = /.*jsconfig.*\.json$/i;
+const WEBPACK_CANDIDATE_PATTERN = /.*webpack.*\.(c?js|json5?|ts|ya?ml)$/i;
+const BABEL_CONFIG_CANDIDATE_PATTERN = /^\.babelrc$|.*babel.*\.json/i;
 
 /**
  * Read the package manifest ('package.json') and return it as a javascript object
@@ -93,7 +93,7 @@ function getMatchingFileNames(pPattern, pFolderName = process.cwd()) {
 	return readdirSync(pFolderName, "utf8").filter(
 		(pFileName) =>
 			statSync(join(pFolderName, pFileName)).isFile() &&
-			pFileName.match(pPattern),
+			pPattern.test(pFileName),
 	);
 }
 

package/src/enrich/derive/circular.mjs

@@ -1,4 +1,5 @@
 /* eslint-disable security/detect-object-injection */
+import IndexedModuleGraph from "#graph-utl/indexed-module-graph.mjs";
 
 /** @import { IFlattenedRuleSet } from "../../../types/rule-set.mjs" */
 
@@ -44,29 +45,33 @@ function addCircularityCheckToDependency(
 }
 
 /**
- * Runs through all dependencies of all pNodes, for each of them determines
+ * Runs through all dependencies of all pModulesOrFolders, for each of them determines
  * whether it's (part of a) circular (relationship) and returns the
  * dependencies with that added.
  */
 export default function detectAndAddCycles(
-	pNodes,
-	pIndexedNodes,
+	pModulesOrFolders,
 	{ pSourceAttribute, pDependencyName, pSkipAnalysisNotInRules, pRuleSet },
 ) {
 	if (!pSkipAnalysisNotInRules || hasCycleRule(pRuleSet)) {
-		return pNodes.map((pModule) => ({
-			...pModule,
-			dependencies: pModule.dependencies.map((pToDep) =>
+		const lIndexedGraph = new IndexedModuleGraph(
+			pModulesOrFolders,
+			pSourceAttribute,
+		);
+
+		return pModulesOrFolders.map((pModuleOrFolder) => ({
+			...pModuleOrFolder,
+			dependencies: pModuleOrFolder.dependencies.map((pToDep) =>
 				addCircularityCheckToDependency(
-					pIndexedNodes,
-					pModule[pSourceAttribute],
+					lIndexedGraph,
+					pModuleOrFolder[pSourceAttribute],
 					pToDep,
 					pDependencyName,
 				),
 			),
 		}));
 	}
-	return pNodes.map((pModule) => ({
+	return pModulesOrFolders.map((pModule) => ({
 		...pModule,
 		dependencies: pModule.dependencies.map((pToDep) => ({
 			...pToDep,

package/src/enrich/derive/dependents.mjs

@@ -1,13 +1,12 @@
-import { isDependent } from "./module-utl.mjs";
-
 /** @import { IFlattenedRuleSet } from "../../../types/rule-set.mjs" */
 
 function isDependentsRule(pRule) {
 	// used in folder rules and when moreUnstable is in the 'to' => governed by
-	// the 'metrics' flag in options, sot not going to repeat that here
+	// the 'metrics' flag in options, so not going to repeat that here
 
-	// dependents are used in the orphans analsys. However, there is a fall back
-	// where it does its own analysis, so not going to repeat that check here.
+	// dependents are used in the orphans analysis. However, there is a fall back
+	// where it does its own analysis which is faster on itself, so not going
+	// to repeat that check here either.
 	return (
 		/* c8 ignore start */
 		Object.hasOwn(pRule?.module ?? {}, "numberOfDependentsLessThan") ||
@@ -16,10 +15,10 @@ function isDependentsRule(pRule) {
 	);
 }
 
-export function getDependents(pModule, pModules) {
-	// perf between O(n) in an unconnected graph and O(n^2) in a fully connected one
-	return pModules
-		.filter(isDependent(pModule.source))
+export function getDependents(pModule, pModulesWithDependencySet) {
+	// perf O(n) as dependency-lookups are O(1)
+	return pModulesWithDependencySet
+		.filter(({ dependencies }) => dependencies.has(pModule.source))
 		.map((pDependentModule) => pDependentModule.source);
 }
 
@@ -39,9 +38,19 @@ export default function addDependents(
 	{ skipAnalysisNotInRules, metrics, ruleSet },
 ) {
 	if (!skipAnalysisNotInRules || metrics || hasDependentsRule(ruleSet)) {
+		// creating this optimized structure here might seem overkill, but on
+		// large graphs it pays off significantly - creation is a few centiseconds
+		// but it cuts analysis in half on large graphs (and even on smaller
+		// graphs it's a win, even though just a few milliseconds)
+		const lModulesWithDependencySet = pModules.map((pModule) => ({
+			source: pModule.source,
+			dependencies: new Set(
+				pModule.dependencies.map((pDependency) => pDependency.resolved),
+			),
+		}));
 		return pModules.map((pModule) => ({
 			...pModule,
-			dependents: getDependents(pModule, pModules),
+			dependents: getDependents(pModule, lModulesWithDependencySet),
 		}));
 	}
 	return pModules;

package/src/enrich/derive/folders/aggregate-to-folders.mjs

@@ -9,7 +9,6 @@ import {
 	getParentFolders,
 	object2Array,
 } from "./utl.mjs";
-import IndexedModuleGraph from "#graph-utl/indexed-module-graph.mjs";
 import { uniq } from "#utl/array-util.mjs";
 
 function upsertCouplings(pAllDependents, pNewDependents) {
@@ -148,7 +147,7 @@ export default function aggregateToFolders(pModules, pOptions = {}) {
 		.map(deNormalizeInstability);
 	lFolders = lFolders.concat(getSinks(lFolders));
 
-	return detectCycles(lFolders, new IndexedModuleGraph(lFolders, "name"), {
+	return detectCycles(lFolders, {
 		pSourceAttribute: "name",
 		pDependencyName: "name",
 		pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,

package/src/enrich/derive/metrics/get-module-metrics.mjs

@@ -1,5 +1,4 @@
 import { calculateInstability, metricsAreCalculable } from "../module-utl.mjs";
-import IndexedModuleGraph from "#graph-utl/indexed-module-graph.mjs";
 
 export function addInstabilityMetric(pModule) {
 	return {
@@ -15,25 +14,23 @@ export function addInstabilityMetric(pModule) {
 	};
 }
 
-function addInstabilityToDependency(pAllModules) {
-	const lIndexedModules = new IndexedModuleGraph(pAllModules);
+function addInstabilityToDependency(pIndexedModules) {
 	return (pDependency) => ({
 		...pDependency,
 		instability:
-			(lIndexedModules.findVertexByName(pDependency.resolved) || {})
+			(pIndexedModules.findVertexByName(pDependency.resolved) || {})
 				.instability || 0,
 	});
 }
 
 export function deNormalizeInstabilityMetricsToDependencies(
 	pModule,
-	_,
-	pAllModules,
+	pIndexedModules,
 ) {
 	return {
 		...pModule,
 		dependencies: pModule.dependencies.map(
-			addInstabilityToDependency(pAllModules),
+			addInstabilityToDependency(pIndexedModules),
 		),
 	};
 }

package/src/enrich/derive/metrics/index.mjs

@@ -2,12 +2,16 @@ import {
 	addInstabilityMetric,
 	deNormalizeInstabilityMetricsToDependencies,
 } from "./get-module-metrics.mjs";
+import IndexedModuleGraph from "#graph-utl/indexed-module-graph.mjs";
 
 export default function deriveModulesMetrics(pModules, pOptions) {
 	if (pOptions.metrics) {
-		return pModules
-			.map(addInstabilityMetric)
-			.map(deNormalizeInstabilityMetricsToDependencies);
+		const lModules = pModules.map(addInstabilityMetric);
+		const lIndexedModules = new IndexedModuleGraph(lModules);
+
+		return lModules.map((pModule) =>
+			deNormalizeInstabilityMetricsToDependencies(pModule, lIndexedModules),
+		);
 	}
 	return pModules;
 }

package/src/enrich/enrich-modules.mjs

@@ -5,7 +5,6 @@ import deriveReachable from "./derive/reachable.mjs";
 import addValidations from "./add-validations.mjs";
 import softenKnownViolations from "./soften-known-violations.mjs";
 import deriveModuleMetrics from "./derive/metrics/index.mjs";
-import IndexedModuleGraph from "#graph-utl/indexed-module-graph.mjs";
 import addFocus from "#graph-utl/add-focus.mjs";
 import { bus } from "#utl/bus.mjs";
 
@@ -18,8 +17,8 @@ import { bus } from "#utl/bus.mjs";
  */
 export default function enrichModules(pModules, pOptions) {
 	bus.info("analyze: cycles");
-	const lIndexedModules = new IndexedModuleGraph(pModules);
-	let lModules = deriveCycles(pModules, lIndexedModules, {
+
+	let lModules = deriveCycles(pModules, {
 		pSourceAttribute: "source",
 		pDependencyName: "resolved",
 		pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,

package/src/extract/extract-dependencies.mjs

@@ -14,6 +14,7 @@ import {
 	extractModuleAttributes,
 } from "./helpers.mjs";
 import { uniqBy, intersects } from "#utl/array-util.mjs";
+import { getCachedRegExp } from "#utl/regex-util.mjs";
 
 /**
  * @import { IDependency } from "../../types/cruise-result.mjs";
@@ -79,7 +80,7 @@ function extractDependencies(pCruiseOptions, pFileName, pTranspileOptions) {
 
 function matchesDoNotFollow({ resolved, dependencyTypes }, pDoNotFollow) {
 	const lMatchesPath = pDoNotFollow.path
-		? RegExp(pDoNotFollow.path, "g").test(resolved)
+		? getCachedRegExp(pDoNotFollow.path).test(resolved)
 		: false;
 	const lMatchesDependencyTypes = pDoNotFollow.dependencyTypes
 		? intersects(dependencyTypes, pDoNotFollow.dependencyTypes)
@@ -114,7 +115,7 @@ function addResolutionAttributes(
 }
 
 function matchesPattern(pFullPathToFile, pPattern) {
-	return RegExp(pPattern, "g").test(pFullPathToFile);
+	return getCachedRegExp(pPattern).test(pFullPathToFile);
 }
 
 /**
@@ -166,7 +167,6 @@ export default function getDependencies(
 			extractDependencies(pCruiseOptions, pFileName, pTranspileOptions),
 			getDependencyUniqueKey,
 		)
-			.sort(compareDeps)
 			.map(
 				addResolutionAttributes(
 					pCruiseOptions,
@@ -181,7 +181,8 @@ export default function getDependencies(
 						!matchesPattern(resolved, pCruiseOptions.exclude.path)) &&
 					(!pCruiseOptions?.includeOnly?.path ||
 						matchesPattern(resolved, pCruiseOptions.includeOnly.path)),
-			);
+			)
+			.sort(compareDeps);
 	} catch (pError) {
 		throw new Error(
 			`Extracting dependencies ran afoul of...\n\n  ${pError.message}\n... in ${pFileName}\n\n`,

package/src/extract/index.mjs

@@ -80,7 +80,6 @@ function extractFileDirectoryArray(
 	const lResult = [];
 	for (const lFilename of lInitialSources) {
 		if (!lVisited.has(lFilename)) {
-			lVisited.add(lFilename);
 			lResult.push(
 				...extractRecursive(
 					lFilename,
@@ -96,15 +95,7 @@ function extractFileDirectoryArray(
 	return lResult;
 }
 
-function isNotFollowable({ followable }) {
-	return !followable;
-}
-
-function notInFromListAlready(pFromList) {
-	return ({ resolved }) => !pFromList.some(({ source }) => source === resolved);
-}
-
-function toDependencyToSource(pToListItem) {
+function toDependencyAsModule(pToListItem) {
 	return {
 		source: pToListItem.resolved,
 		followable: pToListItem.followable,
@@ -116,18 +107,20 @@ function toDependencyToSource(pToListItem) {
 	};
 }
 
-function complete(pAll, pFromListItem) {
-	return pAll
-		.concat(pFromListItem)
+function complete(pModules, pModule) {
+	return pModules
+		.concat(pModule)
 		.concat(
-			pFromListItem.dependencies
-				.filter(isNotFollowable)
-				.filter(notInFromListAlready(pAll))
-				.map(toDependencyToSource),
+			pModule.dependencies
+				.filter(
+					({ followable, resolved }) =>
+						!followable && !pModules.some(({ source }) => source === resolved),
+				)
+				.map(toDependencyAsModule),
 		);
 }
 
-function filterExcludedDynamicDependencies(pModule, pExclude) {
+function removeExcludedDynamicDependencies(pModule, pExclude) {
 	// no need to do the 'path' thing as that was addressed in extractFileDirectoryArray already
 	return {
 		...pModule,
@@ -164,7 +157,7 @@ export default function extract(
 	)
 		.reduce(complete, [])
 		.map((pModule) =>
-			filterExcludedDynamicDependencies(pModule, pCruiseOptions.exclude),
+			removeExcludedDynamicDependencies(pModule, pCruiseOptions.exclude),
 		);
 	pResolveOptions.fileSystem.purge();
 	clearCaches();

package/src/extract/tsc/extract-typescript-deps.mjs

@@ -15,13 +15,16 @@ const typescript = await tryImport(
 	meta.supportedTranspilers.typescript,
 );
 
-const INTERESTING_NODE_KINDS = new Set([
-	typescript.SyntaxKind.CallExpression,
-	typescript.SyntaxKind.ExportDeclaration,
-	typescript.SyntaxKind.ImportDeclaration,
-	typescript.SyntaxKind.ImportEqualsDeclaration,
-	typescript.SyntaxKind.LastTypeNode,
-]);
+const INTERESTING_NODE_KINDS = typescript
+	? new Set([
+			typescript.SyntaxKind.CallExpression,
+			typescript.SyntaxKind.ExportDeclaration,
+			typescript.SyntaxKind.ImportDeclaration,
+			typescript.SyntaxKind.ImportEqualsDeclaration,
+			typescript.SyntaxKind.LastTypeNode,
+		])
+	: /* c8 ignore next 1 */
+		new Set();
 
 function isTypeOnlyImport(pStatement) {
 	return (

package/src/main/options/assert-validity.mjs

@@ -6,8 +6,8 @@ import { getAvailableReporters } from "#report/index.mjs";
  * @import { ICruiseOptions, IFormatOptions } from "../../../types/options.mjs";
  */
 
-const MODULE_SYSTEM_LIST_RE = /^(?:(?:cjs|amd|es6|tsd)(?:,|$)){1,4}/gi;
-const VALID_DEPTH_RE = /^\d{1,2}$/g;
+const MODULE_SYSTEM_LIST_RE = /^(?:(?:cjs|amd|es6|tsd)(?:,|$)){1,4}/i;
+const VALID_DEPTH_RE = /^\d{1,2}$/;
 
 function isObject(pObject) {
 	return (
@@ -37,7 +37,7 @@ function assertModuleSystemsValid(pModuleSystems) {
 		pModuleSystems &&
 		Array.isArray(pModuleSystems) &&
 		!pModuleSystems.every((pModuleSystem) =>
-			pModuleSystem.match(MODULE_SYSTEM_LIST_RE),
+			MODULE_SYSTEM_LIST_RE.test(pModuleSystem),
 		)
 	) {
 		throw new Error(
@@ -65,7 +65,7 @@ function assertOutputTypeValid(pOutputType) {
 }
 
 function assertMaxDepthValid(pDepth) {
-	if (pDepth && !pDepth.toString().match(VALID_DEPTH_RE)) {
+	if (pDepth && !VALID_DEPTH_RE.test(pDepth.toString())) {
 		throw new Error(
 			`'${pDepth}' is not a valid depth - use an integer between 0 and 99`,
 		);

package/src/meta.cjs

@@ -1,6 +1,6 @@
 /* generated - don't edit */
 module.exports = {
-	version: "17.3.3-beta-4",
+	version: "17.3.4-beta-1",
 	engines: {
 		node: "^20.12||^22||>=24",
 	},

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

@@ -34,7 +34,7 @@ function replaceFromWordList(pPathElement, pWordList, pCached) {
 export function anonymizePathElement(
 	pPathElement,
 	pWordList = [],
-	pWhiteListRE = /^$/g,
+	pWhiteListRE = /^$/,
 	pCached = true,
 ) {
 	return pWhiteListRE.test(pPathElement)

package/src/report/anon/index.mjs

@@ -151,8 +151,7 @@ function sanitizeWordList(pWordList) {
 	return pWordList
 		.map((pString) => pString.replaceAll(/[^a-zA-Z-]/g, "_"))
 		.filter(
-			(pString) =>
-				/^[a-zA-Z-_]+$/g.test(pString) && !WHITELIST_RE.test(pString),
+			(pString) => /^[a-zA-Z-_]+$/.test(pString) && !WHITELIST_RE.test(pString),
 		);
 }
 

package/src/report/dot/theming.mjs

@@ -1,15 +1,12 @@
 import DEFAULT_THEME from "./default-theme.mjs";
 import { attributizeObject } from "./module-utl.mjs";
 import { has, get } from "#utl/object-util.mjs";
-
-function matchesRE(pValue, pRE) {
-	const lMatchResult = pValue.match && pValue.match(pRE);
-
-	return lMatchResult && lMatchResult.length > 0;
-}
+import { getCachedRegExp } from "#utl/regex-util.mjs";
 
 function matchesCriterion(pModuleKey, pCriterion) {
-	return pModuleKey === pCriterion || matchesRE(pModuleKey, pCriterion);
+	return (
+		pModuleKey === pCriterion || getCachedRegExp(pCriterion).test(pModuleKey)
+	);
 }
 
 function moduleOrDependencyMatchesCriteria(pSchemeEntry, pModule) {

package/src/utl/extract-root-module-name.cjs

@@ -1,5 +1,5 @@
-const LOCAL_MODULE_RE = /^[.]{1,2}($|\/.*)/g;
-const ABSOLUTE_MODULE_RE = /^\/.*/g;
+const LOCAL_MODULE_RE = /^[.]{1,2}($|\/.*)/;
+const ABSOLUTE_MODULE_RE = /^\/.*/;
 
 const PACKAGE_RE = "[^/]+";
 const SCOPED_PACKAGE_RE = "@[^/]+(/[^/]+)";
@@ -13,8 +13,8 @@ const ROOT_MODULE_RE = new RegExp(`^(${SCOPED_PACKAGE_RE}|${PACKAGE_RE})`, "g");
  */
 module.exports = function extractRootModuleName(pModuleName) {
 	if (
-		pModuleName.match(LOCAL_MODULE_RE) ||
-		pModuleName.match(ABSOLUTE_MODULE_RE)
+		LOCAL_MODULE_RE.test(pModuleName) ||
+		ABSOLUTE_MODULE_RE.test(pModuleName)
 	) {
 		return pModuleName;
 	} else {