feat(builder): add rulesdir option (#589)

Author: JamesHenry

packages/builder/src/lint.impl.spec.ts

@@ -70,6 +70,7 @@ function createValidRunBuilderOptions(
     ignorePath: null,
     outputFile: null,
     noEslintrc: false,
+    rulesdir: [],
     ...additionalOptions,
   };
 }
@@ -147,6 +148,7 @@ describe('Linter Builder', () => {
         outputFile: null,
         ignorePath: null,
         noEslintrc: false,
+        rulesdir: [],
       }),
       mockContext,
     );
@@ -169,6 +171,7 @@ describe('Linter Builder', () => {
         outputFile: null,
         ignorePath: null,
         noEslintrc: false,
+        rulesdir: [],
       },
     );
   });

packages/builder/src/schema.d.ts

@@ -15,6 +15,7 @@ export interface Schema extends JsonObject {
   ignorePath: string | null;
   outputFile: string | null;
   noEslintrc: boolean;
+  rulesdir: string[];
 }
 
 type Formatter =

packages/builder/src/schema.json

@@ -93,6 +93,14 @@
       "type": "boolean",
       "description": "The equivalent of the --no-eslintrc flag on the ESLint CLI, it is false by default",
       "default": false
+    },
+    "rulesdir": {
+      "type": "array",
+      "description": "The equivalent of the --rulesdir flag on the ESLint CLI, it is an empty array by default",
+      "default": [],
+      "items": {
+        "type": "string"
+      }
     }
   },
   "additionalProperties": false,

packages/builder/src/utils/eslint-utils.spec.ts

@@ -37,6 +37,7 @@ describe('eslint-utils', () => {
       ignorePath: undefined,
       useEslintrc: true,
       errorOnUnmatchedPattern: false,
+      rulePaths: [],
     });
   });
 
@@ -58,6 +59,7 @@ describe('eslint-utils', () => {
       ignorePath: undefined,
       useEslintrc: true,
       errorOnUnmatchedPattern: false,
+      rulePaths: [],
     });
   });
 
@@ -79,6 +81,32 @@ describe('eslint-utils', () => {
         ignorePath: undefined,
         useEslintrc: false,
         errorOnUnmatchedPattern: false,
+        rulePaths: [],
+      });
+    });
+  });
+
+  describe('rulesdir', () => {
+    it('should create the ESLint instance with "rulePaths" set to the given value for rulesdir', async () => {
+      const extraRuleDirectories = ['./some-rules', '../some-more-rules'];
+      await lint('/root', undefined, {
+        fix: true,
+        cache: true,
+        cacheLocation: '/root/cache',
+        cacheStrategy: 'content',
+        rulesdir: extraRuleDirectories,
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+      }).catch(() => {});
+
+      expect(ESLint).toHaveBeenCalledWith({
+        fix: true,
+        cache: true,
+        cacheLocation: '/root/cache',
+        cacheStrategy: 'content',
+        ignorePath: undefined,
+        useEslintrc: true,
+        errorOnUnmatchedPattern: false,
+        rulePaths: extraRuleDirectories,
       });
     });
   });

packages/builder/src/utils/eslint-utils.ts

@@ -31,6 +31,7 @@ export async function lint(
     cache: !!options.cache,
     cacheLocation: options.cacheLocation || undefined,
     cacheStrategy: options.cacheStrategy || undefined,
+    rulePaths: options.rulesdir || [],
     /**
      * Default is `true` and if not overridden the eslint.lintFiles() method will throw an error
      * when no target files are found.