From 871c58a7b4c8ce83c8bfc94e51e1b13e9fe6fce9 Mon Sep 17 00:00:00 2001 From: Pierre-Marie Date: Wed, 31 Jan 2018 20:35:55 -0800 Subject: [PATCH] Refactor type defition to leverage namespaces --- types/eslint/eslint-tests.ts | 8 +- types/eslint/index.d.ts | 832 +++++++++++++++++++---------------- 2 files changed, 450 insertions(+), 390 deletions(-) diff --git a/types/eslint/eslint-tests.ts b/types/eslint/eslint-tests.ts index a1c4ddbbc8..46f960dbd4 100644 --- a/types/eslint/eslint-tests.ts +++ b/types/eslint/eslint-tests.ts @@ -15,6 +15,10 @@ const lines: string[] = sourceCode.getLines(); SourceCode.splitLines(SOURCE); +class Foo { + foo = 1; +} + // ============================================= // Linter // ============================================= @@ -89,7 +93,9 @@ CLIEngine.outputFixes(report); const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 2015 } }); -ruleTester.run("my-rule", {}, { +ruleTester.run("my-rule", { + create() {}, +}, { valid: [ { code: "var foo = true", diff --git a/types/eslint/index.d.ts b/types/eslint/index.d.ts index d6326c4ad5..d30abc5aa1 100644 --- a/types/eslint/index.d.ts +++ b/types/eslint/index.d.ts @@ -9,16 +9,16 @@ import { JSONSchema4 } from 'json-schema'; import * as ESTree from 'estree'; export type TokenType = - | 'Boolean' - | 'Null' - | 'Identifier' - | 'Keyword' - | 'Punctuator' - | 'JSXIdentifier' - | 'JSXText' - | 'Numeric' - | 'String' - | 'RegularExpression'; + | 'Boolean' + | 'Null' + | 'Identifier' + | 'Keyword' + | 'Punctuator' + | 'JSXIdentifier' + | 'JSXText' + | 'Numeric' + | 'String' + | 'RegularExpression'; export interface Token { type: TokenType; @@ -46,146 +46,81 @@ export interface Ast { range: Range; } -export type FilterPredicate = (tokenOrComment: Token | ESTree.Comment) => boolean; +export namespace Scope { + interface ScopeManager { + scopes: Scope[]; + globalScope: Scope | null; -export type CursorWithSkipOptions = number | FilterPredicate | { - includeComments?: boolean; - filter?: FilterPredicate; - skip?: number; -}; + acquire(node: ESTree.Node, inner?: boolean): Scope | null; -export type CursorWithCountOptions = number | FilterPredicate | { - includeComments?: boolean; - filter?: FilterPredicate; - count?: number; -}; + getDeclaredVariables(node: ESTree.Node): Variable[]; + } -export class TokenStore { - getTokenByRangeStart(offset: number, options?: { includeComments?: boolean }): Token | null; + interface Scope { + type: 'block' | 'catch' | 'class' | '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; + } - getFirstToken(node: ESTree.Node, options: CursorWithSkipOptions): Token | null; + interface Variable { + name: string; + identifiers: ESTree.Identifier; + references: Reference[]; + defs: Definition[]; + } - getFirstTokens(node: ESTree.Node, options: CursorWithCountOptions): Token[]; + interface Reference { + identifier: ESTree.Identifier; + from: Scope; + resolved: Variable | null; + writeExpr: ESTree.Node | null; + init: boolean; - getLastToken(node: ESTree.Node, options: CursorWithSkipOptions): Token | null; + isWrite(): boolean; - getLastTokens(node: ESTree.Node, options: CursorWithCountOptions): Token[]; + isRead(): boolean; - getTokenBefore(node: ESTree.Node | Token | ESTree.Comment, options: CursorWithSkipOptions): Token | null; + isWriteOnly(): boolean; - getTokensBefore(node: ESTree.Node | Token | ESTree.Comment, options: CursorWithCountOptions): Token[]; + isReadOnly(): boolean; - getTokenAfter(node: ESTree.Node | Token | ESTree.Comment, options: CursorWithSkipOptions): Token | null; + isReadWrite(): boolean; + } - getTokensAfter(node: ESTree.Node | Token | ESTree.Comment, options: CursorWithCountOptions): Token[]; + 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.Program, 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 }; - getFirstTokenBetween(left: ESTree.Node | Token | ESTree.Comment, right: ESTree.Node | Token | ESTree.Comment, options: CursorWithSkipOptions): Token | null; - - getFirstTokensBetween(left: ESTree.Node | Token | ESTree.Comment, right: ESTree.Node | Token | ESTree.Comment, options: CursorWithCountOptions): Token[]; - - getLastTokenBetween(left: ESTree.Node | Token | ESTree.Comment, right: ESTree.Node | Token | ESTree.Comment, options: CursorWithSkipOptions): Token | null; - - getLastTokensBetween(left: ESTree.Node | Token | ESTree.Comment, right: ESTree.Node | Token | ESTree.Comment, options: CursorWithCountOptions): Token[]; - - getTokens(node: ESTree.Node, beforeCount?: number, afterCount?: number): Token[]; - getTokens(node: ESTree.Node, options: FilterPredicate | CursorWithCountOptions): Token[]; - - getTokensBetween(left: ESTree.Node | Token | ESTree.Comment, right: ESTree.Node | Token | ESTree.Comment, padding: number | FilterPredicate | CursorWithCountOptions): Token[]; - - commentsExistBetween(left: ESTree.Node, right: ESTree.Node): boolean; - - getCommentsBefore(nodeOrToken: ESTree.Node | Token): ESTree.Comment[]; - - getCommentsAfter(nodeOrToken: ESTree.Node | Token): ESTree.Comment[]; - - getCommentsInside(node: ESTree.Node): ESTree.Comment[]; + type Definition = DefinitionType & { name: ESTree.Identifier }; } -export interface SourceCodeConfig { - text: string; - ast: Ast; - parserServices?: ParserServices; - scopeManager?: ScopeManager; - visitorKeys?: VisitorKeys; -} +//#region SourceCode -export type ParserServices = any; - -export interface ScopeManager { - scopes: Scope[]; - globalScope: Scope | null; - - acquire(node: ESTree.Node, inner?: boolean): Scope | null; - - getDeclaredVariables(node: ESTree.Node): Variable[]; -} - -export interface Scope { - type: 'block' | 'catch' | 'class' | '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; -} - -export interface Variable { - name: string; - identifiers: ESTree.Identifier; - references: Reference[]; - defs: Definition[]; -} - -export 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; -} - -export 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.Program, 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 }; - -export type Definition = DefinitionType & { name: ESTree.Identifier }; - -export interface VisitorKeys { - [nodeType: string]: string[]; -} - -export class SourceCode extends TokenStore { +export class SourceCode { text: string; ast: Ast; lines: string[]; hasBOM: boolean; - parserServices: ParserServices; - scopeManager: ScopeManager; - visitorKeys: VisitorKeys; + parserServices: SourceCode.ParserServices; + scopeManager: Scope.ScopeManager; + visitorKeys: SourceCode.VisitorKeys; constructor(text: string, ast: Ast); - constructor(config: SourceCodeConfig); + constructor(config: SourceCode.Config); static splitLines(text: string): string[]; @@ -206,317 +141,436 @@ export class SourceCode extends TokenStore { getLocFromIndex(index: number): Location; getIndexFromLoc(location: Location): number; + + // Inherited methods from TokenStore + // --------------------------------- + + getTokenByRangeStart(offset: number, options?: { includeComments?: boolean }): Token | null; + + getFirstToken(node: ESTree.Node, options: SourceCode.CursorWithSkipOptions): Token | null; + + getFirstTokens(node: ESTree.Node, options: SourceCode.CursorWithCountOptions): Token[]; + + getLastToken(node: ESTree.Node, options: SourceCode.CursorWithSkipOptions): Token | null; + + getLastTokens(node: ESTree.Node, options: SourceCode.CursorWithCountOptions): Token[]; + + getTokenBefore(node: ESTree.Node | Token | ESTree.Comment, options: SourceCode.CursorWithSkipOptions): Token | null; + + getTokensBefore(node: ESTree.Node | Token | ESTree.Comment, options: SourceCode.CursorWithCountOptions): Token[]; + + getTokenAfter(node: ESTree.Node | Token | ESTree.Comment, options: SourceCode.CursorWithSkipOptions): Token | null; + + getTokensAfter(node: ESTree.Node | Token | ESTree.Comment, options: SourceCode.CursorWithCountOptions): Token[]; + + getFirstTokenBetween( + left: ESTree.Node | Token | ESTree.Comment, + right: ESTree.Node | Token | ESTree.Comment, + options: SourceCode.CursorWithSkipOptions + ): Token | null; + + getFirstTokensBetween( + left: ESTree.Node | Token | ESTree.Comment, + right: ESTree.Node | Token | ESTree.Comment, + options: SourceCode.CursorWithCountOptions + ): Token[]; + + getLastTokenBetween( + left: ESTree.Node | Token | ESTree.Comment, + right: ESTree.Node | Token | ESTree.Comment, + options: SourceCode.CursorWithSkipOptions + ): Token | null; + + getLastTokensBetween( + left: ESTree.Node | Token | ESTree.Comment, + right: ESTree.Node | Token | ESTree.Comment, + options: SourceCode.CursorWithCountOptions + ): Token[]; + + getTokensBetween( + left: ESTree.Node | Token | ESTree.Comment, + right: ESTree.Node | Token | ESTree.Comment, + padding: number | SourceCode.FilterPredicate | SourceCode.CursorWithCountOptions + ): Token[]; + + getTokens(node: ESTree.Node, beforeCount?: number, afterCount?: number): Token[]; + getTokens(node: ESTree.Node, options: SourceCode.FilterPredicate | SourceCode.CursorWithCountOptions): Token[]; + + commentsExistBetween(left: ESTree.Node, right: ESTree.Node): boolean; + + getCommentsBefore(nodeOrToken: ESTree.Node | Token): ESTree.Comment[]; + + getCommentsAfter(nodeOrToken: ESTree.Node | Token): ESTree.Comment[]; + + getCommentsInside(node: ESTree.Node): ESTree.Comment[]; } -export type RuleLevel = 'off' | 'warn' | 'error' | 0 | 1 | 2; +export namespace SourceCode { + interface Config { + text: string; + ast: Ast; + parserServices?: ParserServices; + scopeManager?: Scope.ScopeManager; + visitorKeys?: VisitorKeys; + } -export interface ParserOptions { - ecmaVersion?: 3 | 5 | 6 | 7 | 8 | 9 | 2015 | 2016 | 2017 | 2018; - sourceType?: 'script' | 'module'; - ecmaFeatures?: { - globalReturn?: boolean; - impliedStrict?: boolean; - jsx?: boolean; - experimentalObjectRestSpread?: boolean; - [key: string]: any; + type ParserServices = any; + + interface VisitorKeys { + [nodeType: string]: string[]; + } + + type FilterPredicate = (tokenOrComment: Token | ESTree.Comment) => boolean; + + type CursorWithSkipOptions = number | FilterPredicate | { + includeComments?: boolean; + filter?: FilterPredicate; + skip?: number; }; - [key: string]: any; -} -export interface Config { - rules?: { - [name: string]: (RuleLevel | [RuleLevel, any]) + type CursorWithCountOptions = number | FilterPredicate | { + includeComments?: boolean; + filter?: FilterPredicate; + count?: number; }; - parser?: string; - parserOptions?: ParserOptions; - settings?: { [name: string]: any }; - env?: { [name: string]: boolean }; - globals?: { [name: string]: boolean }; } -export interface LintOptions { - filename?: string; - preprocess?: (code: string) => string[]; - postprocess?: (problemLists: LintMessage[][]) => LintMessage[]; - allowInlineConfig?: boolean; - reportUnusedDisableDirectives?: boolean; +//#endregion + +export namespace Rule { + interface RuleModule { + create(context: RuleContext): any; + meta?: RuleMetaData; + } + + interface RuleListener { + onCodePathStart?(codePath: CodePath, node: ESTree.Node): void; + + onCodePathEnd?(codePath: CodePath, node: ESTree.Node): void; + + onCodePathSegmentStart?(segment: CodePathSegment, node: ESTree.Node): void; + + onCodePathSegmentEnd?(segment: CodePathSegment, node: ESTree.Node): void; + + onCodePathSegmentLoop?(fromSegment: CodePathSegment, toSegment: CodePathSegment, node: ESTree.Node): void; + + [key: string]: + | ((codePath: CodePath, node: ESTree.Node) => void) + | ((segment: CodePathSegment, node: ESTree.Node) => void) + | ((fromSegment: CodePathSegment, toSegment: CodePathSegment, node: ESTree.Node) => void) + | ((node: ESTree.Node) => void) + | undefined; + } + + interface CodePath { + id: string; + initialSegment: CodePathSegment; + finalSegments: CodePathSegment[]; + returnedSegments: CodePathSegment[]; + thrownSegments: CodePathSegment[]; + currentSegments: CodePathSegment[]; + upper: CodePath | null; + childCodePaths: CodePath[]; + } + + interface CodePathSegment { + id: string; + nextSegments: CodePathSegment[]; + prevSegments: CodePathSegment[]; + reachable: boolean; + } + + interface RuleMetaData { + docs?: { + description?: string; + category?: string; + recommended?: boolean; + url?: string; + }; + messages?: { [messageId: string]: string }; + fixable?: 'code' | 'whitespace'; + schema?: JSONSchema4 | JSONSchema4[]; + deprecated?: boolean; + } + + interface RuleContext { + id: string; + options: any[]; + settings: { [name: string]: any }; + parserPath: string; + parserOptions: Linter.ParserOptions; + parserServices: SourceCode.ParserServices; + + getAncestors(): ESTree.Node[]; + + getDeclaredVariables(node: ESTree.Node): Scope.Variable[]; + + getFilename(): string; + + getScope(): Scope.Scope; + + getSourceCode(): SourceCode; + + markVariableAsUsed(name: string): boolean; + + report(descriptor: ReportDescriptor): void; + } + + type ReportDescriptor = ReportDescriptorMessage & ReportDescriptorLocation & ReportDescriptorOptions; + type ReportDescriptorMessage = { message: string } | { messageId: string }; + type ReportDescriptorLocation = { node: ESTree.Node } | { loc: SourceLocation | { line: number, column: number } }; + interface ReportDescriptorOptions { + data?: { [key: string]: string }; + + fix?(fixer: RuleFixer): null | Fix | IterableIterator; + } + + interface RuleFixer { + insertTextAfter(nodeOrToken: ESTree.Node | Token, text: string): Fix; + + insertTextAfterRange(range: Range, text: string): Fix; + + insertTextBefore(nodeOrToken: ESTree.Node | Token, text: string): Fix; + + insertTextBeforeRange(range: Range, text: string): Fix; + + remove(nodeOrToken: ESTree.Node | Token): Fix; + + removeRange(range: Range): Fix; + + replaceText(nodeOrToken: ESTree.Node | Token, text: string): Fix; + + replaceTextRange(range: Range, text: string): Fix; + } + + interface Fix { + range: Range; + text: string; + } } -export type Severity = 1 | 2; - -export interface LintMessage { - column: number; - line: number; - endColumn?: number; - endLine?: number; - ruleId: string | null; - message: string; - nodeType: string; - fatal?: true; - severity: Severity; - fix?: Fix; - source: string | null; -} - -export interface FixOptions extends LintOptions { - fix?: boolean; -} - -export interface Fix { - range: Range; - text: string; -} - -export interface FixReport { - fixed: boolean; - output: string; - messages: LintMessage[]; -} - -export interface RuleModule { - create(context: RuleContext): any; - meta?: RuleMetaData; -} - -export interface RuleListener { - onCodePathStart?(codePath: CodePath, node: ESTree.Node): void; - - onCodePathEnd?(codePath: CodePath, node: ESTree.Node): void; - - onCodePathSegmentStart?(segment: CodePathSegment, node: ESTree.Node): void; - - onCodePathSegmentEnd?(segment: CodePathSegment, node: ESTree.Node): void; - - onCodePathSegmentLoop?(fromSegment: CodePathSegment, toSegment: CodePathSegment, node: ESTree.Node): void; - - [key: string]: - | ((codePath: CodePath, node: ESTree.Node) => void) - | ((segment: CodePathSegment, node: ESTree.Node) => void) - | ((fromSegment: CodePathSegment, toSegment: CodePathSegment, node: ESTree.Node) => void) - | ((node: ESTree.Node) => void) - | undefined; -} - -export interface CodePath { - id: string; - initialSegment: CodePathSegment; - finalSegments: CodePathSegment[]; - returnedSegments: CodePathSegment[]; - thrownSegments: CodePathSegment[]; - currentSegments: CodePathSegment[]; - upper: CodePath | null; - childCodePaths: CodePath[]; -} - -export interface CodePathSegment { - id: string; - nextSegments: CodePathSegment[]; - prevSegments: CodePathSegment[]; - reachable: boolean; -} - -export interface RuleMetaData { - docs?: { - description?: string; - category?: string; - recommended?: boolean; - url?: string; - }; - messages?: { [messageId: string]: string }; - fixable?: 'code' | 'whitespace'; - schema?: JSONSchema4 | JSONSchema4[]; - deprecated?: boolean; -} - -export interface RuleContext { - id: string; - options: any[]; - settings: { [name: string]: any }; - parserPath: string; - parserOptions: ParserOptions; - parserServices: ParserServices; - - getAncestors(): ESTree.Node[]; - - getDeclaredVariables(node: ESTree.Node): Variable[]; - - getFilename(): string; - - getScope(): Scope; - - getSourceCode(): SourceCode; - - markVariableAsUsed(name: string): boolean; - - report(descriptor: ReportDescriptor): void; -} - -export type ReportDescriptor = ReportDescriptorMessage & ReportDescriptorLocation & ReportDescriptorOptions; -export type ReportDescriptorMessage = { message: string } | { messageId: string }; -export type ReportDescriptorLocation = { node: ESTree.Node } | { loc: SourceLocation | { line: number, column: number } }; -export interface ReportDescriptorOptions { - data?: { [key: string]: string }; - - fix?(fixer: RuleFixer): null | Fix | IterableIterator; -} - -export interface RuleFixer { - insertTextAfter(nodeOrToken: ESTree.Node | Token, text: string): Fix; - - insertTextAfterRange(range: Range, text: string): Fix; - - insertTextBefore(nodeOrToken: ESTree.Node | Token, text: string): Fix; - - insertTextBeforeRange(range: Range, text: string): Fix; - - remove(nodeOrToken: ESTree.Node | Token): Fix; - - removeRange(range: Range): Fix; - - replaceText(nodeOrToken: ESTree.Node | Token, text: string): Fix; - - replaceTextRange(range: Range, text: string): Fix; -} - -export type ParserModule = { - parse(text: string, options?: any): ESTree.Node; -} | { - parseForESLint(text: string, options?: any): ESLintParseResult; -}; - -export interface ESLintParseResult { - ast: ESTree.Node; - parserServices?: ParserServices; - scopeManager?: ScopeManager; - visitorKeys?: VisitorKeys; -} +//#region Linter export class Linter { version: string; - verify(code: SourceCode | string, config: Config, filename?: string): LintMessage[]; - verify(code: SourceCode | string, config: Config, options: LintOptions): LintMessage[]; + verify(code: SourceCode | string, config: Linter.Config, filename?: string): Linter.LintMessage[]; + verify(code: SourceCode | string, config: Linter.Config, options: Linter.LintOptions): Linter.LintMessage[]; - verifyAndFix(code: string, config: Config, filename?: string): FixReport; - verifyAndFix(code: string, config: Config, options: FixOptions): FixReport; + verifyAndFix(code: string, config: Linter.Config, filename?: string): Linter.FixReport; + verifyAndFix(code: string, config: Linter.Config, options: Linter.FixOptions): Linter.FixReport; getSourceCode(): SourceCode; - defineRule(name: string, rule: RuleModule): void; + defineRule(name: string, rule: Rule.RuleModule): void; - defineRules(rules: { [name: string]: RuleModule }): void; + defineRules(rules: { [name: string]: Rule.RuleModule }): void; - getRules(): Map; + getRules(): Map; - defineParser(name: string, parser: ParserModule): void; + defineParser(name: string, parser: Linter.ParserModule): void; } -export class CLIEngineOptions { - allowInlineConfig?: boolean; - baseConfig?: boolean; - cache?: boolean; - cacheFile?: string; - cacheLocation?: string; - configFile?: string; - cwd?: string; - envs?: string[]; - extensions?: string[]; - fix?: boolean; - globals?: string[]; - ignore?: boolean; - ignorePath?: string; - ignorePattern?: string; - useEslintrc?: boolean; - parser?: string; - parserOptions?: ParserOptions; - plugins?: string[]; - rules?: { - [name: string]: (RuleLevel | [RuleLevel, any]); +export namespace Linter { + type Severity = 0 | 1 | 2; + type RuleLevel = Severity | 'off' | 'warn' | 'error'; + + interface RuleLevelAndOptions extends Array { + 0: RuleLevel; + } + + interface Config { + rules?: { + [name: string]: RuleLevel | RuleLevelAndOptions + }; + parser?: string; + parserOptions?: ParserOptions; + settings?: { [name: string]: any }; + env?: { [name: string]: boolean }; + globals?: { [name: string]: boolean }; + } + + interface ParserOptions { + ecmaVersion?: 3 | 5 | 6 | 7 | 8 | 9 | 2015 | 2016 | 2017 | 2018; + sourceType?: 'script' | 'module'; + ecmaFeatures?: { + globalReturn?: boolean; + impliedStrict?: boolean; + jsx?: boolean; + experimentalObjectRestSpread?: boolean; + [key: string]: any; + }; + [key: string]: any; + } + + interface LintOptions { + filename?: string; + preprocess?: (code: string) => string[]; + postprocess?: (problemLists: LintMessage[][]) => LintMessage[]; + allowInlineConfig?: boolean; + reportUnusedDisableDirectives?: boolean; + } + + interface LintMessage { + column: number; + line: number; + endColumn?: number; + endLine?: number; + ruleId: string | null; + message: string; + nodeType: string; + fatal?: true; + severity: Severity; + fix?: Rule.Fix; + source: string | null; + } + + interface FixOptions extends LintOptions { + fix?: boolean; + } + + interface FixReport { + fixed: boolean; + output: string; + messages: LintMessage[]; + } + + type ParserModule = { + parse(text: string, options?: any): ESTree.Node; + } | { + parseForESLint(text: string, options?: any): ESLintParseResult; }; - rulePaths?: string[]; - reportUnusedDisableDirectives?: true; + + interface ESLintParseResult { + ast: ESTree.Node; + parserServices?: SourceCode.ParserServices; + scopeManager?: Scope.ScopeManager; + visitorKeys?: SourceCode.VisitorKeys; + } } -export interface LintResult { - filePath: string; - messages: LintMessage[]; - errorCount: number; - warningCount: number; - fixableErrorCount: number; - fixableWarningCount: number; - output?: string; - source?: string; -} +//#endregion -export interface LintReport { - results: LintResult[]; - errorCount: number; - warningCount: number; - fixableErrorCount: number; - fixableWarningCount: number; -} - -export type Formatter = (results: LintResult[]) => string; +//#region CLIEngine export class CLIEngine { version: string; - constructor(options: CLIEngineOptions); + constructor(options: CLIEngine.Options); - executeOnFiles(patterns: string[]): LintReport; + executeOnFiles(patterns: string[]): CLIEngine.LintReport; resolveFileGlobPatterns(patterns: string[]): string[]; - getConfigForFile(filePath: string): Config; + getConfigForFile(filePath: string): Linter.Config; - executeOnText(text: string, filename?: string): LintReport; + executeOnText(text: string, filename?: string): CLIEngine.LintReport; addPlugin(name: string, pluginObject: any): void; isPathIgnored(filePath: string): boolean; - getFormatter(format: string): Formatter; + getFormatter(format: string): CLIEngine.Formatter; - static getErrorResults(results: LintResult[]): LintResult[]; + getRules(): Map; - static outputFixes(report: LintReport): void; + static getErrorResults(results: CLIEngine.LintResult[]): CLIEngine.LintResult[]; - getRules(): Map; + static outputFixes(report: CLIEngine.LintReport): void; } -export interface ValidTestCase { - code: string; - options?: any; - filename?: string; - parserOptions?: ParserOptions; - settings?: { [name: string]: any }; - parser?: string; - globals?: { [name: string]: boolean }; +export namespace CLIEngine { + class Options { + allowInlineConfig?: boolean; + baseConfig?: boolean; + cache?: boolean; + cacheFile?: string; + cacheLocation?: string; + configFile?: string; + cwd?: string; + envs?: string[]; + extensions?: string[]; + fix?: boolean; + globals?: string[]; + ignore?: boolean; + ignorePath?: string; + ignorePattern?: string; + useEslintrc?: boolean; + parser?: string; + parserOptions?: Linter.ParserOptions; + plugins?: string[]; + rules?: { + [name: string]: (Linter.RuleLevel | [Linter.RuleLevel, any]); + }; + rulePaths?: string[]; + reportUnusedDisableDirectives?: true; + } + + interface LintResult { + filePath: string; + messages: Linter.LintMessage[]; + errorCount: number; + warningCount: number; + fixableErrorCount: number; + fixableWarningCount: number; + output?: string; + source?: string; + } + + interface LintReport { + results: LintResult[]; + errorCount: number; + warningCount: number; + fixableErrorCount: number; + fixableWarningCount: number; + } + + type Formatter = (results: LintResult[]) => string; } -export interface TestCaseError { - message?: string | RegExp; - messageId?: string; - type?: string; - data?: any; - line?: number; - column?: number; - endLine?: number; - endColumn?: number; -} +//#endregion -export interface InvalidTestCase extends ValidTestCase { - errors: number | Array; - output?: string; -} - -export interface Test { - valid?: ValidTestCase[]; - invalid: InvalidTestCase[]; -} +//#region RuleTester export class RuleTester { constructor(config?: any); - run(name: string, rule: any, tests: Test): void; + run( + name: string, + rule: Rule.RuleModule, + tests: { + valid?: RuleTester.ValidTestCase[]; + invalid?: RuleTester.InvalidTestCase[]; + }, + ): void; } + +export namespace RuleTester { + interface ValidTestCase { + code: string; + options?: any; + filename?: string; + parserOptions?: Linter.ParserOptions; + settings?: { [name: string]: any }; + parser?: string; + globals?: { [name: string]: boolean }; + } + + interface InvalidTestCase extends ValidTestCase { + errors: number | Array; + output?: string; + } + + interface TestCaseError { + message?: string | RegExp; + messageId?: string; + type?: string; + data?: any; + line?: number; + column?: number; + endLine?: number; + endColumn?: number; + } +} + +//#endregion