dependency-cruiser 17.3.4-beta-1 → 17.3.5-beta-2

package/package.json

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

package/src/enrich/derive/dependents.mjs

@@ -1,5 +1,7 @@
 /** @import { IFlattenedRuleSet } from "../../../types/rule-set.mjs" */
 
+import ModuleGraphWithDependencySet from "#graph-utl/module-graph-with-dependency-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
@@ -15,13 +17,6 @@ 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))
-		.map((pDependentModule) => pDependentModule.source);
-}
-
 /**
  * @param {IFlattenedRuleSet} pRuleSet
  * @returns {boolean}
@@ -42,15 +37,13 @@ export default function addDependents(
 		// 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),
-			),
-		}));
+		const lModulesWithDependencySet = new ModuleGraphWithDependencySet(
+			pModules,
+		);
+
 		return pModules.map((pModule) => ({
 			...pModule,
-			dependents: getDependents(pModule, lModulesWithDependencySet),
+			dependents: lModulesWithDependencySet.getDependents(pModule),
 		}));
 	}
 	return pModules;

package/src/enrich/derive/module-utl.mjs

@@ -1,10 +1,3 @@
-export function isDependent(pResolvedName) {
-	return (pModule) =>
-		pModule.dependencies.some(
-			(pDependency) => pDependency.resolved === pResolvedName,
-		);
-}
-
 export function metricsAreCalculable(pModule) {
 	return (
 		!pModule.coreModule &&

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

@@ -1,4 +1,5 @@
 import isOrphan from "./is-orphan.mjs";
+import ModuleGraphWithDependencySet from "#graph-utl/module-graph-with-dependency-set.mjs";
 
 /** @import { IFlattenedRuleSet } from "../../../../types/rule-set.mjs" */
 
@@ -25,9 +26,19 @@ export default function deriveOrphans(
 	{ skipAnalysisNotInRules, ruleSet },
 ) {
 	if (!skipAnalysisNotInRules || hasOrphanRule(ruleSet)) {
+		// just like the dependents derivation, creating this data structure
+		// might seem overkill, but it can save effort here as well, even though
+		// isOrphan has early exits the dependents derivation doesn't:
+		// - when the module already has dependencies (quick length check)
+		// - when dependents are already calculated (quick length check as well). If
+		//   they are, the lModulesWithDependencySet is created for naught.
+		const lModulesWithDependencySet = new ModuleGraphWithDependencySet(
+			pModules,
+		);
+
 		return pModules.map((pModule) => ({
 			...pModule,
-			orphan: isOrphan(pModule, pModules),
+			orphan: isOrphan(pModule, lModulesWithDependencySet),
 		}));
 	}
 	return pModules;

package/src/enrich/derive/orphan/is-orphan.mjs

@@ -1,6 +1,11 @@
-import { isDependent } from "../module-utl.mjs";
-
-export default function isOrphan(pModule, pGraph) {
+/**
+ * returns true if the given module has no dependencies and no dependents
+ *
+ * @param {import("../../../../types/dependency-cruiser.mjs").IModule} pModule
+ * @param {import("#graph-utl/module-graph-with-dependency-set.mjs").default} pModulesWithDependencySet
+ * @returns {boolean}
+ */
+export default function isOrphan(pModule, pModulesWithDependencySet) {
 	if (pModule.dependencies.length > 0) {
 		return false;
 	}
@@ -10,5 +15,5 @@ export default function isOrphan(pModule, pGraph) {
 		return pModule.dependents.length === 0;
 	}
 	// ... otherwise calculate them
-	return !pGraph.some(isDependent(pModule.source));
+	return !pModulesWithDependencySet.moduleHasDependents(pModule);
 }

package/src/graph-utl/module-graph-with-dependency-set.mjs

@@ -0,0 +1,41 @@
+export default class ModuleGraphWithDependencySet {
+	/** @type {Array<{source: string, dependencies: Set<string>}>} */
+	#modulesWithDependencySet;
+	/**
+	 * Creates a module graph optimized for querying dependents
+	 * @constructor
+	 * @param {import("../../types/dependency-cruiser.mjs").IModule[]} pModules
+	 */
+	constructor(pModules) {
+		this.#modulesWithDependencySet = pModules.map((pModule) => ({
+			source: pModule.source,
+			dependencies: new Set(
+				pModule.dependencies.map((pDependency) => pDependency.resolved),
+			),
+		}));
+	}
+
+	/**
+	 * Returns true if the given module has dependents in the graph, false otherwise
+	 *
+	 * @param {import("../../types/dependency-cruiser.mjs").IModule} pModule
+	 * @returns {boolean}
+	 */
+	moduleHasDependents(pModule) {
+		return this.#modulesWithDependencySet.some(({ dependencies }) =>
+			dependencies.has(pModule.source),
+		);
+	}
+
+	/**
+	 * Returns an array of module source paths that depend on the given module
+	 *
+	 * @param {import("../../types/dependency-cruiser.mjs").IModule} pModule
+	 * @returns {Array<string>}
+	 */
+	getDependents(pModule) {
+		return this.#modulesWithDependencySet
+			.filter(({ dependencies }) => dependencies.has(pModule.source))
+			.map(({ source }) => source);
+	}
+}

package/src/meta.cjs

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