fix: correct typings for loadESLint() and shouldUseFlatConfig() (#20393)

lumirlumir · web-flow · commit ba6ebfa78de0 · 2025-12-13T00:06:17.000+05:30
* fix: correct typings for `loadESLint()`

* wip: update `shouldUseFlatConfig`

* wip: update JSDoc
diff --git a/lib/api.js b/lib/api.js
@@ -19,8 +19,8 @@ const { SourceCode } = require("./languages/js/source-code");
 //-----------------------------------------------------------------------------
 
 /**
- * Loads the correct ESLint constructor given the options.
- * @returns {Promise<ESLint>} The ESLint constructor
+ * Loads the correct `ESLint` constructor.
+ * @returns {Promise<ESLint>} The ESLint constructor.
  */
 async function loadESLint() {
 	return ESLint;
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -1346,7 +1346,7 @@ class ESLint {
 
 /**
  * Returns whether flat config should be used.
- * @returns {Promise<boolean>} Whether flat config should be used.
+ * @returns {Promise<true>} Whether flat config should be used.
  */
 async function shouldUseFlatConfig() {
 	return true;
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -115,7 +115,7 @@ export namespace AST {
 		end: ESTree.Position;
 	}
 
-	type Range = [number, number];
+	type Range = SourceRange;
 
 	interface Program extends ESTree.Program {
 		comments: ESTree.Comment[];
@@ -1344,9 +1344,10 @@ export namespace ESLint {
 
 // #endregion
 
-export function loadESLint(options?: {
-	useFlatConfig?: boolean | undefined;
-}): Promise<typeof ESLint>;
+/**
+ * Loads the correct `ESLint` constructor.
+ */
+export function loadESLint(): Promise<typeof ESLint>;
 
 // #region RuleTester
 
diff --git a/lib/types/use-at-your-own-risk.d.ts b/lib/types/use-at-your-own-risk.d.ts
@@ -31,4 +31,4 @@ import { Rule } from "./index.js";
 export const builtinRules: Map<string, Rule.RuleModule>;
 
 /** @deprecated */
-export function shouldUseFlatConfig(): Promise<boolean>;
+export function shouldUseFlatConfig(): Promise<true>;
diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -2302,11 +2302,16 @@ flatConfigWithRules.rules; // $ExpectType Partial<ESLintRules> | undefined
 
 async (useFlatConfig?: boolean) => {
 	await loadESLint(); // $ExpectType typeof ESLint
-	await loadESLint({}); // $ExpectType typeof ESLint
-	await loadESLint({ useFlatConfig: undefined }); // $ExpectType typeof ESLint
-	await loadESLint({ useFlatConfig: true }); // $ExpectType typeof ESLint
-	await loadESLint({ useFlatConfig: false }); // $ExpectType typeof ESLint
-	await loadESLint({ useFlatConfig }); // $ExpectType typeof ESLint
+	// @ts-expect-error `loadESLint()` does not accept arguments since ESLint v10.0.0
+	await loadESLint({});
+	// @ts-expect-error `loadESLint()` does not accept arguments since ESLint v10.0.0
+	await loadESLint({ useFlatConfig: undefined });
+	// @ts-expect-error `loadESLint()` does not accept arguments since ESLint v10.0.0
+	await loadESLint({ useFlatConfig: true });
+	// @ts-expect-error `loadESLint()` does not accept arguments since ESLint v10.0.0
+	await loadESLint({ useFlatConfig: false });
+	// @ts-expect-error `loadESLint()` does not accept arguments since ESLint v10.0.0
+	await loadESLint({ useFlatConfig });
 
 	const DefaultESLint = await loadESLint();
 	if (DefaultESLint.configType === "flat") {
@@ -2318,7 +2323,7 @@ async (useFlatConfig?: boolean) => {
 
 builtinRules; // $ExpectType Map<string, RuleModule>
 
-shouldUseFlatConfig(); // $ExpectType Promise<boolean>
+shouldUseFlatConfig(); // $ExpectType Promise<true>
 
 // #endregion
 
