/
no-use-before-define.ts
257 lines (231 loc) · 6.79 KB
/
no-use-before-define.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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
import { AST_NODE_TYPES, TSESLint, TSESTree } from '@typescript-eslint/util';
import * as util from '../util';
const SENTINEL_TYPE = /^(?:(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|CatchClause|ImportDeclaration|ExportNamedDeclaration)$/;
/**
* Parses a given value as options.
*/
function parseOptions(options: string | Config | null): Required<Config> {
let functions = true;
let classes = true;
let variables = true;
let typedefs = true;
if (typeof options === 'string') {
functions = options !== 'nofunc';
} else if (typeof options === 'object' && options !== null) {
functions = options.functions !== false;
classes = options.classes !== false;
variables = options.variables !== false;
typedefs = options.typedefs !== false;
}
return { functions, classes, variables, typedefs };
}
/**
* Checks whether or not a given scope is a top level scope.
*/
function isTopLevelScope(scope: TSESLint.Scope.Scope): boolean {
return scope.type === 'module' || scope.type === 'global';
}
/**
* Checks whether or not a given variable is a function declaration.
*/
function isFunction(variable: TSESLint.Scope.Variable): boolean {
return variable.defs[0].type === 'FunctionName';
}
/**
* Checks whether or not a given variable is a class declaration in an upper function scope.
*/
function isOuterClass(
variable: TSESLint.Scope.Variable,
reference: TSESLint.Scope.Reference,
): boolean {
if (variable.defs[0].type !== 'ClassName') {
return false;
}
if (variable.scope.variableScope === reference.from.variableScope) {
// allow the same scope only if it's the top level global/module scope
if (!isTopLevelScope(variable.scope.variableScope)) {
return false;
}
}
return true;
}
/**
* Checks whether or not a given variable is a variable declaration in an upper function scope.
*/
function isOuterVariable(
variable: TSESLint.Scope.Variable,
reference: TSESLint.Scope.Reference,
): boolean {
if (variable.defs[0].type !== 'Variable') {
return false;
}
if (variable.scope.variableScope === reference.from.variableScope) {
// allow the same scope only if it's the top level global/module scope
if (!isTopLevelScope(variable.scope.variableScope)) {
return false;
}
}
return true;
}
/**
* Checks whether or not a given location is inside of the range of a given node.
*/
function isInRange(
node: TSESTree.Expression | null | undefined,
location: number,
): boolean {
return !!node && node.range[0] <= location && location <= node.range[1];
}
/**
* Checks whether or not a given reference is inside of the initializers of a given variable.
*
* @returns `true` in the following cases:
* - var a = a
* - var [a = a] = list
* - var {a = a} = obj
* - for (var a in a) {}
* - for (var a of a) {}
*/
function isInInitializer(
variable: TSESLint.Scope.Variable,
reference: TSESLint.Scope.Reference,
): boolean {
if (variable.scope !== reference.from) {
return false;
}
let node = variable.identifiers[0].parent;
const location = reference.identifier.range[1];
while (node) {
if (node.type === AST_NODE_TYPES.VariableDeclarator) {
if (isInRange(node.init, location)) {
return true;
}
if (
node.parent &&
node.parent.parent &&
(node.parent.parent.type === AST_NODE_TYPES.ForInStatement ||
node.parent.parent.type === AST_NODE_TYPES.ForOfStatement) &&
isInRange(node.parent.parent.right, location)
) {
return true;
}
break;
} else if (node.type === AST_NODE_TYPES.AssignmentPattern) {
if (isInRange(node.right, location)) {
return true;
}
} else if (SENTINEL_TYPE.test(node.type)) {
break;
}
node = node.parent;
}
return false;
}
interface Config {
functions?: boolean;
classes?: boolean;
variables?: boolean;
typedefs?: boolean;
}
type Options = ['nofunc' | Config];
type MessageIds = 'noUseBeforeDefine';
export default util.createRule<Options, MessageIds>({
name: 'no-use-before-define',
meta: {
type: 'problem',
docs: {
description: 'Disallow the use of variables before they are defined',
category: 'Variables',
recommended: 'error',
},
messages: {
noUseBeforeDefine: "'{{name}}' was used before it was defined.",
},
schema: [
{
oneOf: [
{
enum: ['nofunc'],
},
{
type: 'object',
properties: {
functions: { type: 'boolean' },
classes: { type: 'boolean' },
variables: { type: 'boolean' },
typedefs: { type: 'boolean' },
},
additionalProperties: false,
},
],
},
],
},
defaultOptions: [
{
functions: true,
classes: true,
variables: true,
typedefs: true,
},
],
create(context, optionsWithDefault) {
const options = parseOptions(optionsWithDefault[0]);
/**
* Determines whether a given use-before-define case should be reported according to the options.
* @param variable The variable that gets used before being defined
* @param reference The reference to the variable
*/
function isForbidden(
variable: TSESLint.Scope.Variable,
reference: TSESLint.Scope.Reference,
): boolean {
if (isFunction(variable)) {
return !!options.functions;
}
if (isOuterClass(variable, reference)) {
return !!options.classes;
}
if (isOuterVariable(variable, reference)) {
return !!options.variables;
}
return true;
}
/**
* Finds and validates all variables in a given scope.
*/
function findVariablesInScope(scope: TSESLint.Scope.Scope): void {
scope.references.forEach(reference => {
const variable = reference.resolved;
// Skips when the reference is:
// - initialization's.
// - referring to an undefined variable.
// - referring to a global environment variable (there're no identifiers).
// - located preceded by the variable (except in initializers).
// - allowed by options.
if (
reference.init ||
!variable ||
variable.identifiers.length === 0 ||
(variable.identifiers[0].range[1] < reference.identifier.range[1] &&
!isInInitializer(variable, reference)) ||
!isForbidden(variable, reference)
) {
return;
}
// Reports.
context.report({
node: reference.identifier,
messageId: 'noUseBeforeDefine',
data: reference.identifier,
});
});
scope.childScopes.forEach(findVariablesInScope);
}
return {
Program() {
findVariablesInScope(context.getScope());
},
};
},
});