/** * @fileoverview This file contains the core types for ESLint. It was initially extracted * from the `@types/eslint` package. */ /* * MIT License * Copyright (c) Microsoft Corporation. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE */ import * as ESTree from "estree"; import type { CustomRuleDefinitionType, CustomRuleTypeDefinitions, DeprecatedInfo, LanguageOptions as GenericLanguageOptions, RuleContext as CoreRuleContext, RuleDefinition, 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, RuleConfig, RuleTextEditor, RuleTextEdit, RuleVisitor, BaseConfig as CoreBaseConfig, RuleFixer as CoreRuleFixer, ViolationReportBase, ViolationMessage, ViolationLocation, SuggestionMessage, LintSuggestion as CoreLintSuggestion, JavaScriptSourceType, HasRules as CoreHasRules, SuggestedEditBase, SuggestedEdit, ViolationReport, } 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 = { [Key in keyof RuleVisitorType as | Key | `${Key & string}:exit`]: RuleVisitorType[Key]; }; //------------------------------------------------------------------------------ // Exports //------------------------------------------------------------------------------ export namespace AST { type TokenType = | "Boolean" | "Null" | "Identifier" | "PrivateIdentifier" | "Keyword" | "Punctuator" | "JSXIdentifier" | "JSXText" | "Numeric" | "String" | "Template" | "RegularExpression"; interface Token { type: TokenType; value: string; range: Range; loc: SourceLocation; } interface SourceLocation { start: ESTree.Position; end: ESTree.Position; } type Range = [number, number]; interface Program extends ESTree.Program { comments: ESTree.Comment[]; tokens: Token[]; loc: SourceLocation; range: Range; } } export namespace Scope { interface ScopeManager { scopes: Scope[]; globalScope: Scope | null; acquire(node: ESTree.Node, inner?: boolean): Scope | null; getDeclaredVariables(node: ESTree.Node): Variable[]; } interface Scope { type: | "block" | "catch" | "class" | "class-field-initializer" | "class-static-block" | "for" | "function" | "function-expression-name" | "global" | "module" | "switch" | "with" | "TDZ"; isStrict: boolean; upper: Scope | null; childScopes: Scope[]; variableScope: Scope; block: ESTree.Node; variables: Variable[]; set: Map; references: Reference[]; through: Reference[]; functionExpressionScope: boolean; implicit?: { variables: Variable[]; set: Map; }; } interface Variable { name: string; scope: Scope; identifiers: ESTree.Identifier[]; references: Reference[]; defs: Definition[]; } interface Reference { identifier: ESTree.Identifier; from: Scope; resolved: Variable | null; writeExpr: ESTree.Node | null; init: boolean; isWrite(): boolean; isRead(): boolean; isWriteOnly(): boolean; isReadOnly(): boolean; isReadWrite(): boolean; } type DefinitionType = | { type: "CatchClause"; node: ESTree.CatchClause; parent: null } | { type: "ClassName"; node: ESTree.ClassDeclaration | ESTree.ClassExpression; parent: null; } | { type: "FunctionName"; node: ESTree.FunctionDeclaration | ESTree.FunctionExpression; parent: null; } | { type: "ImplicitGlobalVariable"; node: | ESTree.AssignmentExpression | ESTree.ForInStatement | ESTree.ForOfStatement; parent: null; } | { type: "ImportBinding"; node: | ESTree.ImportSpecifier | ESTree.ImportDefaultSpecifier | ESTree.ImportNamespaceSpecifier; parent: ESTree.ImportDeclaration; } | { type: "Parameter"; node: | ESTree.FunctionDeclaration | ESTree.FunctionExpression | ESTree.ArrowFunctionExpression; parent: null; } | { type: "TDZ"; node: any; parent: null } | { type: "Variable"; node: ESTree.VariableDeclarator; parent: ESTree.VariableDeclaration; }; type Definition = DefinitionType & { name: ESTree.Identifier }; } // #region SourceCode 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[]; hasBOM: boolean; parserServices: SourceCode.ParserServices; scopeManager: Scope.ScopeManager; visitorKeys: SourceCode.VisitorKeys; constructor(text: string, ast: AST.Program); constructor(config: SourceCode.Config); static splitLines(text: string): string[]; getLoc(syntaxElement: AST.Token | ESTree.Node): ESTree.SourceLocation; getRange(syntaxElement: AST.Token | ESTree.Node): SourceRange; getText( node?: ESTree.Node, beforeCount?: number, afterCount?: number, ): string; getLines(): string[]; getAllComments(): ESTree.Comment[]; getAncestors(node: ESTree.Node): ESTree.Node[]; 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; // Inherited methods from TokenStore // --------------------------------- getTokenByRangeStart( offset: number, options?: { includeComments: false }, ): AST.Token | null; getTokenByRangeStart( offset: number, options: { includeComments: boolean }, ): AST.Token | ESTree.Comment | null; getFirstToken: SourceCode.UnaryNodeCursorWithSkipOptions; getFirstTokens: SourceCode.UnaryNodeCursorWithCountOptions; getLastToken: SourceCode.UnaryNodeCursorWithSkipOptions; getLastTokens: SourceCode.UnaryNodeCursorWithCountOptions; getTokenBefore: SourceCode.UnaryCursorWithSkipOptions; getTokensBefore: SourceCode.UnaryCursorWithCountOptions; getTokenAfter: SourceCode.UnaryCursorWithSkipOptions; 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; getLastTokenBetween: SourceCode.BinaryCursorWithSkipOptions; getLastTokensBetween: SourceCode.BinaryCursorWithCountOptions; getTokensBetween: SourceCode.BinaryCursorWithCountOptions; getTokens: (( node: ESTree.Node, beforeCount?: number, afterCount?: number, ) => AST.Token[]) & SourceCode.UnaryNodeCursorWithCountOptions; commentsExistBetween( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, ): boolean; getCommentsBefore(nodeOrToken: ESTree.Node | AST.Token): ESTree.Comment[]; getCommentsAfter(nodeOrToken: ESTree.Node | AST.Token): ESTree.Comment[]; getCommentsInside(node: ESTree.Node): ESTree.Comment[]; getScope(node: ESTree.Node): Scope.Scope; isSpaceBetween( first: ESTree.Node | AST.Token, second: ESTree.Node | AST.Token, ): boolean; isGlobalReference(node: ESTree.Identifier): boolean; markVariableAsUsed(name: string, refNode?: ESTree.Node): boolean; traverse(): Iterable; } export namespace SourceCode { interface Config { text: string; ast: AST.Program; hasBOM?: boolean | undefined; parserServices?: ParserServices | null | undefined; scopeManager?: Scope.ScopeManager | null | undefined; visitorKeys?: VisitorKeys | null | undefined; } type ParserServices = any; interface VisitorKeys { [nodeType: string]: string[]; } interface UnaryNodeCursorWithSkipOptions { ( node: ESTree.Node, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; skip?: number | undefined; }, ): T | null; ( node: ESTree.Node, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; skip?: number | undefined; }, ): T | null; ( node: ESTree.Node, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; skip?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token | null; ( node: ESTree.Node, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; skip?: number | undefined; }, ): AST.Token | ESTree.Comment | null; } interface UnaryNodeCursorWithCountOptions { ( node: ESTree.Node, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; count?: number | undefined; }, ): T[]; ( node: ESTree.Node, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; count?: number | undefined; }, ): T[]; ( node: ESTree.Node, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; count?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token[]; ( node: ESTree.Node, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; count?: number | undefined; }, ): Array; } interface UnaryCursorWithSkipOptions { ( node: ESTree.Node | AST.Token | ESTree.Comment, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; skip?: number | undefined; }, ): T | null; ( node: ESTree.Node | AST.Token | ESTree.Comment, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; skip?: number | undefined; }, ): T | null; ( node: ESTree.Node | AST.Token | ESTree.Comment, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; skip?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token | null; ( node: ESTree.Node | AST.Token | ESTree.Comment, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; skip?: number | undefined; }, ): AST.Token | ESTree.Comment | null; } interface UnaryCursorWithCountOptions { ( node: ESTree.Node | AST.Token | ESTree.Comment, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; count?: number | undefined; }, ): T[]; ( node: ESTree.Node | AST.Token | ESTree.Comment, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; count?: number | undefined; }, ): T[]; ( node: ESTree.Node | AST.Token | ESTree.Comment, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; count?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token[]; ( node: ESTree.Node | AST.Token | ESTree.Comment, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; count?: number | undefined; }, ): Array; } interface BinaryCursorWithSkipOptions { ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; skip?: number | undefined; }, ): T | null; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; skip?: number | undefined; }, ): T | null; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; skip?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token | null; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; skip?: number | undefined; }, ): AST.Token | ESTree.Comment | null; } interface BinaryCursorWithCountOptions { ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: | ((token: AST.Token) => token is T) | { filter: (token: AST.Token) => token is T; includeComments?: false | undefined; count?: number | undefined; }, ): T[]; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: { filter: ( tokenOrComment: AST.Token | ESTree.Comment, ) => tokenOrComment is T; includeComments: boolean; count?: number | undefined; }, ): T[]; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options?: | { filter?: ((token: AST.Token) => boolean) | undefined; includeComments?: false | undefined; count?: number | undefined; } | ((token: AST.Token) => boolean) | number, ): AST.Token[]; ( left: ESTree.Node | AST.Token | ESTree.Comment, right: ESTree.Node | AST.Token | ESTree.Comment, options: { filter?: | ((token: AST.Token | ESTree.Comment) => boolean) | undefined; includeComments: boolean; count?: number | undefined; }, ): Array; } } // #endregion export type JSSyntaxElement = { type: string; loc?: ESTree.SourceLocation | null | undefined; }; export namespace Rule { 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 NodeParentExtension { parent: Node; } type Node = | (AST.Program & { parent: null }) | (Exclude & NodeParentExtension); interface RuleListener extends NodeListener { onCodePathStart?(codePath: CodePath, node: Node): void; onCodePathEnd?(codePath: CodePath, node: Node): void; onCodePathSegmentStart?(segment: CodePathSegment, node: Node): void; onCodePathSegmentEnd?(segment: CodePathSegment, node: Node): void; onUnreachableCodePathSegmentStart?( segment: CodePathSegment, node: Node, ): void; onUnreachableCodePathSegmentEnd?( segment: CodePathSegment, node: Node, ): void; onCodePathSegmentLoop?( fromSegment: CodePathSegment, toSegment: CodePathSegment, node: Node, ): void; [key: string]: | ((codePath: CodePath, node: Node) => void) | ((segment: CodePathSegment, node: Node) => void) | (( fromSegment: CodePathSegment, toSegment: CodePathSegment, node: Node, ) => void) | ((node: Node) => void) | NodeListener[keyof NodeListener] | undefined; } type CodePathOrigin = | "program" | "function" | "class-field-initializer" | "class-static-block"; interface CodePath { id: string; origin: CodePathOrigin; initialSegment: CodePathSegment; finalSegments: CodePathSegment[]; returnedSegments: CodePathSegment[]; thrownSegments: CodePathSegment[]; upper: CodePath | null; childCodePaths: CodePath[]; } interface CodePathSegment { id: string; nextSegments: CodePathSegment[]; prevSegments: CodePathSegment[]; reachable: boolean; } type RuleMetaData = RulesMeta; 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 SuggestionReportOptions = SuggestedEditBase; type SuggestionDescriptorMessage = SuggestionMessage; type SuggestionReportDescriptor = SuggestedEdit; // redundant with ReportDescriptorOptionsBase but kept for clarity type ReportDescriptorOptions = ViolationReportBase; type ReportDescriptor = ViolationReport; type ReportDescriptorMessage = ViolationMessage; type ReportDescriptorLocation = ViolationLocation; type RuleFixer = RuleTextEditor; type Fix = RuleTextEdit; } export type JSRuleDefinitionTypeOptions = CustomRuleTypeDefinitions; export type JSRuleDefinition< Options extends Partial = {}, > = CustomRuleDefinitionType< { LangOptions: Linter.LanguageOptions; Code: SourceCode; Visitor: Rule.RuleListener; Node: JSSyntaxElement; }, Options >; // #region Linter export class Linter { static readonly version: string; version: string; constructor(options?: { cwd?: string | undefined; configType?: "flat" | "eslintrc"; }); verify( code: SourceCode | string, config: Linter.LegacyConfig | Linter.Config | Linter.Config[], filename?: string, ): Linter.LintMessage[]; verify( code: SourceCode | string, config: Linter.LegacyConfig | Linter.Config | Linter.Config[], options: Linter.LintOptions, ): Linter.LintMessage[]; verifyAndFix( code: string, config: Linter.LegacyConfig | Linter.Config | Linter.Config[], filename?: string, ): Linter.FixReport; verifyAndFix( code: string, config: Linter.LegacyConfig | 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; defineParser(name: string, parser: Linter.Parser): void; getTimes(): Linter.Stats["times"]; getFixPassCount(): Linter.Stats["fixPasses"]; } export namespace Linter { /** * The numeric severity level for a rule. * * - `0` means off. * - `1` means warn. * - `2` means error. * * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities) */ 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 = 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 = CoreSeverity; /** * An array containing the rule severity level, followed by the rule options. * * @see [Rules](https://eslint.org/docs/latest/use/configure/rules) */ type RuleSeverityAndOptions = [ RuleSeverity, ...Partial, ]; /** * The severity level for the rule or an array containing the rule severity level, followed by the rule options. * * @see [Rules](https://eslint.org/docs/latest/use/configure/rules) */ type RuleEntry = RuleConfig; /** * The rules config object is a key/value map of rule names and their severity and options. */ type RulesRecord = RulesConfig; /** * A configuration object that may have a `rules` block. */ type HasRules = CoreHasRules; /** * The ECMAScript version of the code being linted. */ type EcmaVersion = CoreEcmaVersion; /** * The type of JavaScript source code. */ type SourceType = JavaScriptSourceType; /** * ESLint legacy configuration. * * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/) */ type BaseConfig< Rules extends RulesConfig = RulesConfig, OverrideRules extends RulesConfig = Rules, > = CoreBaseConfig; /** * The overwrites that apply more differing configuration to specific files or directories. */ type ConfigOverride = CoreConfigOverride; /** * ESLint legacy configuration. * * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/) */ // https://github.com/eslint/eslint/blob/v8.57.0/conf/config-schema.js type LegacyConfig< Rules extends RulesConfig = RulesConfig, OverrideRules extends RulesConfig = Rules, > = LegacyConfigObject; /** * Parser options. * * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options) */ type ParserOptions = JavaScriptParserOptionsConfig; /** * Options used for linting code with `Linter#verify` and `Linter#verifyAndFix`. */ interface LintOptions { filename?: string | undefined; preprocess?: ((code: string) => string[]) | undefined; postprocess?: | ((problemLists: LintMessage[][]) => LintMessage[]) | undefined; filterCodeBlock?: | ((filename: string, text: string) => boolean) | undefined; disableFixes?: boolean | undefined; allowInlineConfig?: boolean | undefined; reportUnusedDisableDirectives?: boolean | undefined; } type LintSuggestion = CoreLintSuggestion; type LintMessage = CoreLintMessage; interface LintSuppression { kind: string; justification: string; } interface SuppressedLintMessage extends LintMessage { /** The suppression info. */ suppressions: LintSuppression[]; } interface FixOptions extends LintOptions { fix?: boolean | undefined; } interface FixReport { fixed: boolean; output: string; messages: LintMessage[]; } // Temporarily loosen type for just flat config files (see https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68232) type NonESTreeParser = ESLint.ObjectMetaProperties & ( | { parse(text: string, options?: any): unknown; } | { parseForESLint( text: string, options?: any, ): Omit & { ast: unknown; scopeManager?: unknown; }; } ); type ESTreeParser = ESLint.ObjectMetaProperties & ( | { parse(text: string, options?: any): AST.Program } | { parseForESLint(text: string, options?: any): ESLintParseResult } ); type Parser = NonESTreeParser | ESTreeParser; interface ESLintParseResult { /** The AST object. */ ast: AST.Program; /** The services that the parser provides. */ services?: SourceCode.ParserServices | undefined; /** The scope manager of the AST. */ scopeManager?: Scope.ScopeManager | undefined; /** The visitor keys of the AST. */ visitorKeys?: SourceCode.VisitorKeys | undefined; } type ProcessorFile = CoreProcessorFile; // https://eslint.org/docs/latest/extend/plugins#processors-in-plugins type Processor = CoreProcessor; type Config = ConfigObject; /** @deprecated Use `Config` instead of `FlatConfig` */ type FlatConfig = Config; type GlobalConf = GlobalAccess; type Globals = GlobalsConfig; interface LanguageOptions extends GenericLanguageOptions { /** * The version of ECMAScript to support. May be any year (i.e., 2022) or * version (i.e., 5). Set to "latest" for the most recent supported version. * @default "latest" */ 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: "module" for .js and .mjs * files; "commonjs" for .cjs files) */ sourceType?: SourceType | undefined; /** * An object specifying additional objects that should be added to the * global scope during linting. */ globals?: Globals | undefined; /** * An object containing a parse() or parseForESLint() method. * If not configured, the default ESLint parser (Espree) will be used. */ parser?: Parser | undefined; /** * An object specifying additional options that are passed directly to the * parser() method on the parser. The available options are parser-dependent */ parserOptions?: Linter.ParserOptions | undefined; } type LinterOptions = LinterOptionsConfig; /** * Performance statistics. */ interface Stats { /** * The number of times ESLint has applied at least one fix after linting. */ fixPasses: number; /** * The times spent on (parsing, fixing, linting) a file, where the linting refers to the timing information for each rule. */ times: { passes: TimePass[] }; } interface TimePass { /** * The parse object containing all parse time information. */ parse: { total: number }; /** * The rules object containing all lint time information for each rule. */ rules?: Record; /** * The fix object containing all fix time information. */ fix: { total: number }; /** * The total time that is spent on (parsing, fixing, linting) a file. */ total: number; } } // #endregion // #region ESLint export class ESLint { static configType: "flat"; static readonly version: string; /** * The default configuration that ESLint uses internally. This is provided for tooling that wants to calculate configurations using the same defaults as ESLint. * Keep in mind that the default configuration may change from version to version, so you shouldn't rely on any particular keys or values to be present. */ static readonly defaultConfig: Linter.Config[]; static outputFixes(results: ESLint.LintResult[]): Promise; static getErrorResults(results: ESLint.LintResult[]): ESLint.LintResult[]; constructor(options?: ESLint.Options); lintFiles(patterns: string | string[]): Promise; lintText( code: string, options?: { filePath?: string | undefined; warnIgnored?: boolean | undefined; }, ): Promise; getRulesMetaForResults( results: ESLint.LintResult[], ): ESLint.LintResultData["rulesMeta"]; hasFlag(flag: string): boolean; calculateConfigForFile(filePath: string): Promise; findConfigFile(filePath?: string): Promise; isPathIgnored(filePath: string): Promise; loadFormatter(nameOrPath?: string): Promise; static fromOptionsModule(optionsURL: { readonly href: string; }): Promise; } export namespace ESLint { type ConfigData = Omit< Linter.LegacyConfig, "$schema" >; type Environment = EnvironmentConfig; type ObjectMetaProperties = CoreObjectMetaProperties; type Plugin = CorePlugin; type FixType = "directive" | "problem" | "suggestion" | "layout"; type CacheStrategy = "content" | "metadata"; interface Options { // File enumeration cwd?: string | undefined; errorOnUnmatchedPattern?: boolean | undefined; globInputPaths?: boolean | undefined; ignore?: boolean | undefined; ignorePatterns?: string[] | null | undefined; passOnNoPatterns?: boolean | undefined; warnIgnored?: boolean | undefined; // Linting allowInlineConfig?: boolean | undefined; baseConfig?: Linter.Config | Linter.Config[] | null | undefined; overrideConfig?: Linter.Config | Linter.Config[] | null | undefined; overrideConfigFile?: string | true | null | undefined; plugins?: Record | null | undefined; ruleFilter?: | ((arg: { ruleId: string; severity: Exclude; }) => boolean) | undefined; stats?: boolean | undefined; // Autofix fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined; fixTypes?: FixType[] | null | undefined; // Cache-related cache?: boolean | undefined; cacheLocation?: string | undefined; cacheStrategy?: CacheStrategy | undefined; // Other Options concurrency?: number | "auto" | "off" | undefined; flags?: string[] | undefined; } interface LegacyOptions { // File enumeration cwd?: string | undefined; errorOnUnmatchedPattern?: boolean | undefined; extensions?: string[] | undefined; globInputPaths?: boolean | undefined; ignore?: boolean | undefined; ignorePath?: string | undefined; // Linting allowInlineConfig?: boolean | undefined; baseConfig?: Linter.LegacyConfig | undefined; overrideConfig?: Linter.LegacyConfig | undefined; overrideConfigFile?: string | undefined; plugins?: Record | undefined; reportUnusedDisableDirectives?: Linter.StringSeverity | undefined; resolvePluginsRelativeTo?: string | undefined; rulePaths?: string[] | undefined; useEslintrc?: boolean | undefined; // Autofix fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined; fixTypes?: FixType[] | null | undefined; // Cache-related cache?: boolean | undefined; cacheLocation?: string | undefined; cacheStrategy?: CacheStrategy | undefined; // Other Options flags?: string[] | undefined; } /** A linting result. */ interface LintResult { /** The path to the file that was linted. */ filePath: string; /** All of the messages for the result. */ messages: Linter.LintMessage[]; /** All of the suppressed messages for the result. */ suppressedMessages: Linter.SuppressedLintMessage[]; /** Number of errors for the result. */ errorCount: number; /** Number of fatal errors for the result. */ fatalErrorCount: number; /** Number of warnings for the result. */ warningCount: number; /** Number of fixable errors for the result. */ fixableErrorCount: number; /** Number of fixable warnings for the result. */ fixableWarningCount: number; /** The source code of the file that was linted, with as many fixes applied as possible. */ output?: string | undefined; /** The source code of the file that was linted. */ source?: string | undefined; /** The performance statistics collected with the `stats` flag. */ stats?: Linter.Stats | undefined; /** The list of used deprecated rules. */ usedDeprecatedRules: DeprecatedRuleUse[]; } /** * Information provided when the maximum warning threshold is exceeded. */ interface MaxWarningsExceeded { /** * Number of warnings to trigger nonzero exit code. */ maxWarnings: number; /** * Number of warnings found while linting. */ foundWarnings: number; } interface LintResultData { cwd: string; maxWarningsExceeded?: MaxWarningsExceeded | undefined; rulesMeta: { [ruleId: string]: Rule.RuleMetaData; }; } /** * Information about deprecated rules. */ interface DeprecatedRuleUse { /** * The rule ID. */ ruleId: string; /** * The rule IDs that replace this deprecated rule. */ replacedBy: string[]; /** * The raw deprecated info provided by the rule. * - Undefined if the rule's `meta.deprecated` property is a boolean. * - Unset when using the legacy eslintrc configuration. */ info?: DeprecatedInfo | undefined; } /** * Metadata about results for formatters. */ interface ResultsMeta { /** * Present if the maxWarnings threshold was exceeded. */ maxWarningsExceeded?: MaxWarningsExceeded | undefined; } /** The type of an object resolved by {@link ESLint.loadFormatter}. */ interface LoadedFormatter { /** * 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 * passed to the underlying formatter function along with other properties set by ESLint. * This argument can be omitted if `maxWarningsExceeded` is not needed. * @return The formatter output. */ format( results: LintResult[], resultsMeta?: ResultsMeta, ): string | Promise; } // The documented type name is `LoadedFormatter`, but `Formatter` has been historically more used. type Formatter = LoadedFormatter; /** * The expected signature of a custom formatter. * @param results An array of lint results to format. * @param context Additional information for the formatter. * @return The formatter output. */ type FormatterFunction = ( results: LintResult[], context: LintResultData, ) => string | Promise; // Docs reference the types by those name type EditInfo = Rule.Fix; } // #endregion export function loadESLint(options: { useFlatConfig: true; }): Promise; export function loadESLint(options: { useFlatConfig: false; }): Promise; export function loadESLint(options?: { useFlatConfig?: boolean | undefined; }): Promise; // #region RuleTester export class RuleTester { static describe: ((...args: any) => any) | null; static it: ((...args: any) => any) | null; static itOnly: ((...args: any) => any) | null; constructor(config?: Linter.Config); run( name: string, rule: RuleDefinition, tests: { valid: Array; invalid: RuleTester.InvalidTestCase[]; }, ): void; static only( item: string | RuleTester.ValidTestCase | RuleTester.InvalidTestCase, ): RuleTester.ValidTestCase | RuleTester.InvalidTestCase; } export namespace RuleTester { interface ValidTestCase { name?: string; code: string; options?: any; filename?: string | undefined; only?: boolean; languageOptions?: Linter.LanguageOptions | undefined; settings?: { [name: string]: any } | undefined; before?: () => void; after?: () => void; } interface SuggestionOutput { messageId?: string; desc?: string; data?: Record | undefined; output: string; } interface InvalidTestCase extends ValidTestCase { errors: number | Array; 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; line?: number | undefined; column?: number | undefined; endLine?: number | undefined; endColumn?: number | undefined; suggestions?: SuggestionOutput[] | undefined; } } // #endregion