/
eslint-utils.d.ts
180 lines (165 loc) · 5.9 KB
/
eslint-utils.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
declare module 'eslint-utils' {
import { TSESLint, TSESTree } from '@typescript-eslint/experimental-utils';
export function getFunctionHeadLocation(
node:
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression
| TSESTree.ArrowFunctionExpression,
sourceCode: TSESLint.SourceCode,
): TSESTree.SourceLocation;
export function getFunctionNameWithKind(
node:
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression
| TSESTree.ArrowFunctionExpression,
): string;
export function getPropertyName(
node:
| TSESTree.MemberExpression
| TSESTree.OptionalMemberExpression
| TSESTree.Property
| TSESTree.MethodDefinition,
initialScope?: TSESLint.Scope.Scope,
): string | null;
export function getStaticValue(
node: TSESTree.Node,
initialScope?: TSESLint.Scope.Scope,
): { value: unknown } | null;
export function getStringIfConstant(
node: TSESTree.Node,
initialScope?: TSESLint.Scope.Scope,
): string | null;
export function hasSideEffect(
node: TSESTree.Node,
sourceCode: TSESLint.SourceCode,
options?: {
considerGetters?: boolean;
considerImplicitTypeConversion?: boolean;
},
): boolean;
export function isParenthesized(
node: TSESTree.Node,
sourceCode: TSESLint.SourceCode,
): boolean;
export class PatternMatcher {
constructor(pattern: RegExp, options?: { escaped?: boolean });
execAll(str: string): IterableIterator<RegExpExecArray>;
test(str: string): boolean;
}
export function findVariable(
initialScope: TSESLint.Scope.Scope,
name: string,
): TSESLint.Scope.Variable | null;
export function getInnermostScope(
initialScope: TSESLint.Scope.Scope,
node: TSESTree.Node,
): TSESLint.Scope.Scope;
export class ReferenceTracker {
static readonly READ: unique symbol;
static readonly CALL: unique symbol;
static readonly CONSTRUCT: unique symbol;
constructor(
globalScope: TSESLint.Scope.Scope,
options?: {
mode: 'strict' | 'legacy';
globalObjectNames: readonly string[];
},
);
iterateGlobalReferences<T>(
traceMap: ReferenceTracker.TraceMap<T>,
): IterableIterator<ReferenceTracker.FoundReference<T>>;
iterateCjsReferences<T>(
traceMap: ReferenceTracker.TraceMap<T>,
): IterableIterator<ReferenceTracker.FoundReference<T>>;
iterateEsmReferences<T>(
traceMap: ReferenceTracker.TraceMap<T>,
): IterableIterator<ReferenceTracker.FoundReference<T>>;
}
export namespace ReferenceTracker {
export type READ = typeof ReferenceTracker.READ;
export type CALL = typeof ReferenceTracker.READ;
export type CONSTRUCT = typeof ReferenceTracker.READ;
export type ReferenceType = READ | CALL | CONSTRUCT;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type TraceMap<T = any> = Record<string, TraceMapElement<T>>;
export interface TraceMapElement<T> {
[ReferenceTracker.READ]?: T;
[ReferenceTracker.CALL]?: T;
[ReferenceTracker.CONSTRUCT]?: T;
[key: string]: TraceMapElement<T>;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export interface FoundReference<T = any> {
node: TSESTree.Node;
path: readonly string[];
type: ReferenceType;
entry: T;
}
}
export function isArrowToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: '=>' };
export function isNotArrowToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isClosingBraceToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: '}' };
export function isNotClosingBraceToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isClosingBracketToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: ']' };
export function isNotClosingBracketToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isClosingParenToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: ')' };
export function isNotClosingParenToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isColonToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: ':' };
export function isNotColonToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isCommaToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: ',' };
export function isNotCommaToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isCommentToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.Comment;
export function isNotCommentToken<
T extends TSESTree.Token | TSESTree.Comment
>(token: T): token is Exclude<T, TSESTree.Comment>;
export function isOpeningBraceToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: '{' };
export function isNotOpeningBraceToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isOpeningBracketToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: '[' };
export function isNotOpeningBracketToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isOpeningParenToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: '(' };
export function isNotOpeningParenToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
export function isSemicolonToken(
token: TSESTree.Token | TSESTree.Comment,
): token is TSESTree.PunctuatorToken & { value: ';' };
export function isNotSemicolonToken(
token: TSESTree.Token | TSESTree.Comment,
): boolean;
}