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
|
/**
* @fileoverview We shouldn't use global built-in object for security and
* performance reason. This linter rule reports replaceable codes
* that can be replaced with primordials.
* @author Leko <leko.noor@gmail.com>
*/
'use strict';
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
function toPrimordialsName(obj, prop) {
return obj + toUcFirst(prop);
}
function toUcFirst(str) {
return str[0].toUpperCase() + str.slice(1);
}
function isTarget(map, varName) {
return map.has(varName);
}
function isIgnored(map, varName, propName) {
return map.get(varName)?.get(propName)?.ignored ?? false;
}
function getReportName({ name, parentName, into }) {
if (into) {
return toPrimordialsName(into, name);
}
if (parentName) {
return toPrimordialsName(parentName, name);
}
return name;
}
/**
* Get identifier of object spread assignment
*
* code: 'const { ownKeys } = Reflect;'
* argument: 'ownKeys'
* return: 'Reflect'
*/
function getDestructuringAssignmentParent(scope, node) {
const declaration = scope.set.get(node.name);
if (
!declaration ||
!declaration.defs ||
declaration.defs.length === 0 ||
declaration.defs[0].type !== 'Variable' ||
!declaration.defs[0].node.init
) {
return null;
}
return declaration.defs[0].node.init;
}
const parentSelectors = [
// We want to select identifiers that refer to other references, not the ones
// that create a new reference.
'ClassDeclaration',
'FunctionDeclaration',
'LabeledStatement',
'MemberExpression',
'MethodDefinition',
'SwitchCase',
'VariableDeclarator',
];
const identifierSelector = parentSelectors.map((selector) => `[type!=${selector}]`).join('') + '>Identifier';
module.exports = {
meta: {
messages: {
error: 'Use `const { {{name}} } = primordials;` instead of the global.',
},
},
create(context) {
const globalScope = context.getSourceCode().scopeManager.globalScope;
const nameMap = new Map();
const renameMap = new Map();
for (const option of context.options) {
const names = option.ignore || [];
nameMap.set(
option.name,
new Map(names.map((name) => [name, { ignored: true }])),
);
if (option.into) {
renameMap.set(option.name, option.into);
}
}
let reported;
return {
Program() {
reported = new Set();
},
[identifierSelector](node) {
if (node.parent.type === 'Property' && node.parent.key === node) {
// If the identifier is the key for this property declaration, it
// can't be referring to a primordials member.
return;
}
if (reported.has(node.range[0])) {
return;
}
const name = node.name;
const parent = getDestructuringAssignmentParent(
context.getScope(),
node,
);
const parentName = parent?.name;
if (!isTarget(nameMap, name) && (!isTarget(nameMap, parentName) || isIgnored(nameMap, parentName, name))) {
return;
}
const defs = globalScope.set.get(name)?.defs;
if (parentName && isTarget(nameMap, parentName)) {
if (defs?.[0].name.name !== 'primordials' &&
!reported.has(parent.range[0]) &&
parent.parent?.id?.type !== 'Identifier') {
reported.add(node.range[0]);
const into = renameMap.get(name);
context.report({
node,
messageId: 'error',
data: {
name: getReportName({ into, parentName, name }),
},
});
}
return;
}
if (defs.length === 0 || defs[0].node.init.name !== 'primordials') {
reported.add(node.range[0]);
const into = renameMap.get(name);
context.report({
node,
messageId: 'error',
data: {
name: getReportName({ into, parentName, name }),
},
});
}
},
MemberExpression(node) {
const obj = node.object.name;
const prop = node.property.name;
if (!prop || !isTarget(nameMap, obj) || isIgnored(nameMap, obj, prop)) {
return;
}
const variables =
context.getSourceCode().scopeManager.getDeclaredVariables(node);
if (variables.length === 0) {
context.report({
node,
messageId: 'error',
data: {
name: toPrimordialsName(obj, prop),
},
});
}
},
VariableDeclarator(node) {
const name = node.init?.name;
if (name !== undefined && isTarget(nameMap, name) &&
node.id.type === 'Identifier' &&
!globalScope.set.get(name)?.defs.length) {
reported.add(node.init.range[0]);
context.report({
node,
messageId: 'error',
data: { name },
});
}
},
};
},
};
|
