eslint-cli-bundle 1.0.5 → 2.0.0

package/dist/api.d.ts

@@ -27,8 +27,6 @@
 
 import * as ESTree from "estree";
 import type {
-	CustomRuleDefinitionType,
-	CustomRuleTypeDefinitions,
 	DeprecatedInfo,
 	LanguageOptions as GenericLanguageOptions,
 	RuleContext as CoreRuleContext,
@@ -53,7 +51,6 @@ import type {
 	EcmaVersion as CoreEcmaVersion,
 	ConfigOverride as CoreConfigOverride,
 	ProcessorFile as CoreProcessorFile,
-	JavaScriptParserOptionsConfig,
 	RulesMeta,
 	RuleConfig,
 	RuleTextEditor,
@@ -71,19 +68,13 @@ import type {
 	SuggestedEditBase,
 	SuggestedEdit,
 	ViolationReport,
+	MessagePlaceholderData,
 } from "@eslint/core";
-import { LegacyESLint } from "./use-at-your-own-risk.js";
-
-//------------------------------------------------------------------------------
-// Helpers
-//------------------------------------------------------------------------------
-
-/** Adds matching `:exit` selectors for all properties of a `RuleVisitor`. */
-type WithExit<RuleVisitorType extends RuleVisitor> = {
-	[Key in keyof RuleVisitorType as
-		| Key
-		| `${Key & string}:exit`]: RuleVisitorType[Key];
-};
+import type {
+	CustomRuleDefinitionType,
+	CustomRuleTypeDefinitions,
+	CustomRuleVisitorWithExit,
+} from "@eslint/plugin-kit";
 
 //------------------------------------------------------------------------------
 // Exports
@@ -116,7 +107,7 @@ export namespace AST {
 		end: ESTree.Position;
 	}
 
-	type Range = [number, number];
+	type Range = SourceRange;
 
 	interface Program extends ESTree.Program {
 		comments: ESTree.Comment[];
@@ -126,6 +117,11 @@ export namespace AST {
 	}
 }
 
+interface JSXIdentifier extends ESTree.BaseNode {
+	type: "JSXIdentifier";
+	name: string;
+}
+
 export namespace Scope {
 	interface ScopeManager {
 		scopes: Scope[];
@@ -134,6 +130,8 @@ export namespace Scope {
 		acquire(node: ESTree.Node, inner?: boolean): Scope | null;
 
 		getDeclaredVariables(node: ESTree.Node): Variable[];
+
+		addGlobals(names: ReadonlyArray<string>): void;
 	}
 
 	interface Scope {
@@ -149,8 +147,7 @@ export namespace Scope {
 			| "global"
 			| "module"
 			| "switch"
-			| "with"
-			| "TDZ";
+			| "with";
 		isStrict: boolean;
 		upper: Scope | null;
 		childScopes: Scope[];
@@ -176,11 +173,11 @@ export namespace Scope {
 	}
 
 	interface Reference {
-		identifier: ESTree.Identifier;
+		identifier: ESTree.Identifier | JSXIdentifier;
 		from: Scope;
 		resolved: Variable | null;
-		writeExpr: ESTree.Node | null;
-		init: boolean;
+		writeExpr?: ESTree.Expression | null;
+		init?: boolean;
 
 		isWrite(): boolean;
 
@@ -229,7 +226,6 @@ export namespace Scope {
 					| ESTree.ArrowFunctionExpression;
 				parent: null;
 		  }
-		| { type: "TDZ"; node: any; parent: null }
 		| {
 				type: "Variable";
 				node: ESTree.VariableDeclarator;
@@ -241,15 +237,12 @@ export namespace Scope {
 
 // #region SourceCode
 
-export class SourceCode
-	implements
-		TextSourceCode<{
-			LangOptions: Linter.LanguageOptions;
-			RootNode: AST.Program;
-			SyntaxElementWithLoc: AST.Token | ESTree.Node;
-			ConfigNode: ESTree.Comment;
-		}>
-{
+export class SourceCode implements TextSourceCode<{
+	LangOptions: Linter.LanguageOptions;
+	RootNode: AST.Program;
+	SyntaxElementWithLoc: AST.Token | ESTree.Node;
+	ConfigNode: ESTree.Comment;
+}> {
 	text: string;
 	ast: AST.Program;
 	lines: string[];
@@ -280,17 +273,8 @@ export class SourceCode
 
 	getDeclaredVariables(node: ESTree.Node): Scope.Variable[];
 
-	/** @deprecated */
-	getJSDocComment(node: ESTree.Node): ESTree.Comment | null;
-
 	getNodeByRangeIndex(index: number): ESTree.Node | null;
 
-	/** @deprecated Use `isSpaceBetween()` instead. */
-	isSpaceBetweenTokens(
-		first: ESTree.Node | AST.Token,
-		second: ESTree.Node | AST.Token,
-	): boolean;
-
 	getLocFromIndex(index: number): ESTree.Position;
 
 	getIndexFromLoc(location: ESTree.Position): number;
@@ -323,18 +307,6 @@ 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;
@@ -674,32 +646,30 @@ export type JSSyntaxElement = {
 };
 
 export namespace Rule {
-	interface RuleModule
-		extends RuleDefinition<{
-			LangOptions: Linter.LanguageOptions;
-			Code: SourceCode;
-			RuleOptions: any[];
-			Visitor: RuleListener;
-			Node: JSSyntaxElement;
-			MessageIds: string;
-			ExtRuleDocs: {};
-		}> {
+	interface RuleModule extends RuleDefinition<{
+		LangOptions: Linter.LanguageOptions;
+		Code: SourceCode;
+		RuleOptions: any[];
+		Visitor: RuleListener;
+		Node: JSSyntaxElement;
+		MessageIds: string;
+		ExtRuleDocs: {};
+	}> {
 		create(context: RuleContext): RuleListener;
 	}
 
 	type NodeTypes = ESTree.Node["type"];
 
-	interface NodeListener
-		extends WithExit<
-			{
-				[Node in Rule.Node as Node["type"]]?:
-					| ((node: Node) => void)
-					| undefined;
-			} & {
-				// A `Program` visitor's node type has no `parent` property.
-				Program?: ((node: AST.Program) => void) | undefined;
-			}
-		> {}
+	interface NodeListener extends CustomRuleVisitorWithExit<
+		{
+			[Node in Rule.Node as Node["type"]]?:
+				| ((node: Node) => void)
+				| undefined;
+		} & {
+			// A `Program` visitor's node type has no `parent` property.
+			Program?: ((node: AST.Program) => void) | undefined;
+		}
+	> {}
 
 	interface NodeParentExtension {
 		parent: Node;
@@ -773,19 +743,18 @@ export namespace Rule {
 
 	type RuleMetaData = RulesMeta;
 
-	interface RuleContext
-		extends CoreRuleContext<{
-			LangOptions: Linter.LanguageOptions;
-			Code: SourceCode;
-			RuleOptions: any[];
-			Node: JSSyntaxElement;
-			MessageIds: string;
-		}> {}
+	interface RuleContext extends CoreRuleContext<{
+		LangOptions: Linter.LanguageOptions;
+		Code: SourceCode;
+		RuleOptions: any[];
+		Node: JSSyntaxElement;
+		MessageIds: string;
+	}> {}
 
 	type ReportFixer = CoreRuleFixer;
 
 	/** @deprecated Use `ReportDescriptorOptions` instead. */
-	type ReportDescriptorOptionsBase = ViolationReportBase;
+	type ReportDescriptorOptionsBase = Omit<ViolationReportBase, "suggest">;
 
 	type SuggestionReportOptions = SuggestedEditBase;
 	type SuggestionDescriptorMessage = SuggestionMessage;
@@ -794,9 +763,9 @@ export namespace Rule {
 	// redundant with ReportDescriptorOptionsBase but kept for clarity
 	type ReportDescriptorOptions = ViolationReportBase;
 
-	type ReportDescriptor = ViolationReport<ESTree.Node>;
+	type ReportDescriptor = ViolationReport<JSSyntaxElement>;
 	type ReportDescriptorMessage = ViolationMessage;
-	type ReportDescriptorLocation = ViolationLocation<ESTree.Node>;
+	type ReportDescriptorLocation = ViolationLocation<JSSyntaxElement>;
 
 	type RuleFixer = RuleTextEditor<ESTree.Node | AST.Token>;
 	type Fix = RuleTextEdit;
@@ -823,43 +792,32 @@ export class Linter {
 
 	version: string;
 
-	constructor(options?: {
-		cwd?: string | undefined;
-		configType?: "flat" | "eslintrc";
-	});
+	constructor(options?: { cwd?: string | undefined; configType?: "flat" });
 
 	verify(
 		code: SourceCode | string,
-		config: Linter.LegacyConfig | Linter.Config | Linter.Config[],
+		config: Linter.Config | Linter.Config[],
 		filename?: string,
 	): Linter.LintMessage[];
 	verify(
 		code: SourceCode | string,
-		config: Linter.LegacyConfig | Linter.Config | Linter.Config[],
+		config: Linter.Config | Linter.Config[],
 		options: Linter.LintOptions,
 	): Linter.LintMessage[];
 
 	verifyAndFix(
 		code: string,
-		config: Linter.LegacyConfig | Linter.Config | Linter.Config[],
+		config: Linter.Config | Linter.Config[],
 		filename?: string,
 	): Linter.FixReport;
 	verifyAndFix(
 		code: string,
-		config: Linter.LegacyConfig | Linter.Config | Linter.Config[],
+		config: Linter.Config | Linter.Config[],
 		options: Linter.FixOptions,
 	): Linter.FixReport;
 
 	getSourceCode(): SourceCode;
 
-	defineRule(name: string, rule: Rule.RuleModule): void;
-
-	defineRules(rules: { [name: string]: Rule.RuleModule }): void;
-
-	getRules(): Map<string, Rule.RuleModule>;
-
-	defineParser(name: string, parser: Linter.Parser): void;
-
 	getTimes(): Linter.Stats["times"];
 
 	getFixPassCount(): Linter.Stats["fixPasses"];
@@ -961,7 +919,43 @@ export namespace Linter {
 	 *
 	 * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options)
 	 */
-	type ParserOptions = JavaScriptParserOptionsConfig;
+	interface ParserOptions {
+		/**
+		 * Allow the use of reserved words as identifiers (if `ecmaVersion` is 3).
+		 *
+		 * @default false
+		 */
+		allowReserved?: boolean | undefined;
+		/**
+		 * An object indicating which additional language features you'd like to use.
+		 *
+		 * @see https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options
+		 */
+		ecmaFeatures?:
+			| {
+					/**
+					 * Allow `return` statements in the global scope.
+					 *
+					 * @default false
+					 */
+					globalReturn?: boolean | undefined;
+					/**
+					 * Enable global [strict mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode) (if `ecmaVersion` is 5 or greater).
+					 *
+					 * @default false
+					 */
+					impliedStrict?: boolean | undefined;
+					/**
+					 * Enable [JSX](https://facebook.github.io/jsx/).
+					 *
+					 * @default false
+					 */
+					jsx?: boolean | undefined;
+					[key: string]: any;
+			  }
+			| undefined;
+		[key: string]: any;
+	}
 
 	/**
 	 * Options used for linting code with `Linter#verify` and `Linter#verifyAndFix`.
@@ -1195,74 +1189,98 @@ 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;
-		cacheStrategy?: CacheStrategy | undefined;
 
-		// Other Options
-		concurrency?: number | "auto" | "off" | undefined;
-		flags?: string[] | undefined;
-	}
+		/** The strategy used to detect changed files. */
+		cacheStrategy?: CacheStrategy | undefined;
 
-	interface LegacyOptions {
-		// File enumeration
-		cwd?: string | undefined;
-		errorOnUnmatchedPattern?: boolean | undefined;
-		extensions?: string[] | undefined;
-		globInputPaths?: boolean | undefined;
-		ignore?: boolean | undefined;
-		ignorePath?: string | undefined;
+		/** If true, apply suppressions automatically. Defaults to false. */
+		applySuppressions?: boolean | undefined;
 
-		// Linting
-		allowInlineConfig?: boolean | undefined;
-		baseConfig?: Linter.LegacyConfig | undefined;
-		overrideConfig?: Linter.LegacyConfig | undefined;
-		overrideConfigFile?: string | undefined;
-		plugins?: Record<string, Plugin> | undefined;
-		reportUnusedDisableDirectives?: Linter.StringSeverity | undefined;
-		resolvePluginsRelativeTo?: string | undefined;
-		rulePaths?: string[] | undefined;
-		useEslintrc?: boolean | undefined;
+		/** Path to suppressions file. Relative to cwd. Defaults to eslint-suppressions.json in cwd. */
+		suppressionsLocation?: string | undefined;
 
-		// Autofix
-		fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
-		fixTypes?: FixType[] | null | undefined;
+		// Other Options
 
-		// Cache-related
-		cache?: boolean | undefined;
-		cacheLocation?: string | undefined;
-		cacheStrategy?: CacheStrategy | undefined;
+		/** Maximum number of linting threads, "auto" to choose automatically, "off" for no multithreading. */
+		concurrency?: number | "auto" | "off" | undefined;
 
-		// Other Options
+		/** Array of feature flags to enable. */
 		flags?: string[] | undefined;
 	}
 
@@ -1320,9 +1338,8 @@ export namespace ESLint {
 		foundWarnings: number;
 	}
 
-	interface LintResultData {
+	interface LintResultData extends ResultsMeta {
 		cwd: string;
-		maxWarningsExceeded?: MaxWarningsExceeded | undefined;
 		rulesMeta: {
 			[ruleId: string]: Rule.RuleMetaData;
 		};
@@ -1354,6 +1371,14 @@ export namespace ESLint {
 	 * Metadata about results for formatters.
 	 */
 	interface ResultsMeta {
+		/**
+		 * Whether or not to use color in the formatter output.
+		 * - If `--color` was set, this property is `true`.
+		 * - If `--no-color` was set, it is `false`.
+		 * - If neither option was provided, the property is omitted.
+		 */
+		color?: boolean | undefined;
+
 		/**
 		 * Present if the maxWarnings threshold was exceeded.
 		 */
@@ -1365,9 +1390,9 @@ export namespace ESLint {
 		/**
 		 * Used to call the underlying formatter.
 		 * @param results An array of lint results to format.
-		 * @param resultsMeta An object with an optional `maxWarningsExceeded` property that will be
+		 * @param resultsMeta An object with optional `color` and `maxWarningsExceeded` properties that will be
 		 * passed to the underlying formatter function along with other properties set by ESLint.
-		 * This argument can be omitted if `maxWarningsExceeded` is not needed.
+		 * This argument can be omitted if `color` and `maxWarningsExceeded` are not needed.
 		 * @return The formatter output.
 		 */
 		format(
@@ -1396,15 +1421,10 @@ export namespace ESLint {
 
 // #endregion
 
-export function loadESLint(options: {
-	useFlatConfig: true;
-}): Promise<typeof ESLint>;
-export function loadESLint(options: {
-	useFlatConfig: false;
-}): Promise<typeof LegacyESLint>;
-export function loadESLint(options?: {
-	useFlatConfig?: boolean | undefined;
-}): Promise<typeof ESLint | typeof LegacyESLint>;
+/**
+ * Loads the correct `ESLint` constructor.
+ */
+export function loadESLint(): Promise<typeof ESLint>;
 
 // #region RuleTester
 
@@ -1412,6 +1432,9 @@ export class RuleTester {
 	static describe: ((...args: any) => any) | null;
 	static it: ((...args: any) => any) | null;
 	static itOnly: ((...args: any) => any) | null;
+	static setDefaultConfig(config: Linter.Config): void;
+	static getDefaultConfig(): Linter.Config;
+	static resetDefaultConfig(): void;
 
 	constructor(config?: Linter.Config);
 
@@ -1421,6 +1444,32 @@ export class RuleTester {
 		tests: {
 			valid: Array<string | RuleTester.ValidTestCase>;
 			invalid: RuleTester.InvalidTestCase[];
+			/**
+			 * Additional assertions for the "error" matchers of invalid test cases to enforce consistency.
+			 */
+			assertionOptions?: {
+				/**
+				 * If true, each `errors` block must check the expected error
+				 * message, either via a string in the `errors` array, or via
+				 * `message`/`messageId` in an errors object.
+				 * `"message"`/`"messageId"` can be used to further limit the
+				 * message assertions to the respective versions.
+				 */
+				requireMessage?: boolean | "message" | "messageId";
+				/**
+				 * If true, each `errors` block must be an array of objects,
+				 * that each check all location properties `line`, `column`,
+				 * `endLine`, `endColumn`, the later may be omitted, if the
+				 * error does not contain them.
+				 */
+				requireLocation?: boolean;
+				/**
+				 * If true, each error and suggestion with a `messageId` must specify a `data`
+				 * property if the referenced message contains placeholders.
+				 * `"error"` and `"suggestion" limit the assertion to errors and suggestions respectively.
+				 */
+				requireData?: boolean | "error" | "suggestion";
+			};
 		},
 	): void;
 
@@ -1430,14 +1479,21 @@ export class RuleTester {
 }
 
 export namespace RuleTester {
-	interface ValidTestCase {
+	interface ValidTestCase extends Omit<
+		Linter.Config,
+		| "name"
+		| "basePath"
+		| "files"
+		| "ignores"
+		| "linterOptions"
+		| "plugins"
+		| "rules"
+	> {
 		name?: string;
 		code: string;
-		options?: any;
+		options?: any[];
 		filename?: string | undefined;
 		only?: boolean;
-		languageOptions?: Linter.LanguageOptions | undefined;
-		settings?: { [name: string]: any } | undefined;
 		before?: () => void;
 		after?: () => void;
 	}
@@ -1445,28 +1501,24 @@ export namespace RuleTester {
 	interface SuggestionOutput {
 		messageId?: string;
 		desc?: string;
-		data?: Record<string, unknown> | undefined;
+		data?: MessagePlaceholderData | undefined;
 		output: string;
 	}
 
 	interface InvalidTestCase extends ValidTestCase {
-		errors: number | Array<TestCaseError | string>;
+		errors: number | Array<TestCaseError | string | RegExp>;
 		output?: string | null | undefined;
 	}
 
 	interface TestCaseError {
 		message?: string | RegExp;
 		messageId?: string;
-		/**
-		 * @deprecated `type` is deprecated and will be removed in the next major version.
-		 */
-		type?: string | undefined;
-		data?: any;
+		data?: MessagePlaceholderData | undefined;
 		line?: number | undefined;
 		column?: number | undefined;
 		endLine?: number | undefined;
 		endColumn?: number | undefined;
-		suggestions?: SuggestionOutput[] | undefined;
+		suggestions?: SuggestionOutput[] | number | undefined;
 	}
 }