fix: correct overrideConfigFile type (#19289)

eslint · Dec 29, 2024 · da768d4 · da768d4
1 parent 8c07ebb
commit da768d4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -1484,7 +1484,7 @@ export namespace ESLint {
         allowInlineConfig?: boolean | undefined;
         baseConfig?: Linter.Config | Linter.Config[] | null | undefined;
         overrideConfig?: Linter.Config | Linter.Config[] | null | undefined;
-        overrideConfigFile?: string | boolean | undefined;
+        overrideConfigFile?: string | true | null | undefined;
         plugins?: Record<string, Plugin> | null | undefined;
         ruleFilter?: ((arg: { ruleId: string; severity: Exclude<Linter.Severity, 0> }) => boolean) | undefined;
         stats?: boolean | undefined;

diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -927,8 +927,6 @@ linterWithEslintrcConfig.getRules();
     eslint = new ESLint();
     eslint = new ESLint({ allowInlineConfig: false });
     eslint = new ESLint({ baseConfig: {} });
-    eslint = new ESLint({ overrideConfig: {} });
-    eslint = new ESLint({ overrideConfigFile: "foo" });
     eslint = new ESLint({ cache: true });
     eslint = new ESLint({ cacheLocation: "foo" });
     eslint = new ESLint({ cacheStrategy: "content" });
@@ -941,6 +939,14 @@ linterWithEslintrcConfig.getRules();
     eslint = new ESLint({ globInputPaths: true });
     eslint = new ESLint({ ignore: true });
     eslint = new ESLint({ ignorePatterns: ["foo", "bar"] });
+    eslint = new ESLint({ overrideConfig: {} });
+
+    eslint = new ESLint({ overrideConfigFile: "foo" });
+    eslint = new ESLint({ overrideConfigFile: true });
+    eslint = new ESLint({ overrideConfigFile: null });
+    // @ts-expect-error `overrideConfigFile` cannot be `false`
+    eslint = new ESLint({ overrideConfigFile: false });
+
     eslint = new ESLint({ plugins: { foo: {} } });
     eslint = new ESLint({
         ruleFilter({ severity }) {