dependency-cruiser/src/analyze/derive/dependents.mjs

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

/** @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

	// 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") ||
		Object.hasOwn(pRule?.module ?? {}, "numberOfDependentsMoreThan")
		/* c8 ignore stop */
	);
}

/**
 * @param {IFlattenedRuleSet} pRuleSet
 * @returns {boolean}
 */
export function hasDependentsRule(pRuleSet) {
	return (
		(pRuleSet?.forbidden ?? []).some(isDependentsRule) ||
		(pRuleSet?.allowed ?? []).some(isDependentsRule)
	);
}
/**
 *
 * @param {Partial<import("../../../types/cruise-result.d.mts").IModule[]>} pModules
 * @param {import("../../../types/options.d.mts").ICruiseOptions} options
 * @returns
 */
export default function addDependents(
	pModules,
	{ skipAnalysisNotInRules, metrics, ruleSet, reaches, focus },
) {
	if (
		!skipAnalysisNotInRules ||
		metrics ||
		reaches ||
		focus ||
		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 = new ModuleGraphWithDependencySet(
			pModules,
		);

		return pModules.map((pModule) => ({
			...pModule,
			dependents: lModulesWithDependencySet.getDependents(pModule),
		}));
	}
	return pModules;
}