dependency-cruiser/src/validate/rule-classifiers.mjs

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

import has from "lodash/has.js";

/**
 * @param {import("../../types/strict-rule-set").IStrictAnyRuleType} pRule a dependency-cruiser rule
 * @returns {boolean} whether or not the rule is 'module only'
 */
export function isModuleOnlyRule(pRule) {
  return (
    has(pRule, "from.orphan") ||
    // note: the to might become optional for required rules
    has(pRule, "to.reachable") ||
    has(pRule, "module")
  );
}
/**
 *
 * @param {import("../../types/strict-rule-set").IStrictAnyRuleType} pRule
 * @returns {boolean} whether or not the scope of the rule is "folder" or something else
 */
export function isFolderScope(pRule) {
  // TODO might be possible to just rule pRule.scope as it's now
  // normalized away before getting here.
  return (pRule?.scope ?? "module") === "folder";
}

export default { isModuleOnlyRule, isFolderScope };