feat(report/dot): adds ability to match arrays for conditional coloring

doc/options-reference.md

@@ -841,7 +841,9 @@ Most representational aspects of the 'dot' reporter are customizable:
  - You can use any
  [module attribute](https://github.com/sverweij/dependency-cruiser/blob/main/types/cruise-result.d.ts#L16)
  and any [dependency attribute](https://github.com/sverweij/dependency-cruiser/blob/main/types/cruise-result.d.ts#L73)
- for dependencies.
+ for dependencies in the criteria of those.
+ - If you provide an array of criteria for the attributes the module/ dependency
+ will be matched if it matches _any_ of the criteria.
  - For attributes you can use anything GraphViz dot can understand as an attribute
  (see their [attributes](https://graphviz.gitlab.io/_pages/doc/info/attrs.html)
  documentation for a complete overview).

src/report/dot/theming.mjs

@@ -8,13 +8,42 @@ function matchesRE(pValue, pRE) {
  return Boolean(lMatchResult) && lMatchResult.length > 0;
 }
 
+function matchesCriterion(pModuleKey, pCriterion) {
+ return pModuleKey === pCriterion || matchesRE(pModuleKey, pCriterion);
+}
+
 function moduleOrDependencyMatchesCriteria(pSchemeEntry, pModule) {
- return Object.keys(pSchemeEntry.criteria).every(
- (pKey) =>
- (get(pModule, pKey) || has(pModule, pKey)) &&
- (get(pModule, pKey) === get(pSchemeEntry.criteria, pKey) ||
- matchesRE(get(pModule, pKey), get(pSchemeEntry.criteria, pKey))),
- );
+ return Object.keys(pSchemeEntry.criteria).every((pKey) => {
+ // we use lodash.get here because in the criteria you can enter
+ // nested keys like "rules[0].severity" : "error", and lodash.get handles
+ // that for us
+ const lCriterion = get(pSchemeEntry.criteria, pKey);
+ const lModuleKey = get(pModule, pKey);
+
+ if (!(lModuleKey || has(pModule, pKey))) {
+ return false;
+ }
+
+ if (Array.isArray(lModuleKey)) {
+ if (Array.isArray(lCriterion)) {
+ return lCriterion.some((pCriterionEntry) =>
+ lModuleKey.some((pModuleKeyEntry) =>
+ matchesCriterion(pModuleKeyEntry, pCriterionEntry),
+ ),
+ );
+ } else {
+ return lModuleKey.some((pModuleKeyEntry) =>
+ matchesCriterion(pModuleKeyEntry, lCriterion),
+ );
+ }
+ }
+ if (Array.isArray(lCriterion)) {
+ return lCriterion.some((pCriterionEntry) =>
+ matchesCriterion(lModuleKey, pCriterionEntry),
+ );
+ }
+ return matchesCriterion(lModuleKey, lCriterion);
+ });
 }
 
 function determineAttributes(pModuleOrDependency, pAttributeCriteria) {

test/report/dot/theming.spec.mjs

@@ -45,4 +45,177 @@ describe("[U] report/dot/theming - determineModuleColors - default theme", () =>
  theming.normalizeTheme({ graph: { someAttribute: 1234 } });
  deepEqual(theming.normalizeTheme(), lOriginalDefaultTheme);
  });
+
+ it("determines attributes when the property is a string and one of the criteria is an array", () => {
+ deepEqual(
+ theming.determineAttributes(
+ { source: "package.json" },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { source: ["package.json", "package-lock.json"] },
+ attributes: { fillcolor: "red" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "red" },
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is an array", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { dependencyTypes: ["aliased-tsconfig"] },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "blue" },
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is an array - on multiple it takes the logical OR", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: {
+ dependencyTypes: [
+ "npm",
+ "aliased-workspace",
+ "aliased-tsconfig",
+ ],
+ },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "blue" },
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is a regexy array", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { dependencyTypes: ["aliased-t.+"] },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "blue" },
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is a regexy array but there's no match", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { dependencyTypes: ["npm"] },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ {},
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is a string", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { dependencyTypes: "aliased-tsconfig" },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "blue" },
+ );
+ });
+
+ it("determines attributes when the property is an array and one of the criteria is a regexy string", () => {
+ deepEqual(
+ theming.determineAttributes(
+ {
+ source: "src/heide/does.js",
+ dependencyTypes: [
+ "local",
+ "aliased",
+ "aliased-tsconfig",
+ "aliased-tsconfig-base-url",
+ ],
+ },
+ theming.normalizeTheme({
+ modules: [
+ {
+ criteria: { dependencyTypes: "aliased-tsconfig" },
+ attributes: { fillcolor: "blue" },
+ },
+ ],
+ }).modules,
+ ),
+ { fillcolor: "blue" },
+ );
+ });
 });