dependency-cruiser/src/enrich/soften-known-violations.mjs

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

import { bus } from "../utl/bus.mjs";
import isSameViolation from "./summarize/is-same-violation.mjs";

function softenModuleViolation(
  pRule,
  pModuleSource,
  pKnownModuleViolations,
  pSoftenedSeverity
) {
  return {
    ...pRule,
    severity: pKnownModuleViolations.some(
      (pKnownError) =>
        pKnownError.from === pModuleSource &&
        pKnownError.rule.name === pRule.name
    )
      ? pSoftenedSeverity
      : pRule.severity,
  };
}

function softenDependencyViolation(
  pViolationKey,
  pKnownDependencyViolations,
  pSoftenedSeverity
) {
  return {
    ...pViolationKey.rule,
    severity: pKnownDependencyViolations.some((pKnownError) =>
      isSameViolation(pKnownError, pViolationKey)
    )
      ? pSoftenedSeverity
      : pViolationKey.rule.severity,
  };
}

function softenDependencyViolations(
  pDependency,
  pModuleSource,
  pKnownDependencyViolations,
  pSoftenedSeverity
) {
  if (!pDependency.valid) {
    return {
      ...pDependency,
      rules: pDependency.rules.map((pRule) =>
        softenDependencyViolation(
          {
            rule: pRule,
            from: pModuleSource,
            to: pDependency.resolved,
            cycle: pDependency.cycle,
          },
          pKnownDependencyViolations,
          pSoftenedSeverity
        )
      ),
    };
  }
  return pDependency;
}
/**
 *
 * @param {import("../../types/cruise-result.js").IModule} pModule
 * @param {import("../../types/baseline-violations.js").IBaselineViolations} pKnownViolations
 * @param {import("../../types/shared-types.js").SeverityType} pSoftenedSeverity
 * @returns {import("../../types/cruise-result.js").IModule}
 */
function softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity) {
  let lReturnValue = pModule;

  if (!pModule.valid) {
    lReturnValue = {
      ...pModule,
      rules: pModule.rules.map((pRule) =>
        softenModuleViolation(
          pRule,
          pModule.source,
          pKnownViolations.filter(
            (pKnownError) =>
              pKnownError.from === pKnownError.to && !pKnownError.cycle
          ),
          pSoftenedSeverity
        )
      ),
    };
  }

  lReturnValue = {
    ...lReturnValue,
    dependencies: pModule.dependencies.map((pDependency) =>
      softenDependencyViolations(
        pDependency,
        pModule.source,
        pKnownViolations.filter(
          (pKnownError) =>
            pKnownError.from !== pKnownError.to || pKnownError.cycle
        ),
        pSoftenedSeverity
      )
    ),
  };

  return lReturnValue;
}

/**
 *
 * @param {import("../../types/cruise-result.js").IModule[]} pModules
 * @param {import("../../types/baseline-violations.js").IBaselineViolations} pKnownViolations
 * @param {import("../../types/shared-types.js").SeverityType} pSoftenedSeverity
 * @returns {import("../../types/cruise-result.js").IModule[]}
 */
export default function softenKnownViolations(
  pModules,
  pKnownViolations,
  pSoftenedSeverity = "ignore"
) {
  if (Boolean(pKnownViolations)) {
    bus.info("analyzing: comparing against known errors");
    return pModules.map((pModule) =>
      softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity)
    );
  }
  return pModules;
}