dependency-cruiser/src/validate/match-folder-dependency-rule.mjs

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

import { isModuleOnlyRule, isFolderScope } from "./rule-classifiers.mjs";
import { propertyEquals, matchesToIsMoreUnstable } from "./matchers.mjs";
import { extractGroups, replaceGroupPlaceholders } from "#utl/regex-util.mjs";

function fromFolderPath(pRule, pFromFolder) {
  return Boolean(!pRule.from.path || pFromFolder.name.match(pRule.from.path));
}

function fromFolderPathNot(pRule, pFromFolder) {
  return Boolean(
    !pRule.from.pathNot || !pFromFolder.name.match(pRule.from.pathNot),
  );
}

function toFolderPath(pRule, pToFolder, pGroups) {
  return Boolean(
    !pRule.to.path ||
      pToFolder.name.match(replaceGroupPlaceholders(pRule.to.path, pGroups)),
  );
}

function toFolderPathNot(pRule, pToFolder, pGroups) {
  return Boolean(
    !pRule.to.pathNot ||
      !pToFolder.name.match(
        replaceGroupPlaceholders(pRule.to.pathNot, pGroups),
      ),
  );
}

/**
 *
 * @param {import("../../types/cruise-result.mjs").IFolder} pFromFolder
 * @param {import("../../types/cruise-result.mjs").IFolderDependency} pToFolder
 * @returns {(pRule) => boolean}
 */
function match(pFromFolder, pToFolder) {
  return (pRule) => {
    const lGroups = extractGroups(pRule.from, pFromFolder.name);

    // TODO: via's
    return (
      fromFolderPath(pRule, pFromFolder) &&
      fromFolderPathNot(pRule, pFromFolder) &&
      toFolderPath(pRule, pToFolder, lGroups) &&
      toFolderPathNot(pRule, pToFolder, lGroups) &&
      matchesToIsMoreUnstable(pRule, pFromFolder, pToFolder) &&
      propertyEquals(pRule, pToFolder, "circular")
    );
  };
}
/**
 *
 * @param {any} pRule
 * @returns boolean
 */
const isInteresting = (pRule) =>
  isFolderScope(pRule) && !isModuleOnlyRule(pRule);

export default {
  match,
  isInteresting,
};