dependency-cruiser 17.3.4-beta-1 → 17.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dependency-cruiser",
-	"version": "17.3.4-beta-1",
+	"version": "17.3.4",
 	"description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
 	"keywords": [
 		"static analysis",

package/src/cache/metadata-strategy.mjs

@@ -21,7 +21,6 @@ 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/enrich/derive/circular.mjs

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

package/src/enrich/derive/dependents.mjs

@@ -1,12 +1,13 @@
+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, so not going to repeat that here
+	// the 'metrics' flag in options, sot not going to repeat that 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.
+	// 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.
 	return (
 		/* c8 ignore start */
 		Object.hasOwn(pRule?.module ?? {}, "numberOfDependentsLessThan") ||
@@ -15,10 +16,10 @@ function isDependentsRule(pRule) {
 	);
 }
 
-export function getDependents(pModule, pModulesWithDependencySet) {
-	// perf O(n) as dependency-lookups are O(1)
-	return pModulesWithDependencySet
-		.filter(({ dependencies }) => dependencies.has(pModule.source))
+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))
 		.map((pDependentModule) => pDependentModule.source);
 }
 
@@ -38,19 +39,9 @@ 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, lModulesWithDependencySet),
+			dependents: getDependents(pModule, pModules),
 		}));
 	}
 	return pModules;

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

@@ -9,6 +9,7 @@ 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) {
@@ -147,7 +148,7 @@ export default function aggregateToFolders(pModules, pOptions = {}) {
 		.map(deNormalizeInstability);
 	lFolders = lFolders.concat(getSinks(lFolders));
 
-	return detectCycles(lFolders, {
+	return detectCycles(lFolders, new IndexedModuleGraph(lFolders, "name"), {
 		pSourceAttribute: "name",
 		pDependencyName: "name",
 		pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,

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

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

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

@@ -2,16 +2,12 @@ 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) {
-		const lModules = pModules.map(addInstabilityMetric);
-		const lIndexedModules = new IndexedModuleGraph(lModules);
-
-		return lModules.map((pModule) =>
-			deNormalizeInstabilityMetricsToDependencies(pModule, lIndexedModules),
-		);
+		return pModules
+			.map(addInstabilityMetric)
+			.map(deNormalizeInstabilityMetricsToDependencies);
 	}
 	return pModules;
 }

package/src/enrich/enrich-modules.mjs

@@ -5,6 +5,7 @@ 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";
 
@@ -17,8 +18,8 @@ import { bus } from "#utl/bus.mjs";
  */
 export default function enrichModules(pModules, pOptions) {
 	bus.info("analyze: cycles");
-
-	let lModules = deriveCycles(pModules, {
+	const lIndexedModules = new IndexedModuleGraph(pModules);
+	let lModules = deriveCycles(pModules, lIndexedModules, {
 		pSourceAttribute: "source",
 		pDependencyName: "resolved",
 		pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,

package/src/meta.cjs

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