eslint 9.36.0 → 9.38.0

package/lib/types/index.d.ts

@@ -30,7 +30,6 @@ import type {
 	CustomRuleDefinitionType,
 	CustomRuleTypeDefinitions,
 	DeprecatedInfo,
-	Language,
 	LanguageOptions as GenericLanguageOptions,
 	RuleContext as CoreRuleContext,
 	RuleDefinition,
@@ -38,8 +37,28 @@ import type {
 	SourceRange,
 	TextSourceCode,
 	TraversalStep,
+	RulesConfig,
+	GlobalAccess,
+	GlobalsConfig,
+	LinterOptionsConfig,
+	EnvironmentConfig,
+	ObjectMetaProperties as CoreObjectMetaProperties,
+	Plugin as CorePlugin,
+	LintMessage as CoreLintMessage,
+	Processor as CoreProcessor,
+	ConfigObject,
+	LegacyConfigObject,
+	SeverityName,
+	SeverityLevel,
+	Severity as CoreSeverity,
+	EcmaVersion as CoreEcmaVersion,
+	ConfigOverride as CoreConfigOverride,
+	ProcessorFile as CoreProcessorFile,
+	JavaScriptParserOptionsConfig,
+	RulesMeta,
+	RuleTextEditor,
+	RuleTextEdit,
 } from "@eslint/core";
-import { JSONSchema4 } from "json-schema";
 import { LegacyESLint } from "./use-at-your-own-risk.js";
 
 export namespace AST {
@@ -47,12 +66,14 @@ export namespace AST {
 		| "Boolean"
 		| "Null"
 		| "Identifier"
+		| "PrivateIdentifier"
 		| "Keyword"
 		| "Punctuator"
 		| "JSXIdentifier"
 		| "JSXText"
 		| "Numeric"
 		| "String"
+		| "Template"
 		| "RegularExpression";
 
 	interface Token {
@@ -220,11 +241,16 @@ export class SourceCode
 
 	getDeclaredVariables(node: ESTree.Node): Scope.Variable[];
 
+	/** @deprecated */
 	getJSDocComment(node: ESTree.Node): ESTree.Comment | null;
 
 	getNodeByRangeIndex(index: number): ESTree.Node | null;
 
-	isSpaceBetweenTokens(first: AST.Token, second: AST.Token): boolean;
+	/** @deprecated Use `isSpaceBetween()` instead. */
+	isSpaceBetweenTokens(
+		first: ESTree.Node | AST.Token,
+		second: ESTree.Node | AST.Token,
+	): boolean;
 
 	getLocFromIndex(index: number): ESTree.Position;
 
@@ -258,6 +284,18 @@ export class SourceCode
 
 	getTokensAfter: SourceCode.UnaryCursorWithCountOptions;
 
+	/** @deprecated Use `getTokenBefore()` instead. */
+	getTokenOrCommentBefore(
+		node: ESTree.Node | AST.Token | ESTree.Comment,
+		skip?: number | undefined,
+	): AST.Token | ESTree.Comment | null;
+
+	/** @deprecated Use `getTokenAfter()` instead. */
+	getTokenOrCommentAfter(
+		node: ESTree.Node | AST.Token | ESTree.Comment,
+		skip?: number | undefined,
+	): AST.Token | ESTree.Comment | null;
+
 	getFirstTokenBetween: SourceCode.BinaryCursorWithSkipOptions;
 
 	getFirstTokensBetween: SourceCode.BinaryCursorWithCountOptions;
@@ -304,9 +342,10 @@ export namespace SourceCode {
 	interface Config {
 		text: string;
 		ast: AST.Program;
-		parserServices?: ParserServices | undefined;
-		scopeManager?: Scope.ScopeManager | undefined;
-		visitorKeys?: VisitorKeys | undefined;
+		hasBOM?: boolean | undefined;
+		parserServices?: ParserServices | null | undefined;
+		scopeManager?: Scope.ScopeManager | null | undefined;
+		visitorKeys?: VisitorKeys | null | undefined;
 	}
 
 	type ParserServices = any;
@@ -1128,60 +1167,7 @@ export namespace Rule {
 		reachable: boolean;
 	}
 
-	interface RuleMetaData {
-		/** Properties often used for documentation generation and tooling. */
-		docs?:
-			| {
-					/** Provides a short description of the rule. Commonly used when generating lists of rules. */
-					description?: string | undefined;
-					/** Historically used by some plugins that divide rules into categories in their documentation. */
-					category?: string | undefined;
-					/** Historically used by some plugins to indicate a rule belongs in their `recommended` configuration. */
-					recommended?: boolean | undefined;
-					/** Specifies the URL at which the full documentation can be accessed. Code editors often use this to provide a helpful link on highlighted rule violations. */
-					url?: string | undefined;
-			  }
-			| undefined;
-		/** Violation and suggestion messages. */
-		messages?: { [messageId: string]: string } | undefined;
-		/**
-		 * Specifies if the `--fix` option on the command line automatically fixes problems reported by the rule.
-		 * Mandatory for fixable rules.
-		 */
-		fixable?: "code" | "whitespace" | undefined;
-		/**
-		 * Specifies the [options](https://eslint.org/docs/latest/extend/custom-rules#options-schemas)
-		 * so ESLint can prevent invalid [rule configurations](https://eslint.org/docs/latest/use/configure/rules#configuring-rules).
-		 * Mandatory for rules with options.
-		 */
-		schema?: JSONSchema4 | JSONSchema4[] | false | undefined;
-
-		/** Any default options to be recursively merged on top of any user-provided options. */
-		defaultOptions?: unknown[];
-
-		/** Indicates whether the rule has been deprecated or provides additional metadata about the deprecation. Omit if not deprecated. */
-		deprecated?: boolean | DeprecatedInfo | undefined;
-		/**
-		 * @deprecated Use deprecated.replacedBy instead.
-		 * The name of the rule(s) this rule was replaced by, if it was deprecated.
-		 */
-		replacedBy?: readonly string[];
-
-		/**
-		 * Indicates the type of rule:
-		 * - `"problem"` means the rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve.
-		 * - `"suggestion"` means the rule is identifying something that could be done in a better way but no errors will occur if the code isn't changed.
-		 * - `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses,
-		 *   all the parts of the program that determine how the code looks rather than how it executes.
-		 *   These rules work on parts of the code that aren't specified in the AST.
-		 */
-		type?: "problem" | "suggestion" | "layout" | undefined;
-		/**
-		 * Specifies whether the rule can return suggestions (defaults to `false` if omitted).
-		 * Mandatory for rules that provide suggestions.
-		 */
-		hasSuggestions?: boolean | undefined;
-	}
+	type RuleMetaData = RulesMeta;
 
 	interface RuleContext
 		extends CoreRuleContext<{
@@ -1224,34 +1210,8 @@ export namespace Rule {
 		| { node: ESTree.Node }
 		| { loc: AST.SourceLocation | { line: number; column: number } };
 
-	interface RuleFixer {
-		insertTextAfter(
-			nodeOrToken: ESTree.Node | AST.Token,
-			text: string,
-		): Fix;
-
-		insertTextAfterRange(range: AST.Range, text: string): Fix;
-
-		insertTextBefore(
-			nodeOrToken: ESTree.Node | AST.Token,
-			text: string,
-		): Fix;
-
-		insertTextBeforeRange(range: AST.Range, text: string): Fix;
-
-		remove(nodeOrToken: ESTree.Node | AST.Token): Fix;
-
-		removeRange(range: AST.Range): Fix;
-
-		replaceText(nodeOrToken: ESTree.Node | AST.Token, text: string): Fix;
-
-		replaceTextRange(range: AST.Range, text: string): Fix;
-	}
-
-	interface Fix {
-		range: AST.Range;
-		text: string;
-	}
+	type RuleFixer = RuleTextEditor<ESTree.Node | AST.Token>;
+	type Fix = RuleTextEdit;
 }
 
 export type JSRuleDefinitionTypeOptions = CustomRuleTypeDefinitions;
@@ -1327,21 +1287,21 @@ export namespace Linter {
 	 *
 	 * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities)
 	 */
-	type Severity = 0 | 1 | 2;
+	type Severity = SeverityLevel;
 
 	/**
 	 * The human readable severity level for a rule.
 	 *
 	 * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities)
 	 */
-	type StringSeverity = "off" | "warn" | "error";
+	type StringSeverity = SeverityName;
 
 	/**
 	 * The numeric or human readable severity level for a rule.
 	 *
 	 * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities)
 	 */
-	type RuleSeverity = Severity | StringSeverity;
+	type RuleSeverity = CoreSeverity;
 
 	/**
 	 * An array containing the rule severity level, followed by the rule options.
@@ -1365,52 +1325,24 @@ export namespace Linter {
 	/**
 	 * The rules config object is a key/value map of rule names and their severity and options.
 	 */
-	interface RulesRecord {
-		[rule: string]: RuleEntry;
-	}
+	type RulesRecord = RulesConfig;
 
 	/**
 	 * A configuration object that may have a `rules` block.
 	 */
-	interface HasRules<Rules extends RulesRecord = RulesRecord> {
+	interface HasRules<Rules extends RulesConfig = RulesConfig> {
 		rules?: Partial<Rules> | undefined;
 	}
 
 	/**
 	 * The ECMAScript version of the code being linted.
 	 */
-	type EcmaVersion =
-		| 3
-		| 5
-		| 6
-		| 7
-		| 8
-		| 9
-		| 10
-		| 11
-		| 12
-		| 13
-		| 14
-		| 15
-		| 16
-		| 17
-		| 2015
-		| 2016
-		| 2017
-		| 2018
-		| 2019
-		| 2020
-		| 2021
-		| 2022
-		| 2023
-		| 2024
-		| 2025
-		| 2026
-		| "latest";
+	type EcmaVersion = CoreEcmaVersion;
 
 	/**
 	 * The type of JavaScript source code.
 	 */
+	// TODO: Refactor to JavaScriptSourceType when exported from @eslint/core.
 	type SourceType = "script" | "module" | "commonjs";
 
 	/**
@@ -1419,8 +1351,8 @@ export namespace Linter {
 	 * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/)
 	 */
 	interface BaseConfig<
-		Rules extends RulesRecord = RulesRecord,
-		OverrideRules extends RulesRecord = Rules,
+		Rules extends RulesConfig = RulesConfig,
+		OverrideRules extends RulesConfig = Rules,
 	> extends HasRules<Rules> {
 		$schema?: string | undefined;
 
@@ -1473,7 +1405,7 @@ export namespace Linter {
 		 * @see [Working with Custom Parsers](https://eslint.org/docs/latest/extend/custom-parsers)
 		 * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options)
 		 */
-		parserOptions?: ParserOptions | undefined;
+		parserOptions?: JavaScriptParserOptionsConfig | undefined;
 
 		/**
 		 * Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.
@@ -1507,18 +1439,8 @@ export namespace Linter {
 	/**
 	 * The overwrites that apply more differing configuration to specific files or directories.
 	 */
-	interface ConfigOverride<Rules extends RulesRecord = RulesRecord>
-		extends BaseConfig<Rules> {
-		/**
-		 * The glob patterns for excluded files.
-		 */
-		excludedFiles?: string | string[] | undefined;
-
-		/**
-		 * The glob patterns for target files.
-		 */
-		files: string | string[];
-	}
+	type ConfigOverride<Rules extends RulesConfig = RulesConfig> =
+		CoreConfigOverride<Rules>;
 
 	/**
 	 * ESLint legacy configuration.
@@ -1526,78 +1448,21 @@ export namespace Linter {
 	 * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/)
 	 */
 	// https://github.com/eslint/eslint/blob/v8.57.0/conf/config-schema.js
-	interface LegacyConfig<
-		Rules extends RulesRecord = RulesRecord,
-		OverrideRules extends RulesRecord = Rules,
-	> extends BaseConfig<Rules, OverrideRules> {
-		/**
-		 * Tell ESLint to ignore specific files and directories.
-		 *
-		 * @see [Ignore Patterns](https://eslint.org/docs/latest/use/configure/ignore-deprecated#ignorepatterns-in-config-files)
-		 */
-		ignorePatterns?: string | string[] | undefined;
-
-		/**
-		 * @see [Using Configuration Files](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated#using-configuration-files)
-		 */
-		root?: boolean | undefined;
-	}
+	type LegacyConfig<
+		Rules extends RulesConfig = RulesConfig,
+		OverrideRules extends RulesConfig = Rules,
+	> = LegacyConfigObject<Rules, OverrideRules>;
 
 	/**
 	 * Parser options.
 	 *
 	 * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options)
 	 */
-	interface ParserOptions {
-		/**
-		 * Allow the use of reserved words as identifiers (if `ecmaVersion` is 3).
-		 *
-		 * @default false
-		 */
-		allowReserved?: boolean | undefined;
-
-		/**
-		 * Accepts any valid ECMAScript version number or `'latest'`:
-		 *
-		 * - A version: es3, es5, es6, es7, es8, es9, es10, es11, es12, es13, es14, ..., or
-		 * - A year: es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, ..., or
-		 * - `'latest'`
-		 *
-		 * When it's a version or a year, the value must be a number - so do not include the `es` prefix.
-		 *
-		 * Specifies the version of ECMAScript syntax you want to use. This is used by the parser to determine how to perform scope analysis, and it affects the default
-		 *
-		 * @default 5
-		 */
-		ecmaVersion?: EcmaVersion | undefined;
-
-		/**
-		 * The type of JavaScript source code. Possible values are "script" for
-		 * traditional script files, "module" for ECMAScript modules (ESM), and
-		 * "commonjs" for CommonJS files.
-		 *
-		 * @default 'script'
-		 *
-		 * @see https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options
-		 */
-		sourceType?: SourceType | undefined;
-
-		/**
-		 * An object indicating which additional language features you'd like to use.
-		 *
-		 * @see https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options
-		 */
-		ecmaFeatures?:
-			| {
-					globalReturn?: boolean | undefined;
-					impliedStrict?: boolean | undefined;
-					jsx?: boolean | undefined;
-					[key: string]: any;
-			  }
-			| undefined;
-		[key: string]: any;
-	}
+	type ParserOptions = JavaScriptParserOptionsConfig;
 
+	/**
+	 * Options used for linting code with `Linter#verify` and `Linter#verifyAndFix`.
+	 */
 	interface LintOptions {
 		filename?: string | undefined;
 		preprocess?: ((code: string) => string[]) | undefined;
@@ -1612,6 +1477,7 @@ export namespace Linter {
 		reportUnusedDisableDirectives?: boolean | undefined;
 	}
 
+	// TODO: Once exported from @eslint/core, remove this and use that instead
 	interface LintSuggestion {
 		/** A short description. */
 		desc: string;
@@ -1623,46 +1489,7 @@ export namespace Linter {
 		messageId?: string | undefined;
 	}
 
-	interface LintMessage {
-		/** The 1-based column number. */
-		column: number;
-
-		/** The 1-based line number. */
-		line: number;
-
-		/** The 1-based column number of the end location. */
-		endColumn?: number | undefined;
-
-		/** The 1-based line number of the end location. */
-		endLine?: number | undefined;
-
-		/** The ID of the rule which makes this message. */
-		ruleId: string | null;
-
-		/** The reported message. */
-		message: string;
-
-		/** The ID of the message in the rule's meta. */
-		messageId?: string | undefined;
-
-		/**
-		 * Type of node.
-		 * @deprecated `nodeType` is deprecated and will be removed in the next major version.
-		 */
-		nodeType?: string | undefined;
-
-		/** If `true` then this is a fatal error. */
-		fatal?: true | undefined;
-
-		/** The severity of this message. */
-		severity: Exclude<Severity, 0>;
-
-		/** Information for autofix. */
-		fix?: Rule.Fix | undefined;
-
-		/** Information for suggestions. */
-		suggestions?: LintSuggestion[] | undefined;
-	}
+	type LintMessage = CoreLintMessage;
 
 	interface LintSuppression {
 		kind: string;
@@ -1723,114 +1550,19 @@ export namespace Linter {
 		visitorKeys?: SourceCode.VisitorKeys | undefined;
 	}
 
-	interface ProcessorFile {
-		text: string;
-		filename: string;
-	}
+	type ProcessorFile = CoreProcessorFile;
 
 	// https://eslint.org/docs/latest/extend/plugins#processors-in-plugins
-	interface Processor<
-		T extends string | ProcessorFile = string | ProcessorFile,
-	> extends ESLint.ObjectMetaProperties {
-		/** If `true` then it means the processor supports autofix. */
-		supportsAutofix?: boolean | undefined;
-
-		/** The function to extract code blocks. */
-		preprocess?(text: string, filename: string): T[];
-
-		/** The function to merge messages. */
-		postprocess?(
-			messages: LintMessage[][],
-			filename: string,
-		): LintMessage[];
-	}
-
-	interface Config<Rules extends RulesRecord = RulesRecord> {
-		/**
-		 * An string to identify the configuration object. Used in error messages and
-		 * inspection tools.
-		 */
-		name?: string;
-
-		/**
-		 * Path to the directory where the configuration object should apply.
-		 * `files` and `ignores` patterns in the configuration object are
-		 * interpreted as relative to this path.
-		 */
-		basePath?: string;
-
-		/**
-		 * An array of glob patterns indicating the files that the configuration
-		 * object should apply to. If not specified, the configuration object applies
-		 * to all files
-		 */
-		files?: Array<string | string[]>;
-
-		/**
-		 * An array of glob patterns indicating the files that the configuration
-		 * object should not apply to. If not specified, the configuration object
-		 * applies to all files matched by files
-		 */
-		ignores?: string[];
-
-		/**
-		 * The name of the language used for linting. This is used to determine the
-		 * parser and other language-specific settings.
-		 * @since 9.7.0
-		 */
-		language?: string;
-
-		/**
-		 * An object containing settings related to how JavaScript is configured for
-		 * linting.
-		 */
-		languageOptions?: LanguageOptions;
-
-		/**
-		 * An object containing settings related to the linting process
-		 */
-		linterOptions?: LinterOptions;
-
-		/**
-		 * Either an object containing preprocess() and postprocess() methods or a
-		 * string indicating the name of a processor inside of a plugin
-		 * (i.e., "pluginName/processorName").
-		 */
-		processor?: string | Processor;
-
-		/**
-		 * An object containing a name-value mapping of plugin names to plugin objects.
-		 * When files is specified, these plugins are only available to the matching files.
-		 */
-		plugins?: Record<string, ESLint.Plugin>;
+	type Processor<T extends string | ProcessorFile = string | ProcessorFile> =
+		CoreProcessor<T>;
 
-		/**
-		 * An object containing the configured rules. When files or ignores are specified,
-		 * these rule configurations are only available to the matching files.
-		 */
-		rules?: Partial<Rules>;
-
-		/**
-		 * An object containing name-value pairs of information that should be
-		 * available to all rules.
-		 */
-		settings?: Record<string, unknown>;
-	}
+	type Config<Rules extends RulesConfig = RulesConfig> = ConfigObject<Rules>;
 
 	/** @deprecated  Use `Config` instead of `FlatConfig` */
-	type FlatConfig<Rules extends RulesRecord = RulesRecord> = Config<Rules>;
-
-	type GlobalConf =
-		| boolean
-		| "off"
-		| "readable"
-		| "readonly"
-		| "writable"
-		| "writeable";
-
-	interface Globals {
-		[name: string]: GlobalConf;
-	}
+	type FlatConfig<Rules extends RulesConfig = RulesConfig> = Config<Rules>;
+
+	type GlobalConf = GlobalAccess;
+	type Globals = GlobalsConfig;
 
 	interface LanguageOptions extends GenericLanguageOptions {
 		/**
@@ -1867,24 +1599,7 @@ export namespace Linter {
 		parserOptions?: Linter.ParserOptions | undefined;
 	}
 
-	interface LinterOptions {
-		/**
-		 * A boolean value indicating if inline configuration is allowed.
-		 */
-		noInlineConfig?: boolean;
-
-		/**
-		 * A severity value indicating if and how unused disable directives should be
-		 * tracked and reported.
-		 */
-		reportUnusedDisableDirectives?: Severity | StringSeverity | boolean;
-
-		/**
-		 * A severity value indicating if and how unused inline configs should be
-		 * tracked and reported.
-		 */
-		reportUnusedInlineConfigs?: Severity | StringSeverity;
-	}
+	type LinterOptions = LinterOptionsConfig;
 
 	/**
 	 * Performance statistics.
@@ -1963,7 +1678,7 @@ export class ESLint {
 
 	calculateConfigForFile(filePath: string): Promise<any>;
 
-	findConfigFile(): Promise<string | undefined>;
+	findConfigFile(filePath?: string): Promise<string | undefined>;
 
 	isPathIgnored(filePath: string): Promise<boolean>;
 
@@ -1975,45 +1690,14 @@ export class ESLint {
 }
 
 export namespace ESLint {
-	type ConfigData<Rules extends Linter.RulesRecord = Linter.RulesRecord> =
-		Omit<Linter.LegacyConfig<Rules>, "$schema">;
+	type ConfigData<Rules extends Linter.RulesRecord = RulesConfig> = Omit<
+		Linter.LegacyConfig<Rules>,
+		"$schema"
+	>;
 
-	interface Environment {
-		/** The definition of global variables. */
-		globals?: Linter.Globals | undefined;
-
-		/** The parser options that will be enabled under this environment. */
-		parserOptions?: Linter.ParserOptions | undefined;
-	}
-
-	interface ObjectMetaProperties {
-		/** @deprecated Use `meta.name` instead. */
-		name?: string | undefined;
-
-		/** @deprecated Use `meta.version` instead. */
-		version?: string | undefined;
-
-		meta?: {
-			name?: string | undefined;
-			version?: string | undefined;
-		};
-	}
-
-	interface Plugin extends ObjectMetaProperties {
-		meta?: ObjectMetaProperties["meta"] & {
-			namespace?: string | undefined;
-		};
-		configs?:
-			| Record<
-					string,
-					Linter.LegacyConfig | Linter.Config | Linter.Config[]
-			  >
-			| undefined;
-		environments?: Record<string, Environment> | undefined;
-		languages?: Record<string, Language> | undefined;
-		processors?: Record<string, Linter.Processor> | undefined;
-		rules?: Record<string, RuleDefinition> | undefined;
-	}
+	type Environment = EnvironmentConfig;
+	type ObjectMetaProperties = CoreObjectMetaProperties;
+	type Plugin = CorePlugin;
 
 	type FixType = "directive" | "problem" | "suggestion" | "layout";
 
@@ -2045,7 +1729,7 @@ export namespace ESLint {
 
 		// Autofix
 		fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
-		fixTypes?: FixType[] | undefined;
+		fixTypes?: FixType[] | null | undefined;
 
 		// Cache-related
 		cache?: boolean | undefined;
@@ -2079,7 +1763,7 @@ export namespace ESLint {
 
 		// Autofix
 		fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
-		fixTypes?: FixType[] | undefined;
+		fixTypes?: FixType[] | null | undefined;
 
 		// Cache-related
 		cache?: boolean | undefined;
@@ -2168,9 +1852,10 @@ export namespace ESLint {
 
 		/**
 		 * The raw deprecated info provided by the rule.
-		 * Unset if the rule's `meta.deprecated` property is a boolean.
+		 * - Undefined if the rule's `meta.deprecated` property is a boolean.
+		 * - Unset when using the legacy eslintrc configuration.
 		 */
-		info?: DeprecatedInfo;
+		info?: DeprecatedInfo | undefined;
 	}
 
 	/**