dependency-cruiser/src/graph-utl/rule-set.mjs

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

/**
 * @import {IFlattenedRuleSet, IForbiddenRuleType} from '../../types/rule-set.mjs';
 */

/**
 * Finds the first rule in the rule set that has name pName,
 * and undefined if no such rule exists/ the rule is an 'allowed'
 * rule.
 *
 * (this thing probably belongs in a model-like folder and not in utl)
 *
 * @param {IFlattenedRuleSet} pRuleSet - The rule set to search in
 * @param {string} pName - The rule name to look for
 * @return {IForbiddenRuleType|undefined} - a rule (or 'undefined' if nothing found)
 */
export function findRuleByName(pRuleSet, pName) {
	const lNamedRules = (pRuleSet?.forbidden ?? []).concat(
		pRuleSet?.required ?? [],
	);
	return lNamedRules.find((pRule) => pRule.name === pName);
}

function ruleHasALicenseLikeAttribute(pRule) {
	return (
		Object.hasOwn(pRule?.to ?? {}, "license") ||
		Object.hasOwn(pRule?.to ?? {}, "licenseNot")
	);
}

/**
 * Returns true if the rule set has a rule that uses the 'license' or
 * 'licenseNot' attribute.
 *
 * Returns false in all other cases
 *
 * @param {IFlattenedRuleSet} pRuleSet
 * @return {boolean}
 */
export function ruleSetHasLicenseRule(pRuleSet) {
	return (
		(pRuleSet?.forbidden ?? []).some(ruleHasALicenseLikeAttribute) ||
		(pRuleSet?.allowed ?? []).some(ruleHasALicenseLikeAttribute)
	);
}

/**
 * @param {IFlattenedRuleSet} pRuleSet
 * @return {boolean}
 */
export function ruleSetHasDeprecationRule(pRuleSet) {
	return (
		(pRuleSet?.forbidden ?? []).some((pRule) =>
			(pRule?.to?.dependencyTypes ?? []).includes("deprecated"),
		) ||
		(pRuleSet?.allowed ?? []).some((pRule) =>
			(pRule?.to?.dependencyTypes ?? []).includes("deprecated"),
		)
	);
}