feat(builder): add resolvePluginsRelativeTo option (#590)

Author: JamesHenry

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

@@ -71,6 +71,7 @@ function createValidRunBuilderOptions(
     outputFile: null,
     noEslintrc: false,
     rulesdir: [],
+    resolvePluginsRelativeTo: null,
     ...additionalOptions,
   };
 }
@@ -149,6 +150,7 @@ describe('Linter Builder', () => {
         ignorePath: null,
         noEslintrc: false,
         rulesdir: [],
+        resolvePluginsRelativeTo: null,
       }),
       mockContext,
     );
@@ -172,6 +174,7 @@ describe('Linter Builder', () => {
         ignorePath: null,
         noEslintrc: false,
         rulesdir: [],
+        resolvePluginsRelativeTo: null,
       },
     );
   });

packages/builder/src/schema.d.ts

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

packages/builder/src/schema.json

@@ -101,6 +101,10 @@
       "items": {
         "type": "string"
       }
+    },
+    "resolvePluginsRelativeTo": {
+      "type": "string",
+      "description": "The equivalent of the --resolve-plugins-relative-to flag on the ESLint CLI"
     }
   },
   "additionalProperties": false,

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

@@ -110,4 +110,29 @@ describe('eslint-utils', () => {
       });
     });
   });
+
+  describe('resolvePluginsRelativeTo', () => {
+    it('should create the ESLint instance with "resolvePluginsRelativeTo" set to the given value for resolvePluginsRelativeTo', async () => {
+      await lint('/root', undefined, {
+        fix: true,
+        cache: true,
+        cacheLocation: '/root/cache',
+        cacheStrategy: 'content',
+        resolvePluginsRelativeTo: './some-path',
+        // 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: [],
+        resolvePluginsRelativeTo: './some-path',
+      });
+    });
+  });
 });

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,
+    resolvePluginsRelativeTo: options.resolvePluginsRelativeTo || undefined,
     rulePaths: options.rulesdir || [],
     /**
      * Default is `true` and if not overridden the eslint.lintFiles() method will throw an error