allow from and to file exceptions in dep cruiser config

electrovir · Oct 11, 2023 · 25a8d3a · 25a8d3a
1 parent db8b624
commit 25a8d3a
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 29 deletions.
diff --git a/configs/configs/dep-cruiser.config.ts b/configs/configs/dep-cruiser.config.ts
@@ -4,9 +4,11 @@ import {generateDepCruiserConfig} from 'virmator/dist/compiled-base-configs/base
 const depCruiserConfig: IConfiguration = generateDepCruiserConfig({
     fileExceptions: {
         // enter file exceptions by rule name here
-        'no-orphans': [
-            'src/index.ts',
-        ],
+        'no-orphans': {
+            from: [
+                'src/index.ts',
+            ],
+        },
     },
     omitRules: [
         // enter rule names here to omit

diff --git a/configs/dep-cruiser.config.ts b/configs/dep-cruiser.config.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "virmator",
-    "version": "9.0.2",
+    "version": "9.1.0",
     "description": "Handle common package configs, commands, and dependencies.",
     "keywords": [
         "automation",

diff --git a/src/compiled-base-configs/base-dep-cruiser.config.ts b/src/compiled-base-configs/base-dep-cruiser.config.ts
@@ -1,11 +1,21 @@
-import type {IConfiguration} from 'dependency-cruiser';
+import type {IConfiguration, IForbiddenRuleType} from 'dependency-cruiser';
 
 export function generateDepCruiserConfig({
     fileExceptions,
     omitRules,
 }: {
-    fileExceptions: Record<string, string[]>;
-    omitRules: string[];
+    fileExceptions: Readonly<
+        Record<
+            string,
+            Readonly<
+                Partial<{
+                    to: ReadonlyArray<string> | undefined;
+                    from: ReadonlyArray<string> | undefined;
+                }>
+            >
+        >
+    >;
+    omitRules: ReadonlyArray<string>;
 }) {
     const forbiddenRules = [
         /* rules from the 'recommended' preset: */
@@ -170,18 +180,37 @@ export function generateDepCruiserConfig({
             ruleName,
             fileExceptions,
         ]) => {
-            const rule = forbiddenRules.find((rule) => rule.name === ruleName);
+            const rule: IForbiddenRuleType | undefined = forbiddenRules.find(
+                (rule) => rule.name === ruleName,
+            );
 
             if (!rule) {
                 throw new Error(`Rule name not used: '${ruleName}'`);
             }
 
-            const pathNot = rule.from.pathNot ?? [];
+            const fromPathNot: string[] = rule.from.pathNot
+                ? Array.isArray(rule.from.pathNot)
+                    ? rule.from.pathNot
+                    : [rule.from.pathNot]
+                : [];
+            const toPathNot: string[] = rule.to.pathNot
+                ? Array.isArray(rule.to.pathNot)
+                    ? rule.to.pathNot
+                    : [rule.to.pathNot]
+                : [];
 
-            pathNot.push(...fileExceptions);
+            if (fileExceptions.from?.length) {
+                fromPathNot.push(...fileExceptions.from);
+            }
+            if (fileExceptions.to?.length) {
+                toPathNot.push(...fileExceptions.to);
+            }
 
             if (!rule.from.pathNot) {
-                (rule.from as {pathNot: string[]}).pathNot = pathNot;
+                (rule.from as {pathNot: string[]}).pathNot = fromPathNot;
+            }
+            if (!rule.to.pathNot) {
+                (rule.to as {pathNot: string[]}).pathNot = toPathNot;
             }
         },
     );