docs: merge ESLint option descriptions into type definitions (#20608)

fasttime · web-flow · commit e972c88ab747 · 2026-03-12T04:59:41.000+03:00
* docs: merge ESLint option descriptions into type definitions

* fix typo
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -68,38 +68,11 @@ const { resolve } = require("../shared/relative-module-resolver.js");
 
 /** @typedef {import("../types").Linter.Config} Config */
 /** @typedef {import("../types").ESLint.DeprecatedRuleUse} DeprecatedRuleInfo */
+/** @typedef {import("../types").ESLint.Options} ESLintOptions */
 /** @typedef {import("../types").ESLint.LintResult} LintResult */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
 /** @typedef {import("../types").ESLint.ResultsMeta} ResultsMeta */
 
-/**
- * The options with which to configure the ESLint instance.
- * @typedef {Object} ESLintOptions
- * @property {boolean} [allowInlineConfig] Enable or disable inline configuration comments.
- * @property {Config|Array<Config>} [baseConfig] Base config, extended by all configs used with this instance
- * @property {boolean} [cache] Enable result caching.
- * @property {string} [cacheLocation] The cache file to use instead of .eslintcache.
- * @property {"metadata" | "content"} [cacheStrategy] The strategy used to detect changed files.
- * @property {number | "auto" | "off"} [concurrency] Maximum number of linting threads, "auto" to choose automatically, "off" for no multithreading.
- * @property {string} [cwd] The value to use for the current working directory.
- * @property {boolean} [errorOnUnmatchedPattern] If `false` then `ESLint#lintFiles()` doesn't throw even if no target files found. Defaults to `true`.
- * @property {boolean|Function} [fix] Execute in autofix mode. If a function, should return a boolean.
- * @property {string[]} [fixTypes] Array of rule types to apply fixes for.
- * @property {string[]} [flags] Array of feature flags to enable.
- * @property {boolean} [globInputPaths] Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
- * @property {boolean} [ignore] False disables all ignore patterns except for the default ones.
- * @property {string[]} [ignorePatterns] Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`.
- * @property {Config|Array<Config>} [overrideConfig] Override config, overrides all configs used with this instance
- * @property {boolean|string} [overrideConfigFile] Searches for default config file when falsy;
- *      doesn't do any config file lookup when `true`; considered to be a config filename
- *      when a string.
- * @property {boolean} [passOnNoPatterns=false] When set to true, missing patterns cause
- *      the linting operation to short circuit and not report any failures.
- * @property {Record<string,Plugin>} [plugins] An array of plugin implementations.
- * @property {boolean} [stats] True enables added statistics on lint results.
- * @property {boolean} [warnIgnored] Show warnings when the file list includes ignored files
- */
-
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
@@ -237,7 +210,7 @@ function compareResultsByFilePath(a, b) {
  *
  * This function is used primarily by the `--inspect-config` option. For now,
  * we will maintain the existing behavior, which is to search up from the cwd.
- * @param {ESLintOptions} options The ESLint instance options.
+ * @param {{ configFile: string | undefined; cwd: string; }} options Config file location options.
  * @returns {Promise<{configFilePath:string|undefined;basePath:string}>} Location information for
  *      the config file.
  */
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -1195,41 +1195,92 @@ export namespace ESLint {
 
 	type CacheStrategy = "content" | "metadata";
 
+	/** The options with which to configure the ESLint instance. */
 	interface Options {
 		// File enumeration
+
+		/** The value to use for the current working directory. */
 		cwd?: string | undefined;
+
+		/** If `false` then `ESLint#lintFiles()` doesn't throw even if no target files found. Defaults to `true`. */
 		errorOnUnmatchedPattern?: boolean | undefined;
+
+		/**
+		 * Set to false to skip glob resolution of input file paths to lint (default: true).
+		 * If false, each input file path is assumed to be a non-glob path to an existing file.
+		 */
 		globInputPaths?: boolean | undefined;
+
+		/** False disables all ignore patterns except for the default ones. */
 		ignore?: boolean | undefined;
+
+		/** Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`. */
 		ignorePatterns?: string[] | null | undefined;
+
+		/** When set to true, missing patterns cause the linting operation to short circuit and not report any failures. */
 		passOnNoPatterns?: boolean | undefined;
+
+		/** Show warnings when the file list includes ignored files. */
 		warnIgnored?: boolean | undefined;
 
 		// Linting
+
+		/** Enable or disable inline configuration comments. */
 		allowInlineConfig?: boolean | undefined;
+
+		/** Base config, extended by all configs used with this instance. */
 		baseConfig?: Linter.Config | Linter.Config[] | null | undefined;
+
+		/** Override config, overrides all configs used with this instance. */
 		overrideConfig?: Linter.Config | Linter.Config[] | null | undefined;
+
+		/**
+		 * Searches for default config file when falsy; doesn't do any config file lookup when `true`; considered to be a config filename when a string.
+		 */
 		overrideConfigFile?: string | true | null | undefined;
+
+		/** An array of plugin implementations. */
 		plugins?: Record<string, Plugin> | null | undefined;
+
+		/**
+		 * Default is `() => true`. A predicate function that filters rules to be run.
+		 * This function is called with an object containing `ruleId` and `severity`, and returns `true` if the rule should be run.
+		 */
 		ruleFilter?:
 			| ((arg: {
 					ruleId: string;
 					severity: Exclude<Linter.Severity, 0>;
 			  }) => boolean)
 			| undefined;
+
+		/** True enables added statistics on lint results. */
 		stats?: boolean | undefined;
 
 		// Autofix
+
+		/** Execute in autofix mode. If a function, should return a boolean. */
 		fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
+
+		/** Array of rule types to apply fixes for. */
 		fixTypes?: FixType[] | null | undefined;
 
 		// Cache-related
+
+		/** Enable result caching. */
 		cache?: boolean | undefined;
+
+		/** The cache file to use instead of .eslintcache. */
 		cacheLocation?: string | undefined;
+
+		/** The strategy used to detect changed files. */
 		cacheStrategy?: CacheStrategy | undefined;
 
 		// Other Options
+
+		/** Maximum number of linting threads, "auto" to choose automatically, "off" for no multithreading. */
 		concurrency?: number | "auto" | "off" | undefined;
+
+		/** Array of feature flags to enable. */
 		flags?: string[] | undefined;
 	}
 
