no-unsafe-assignment.js
12.6 KB
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
258
259
260
261
262
263
264
265
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
const util = __importStar(require("../util"));
exports.default = util.createRule({
name: 'no-unsafe-assignment',
meta: {
type: 'problem',
docs: {
description: 'Disallows assigning any to variables and properties',
category: 'Possible Errors',
recommended: 'error',
requiresTypeChecking: true,
},
messages: {
anyAssignment: 'Unsafe assignment of an any value.',
unsafeArrayPattern: 'Unsafe array destructuring of an any array value.',
unsafeArrayPatternFromTuple: 'Unsafe array destructuring of a tuple element with an any value.',
unsafeAssignment: 'Unsafe assignment of type {{sender}} to a variable of type {{receiver}}.',
unsafeArraySpread: 'Unsafe spread of an any value in an array.',
},
schema: [],
},
defaultOptions: [],
create(context) {
const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context);
const checker = program.getTypeChecker();
// returns true if the assignment reported
function checkArrayDestructureHelper(receiverNode, senderNode) {
if (receiverNode.type !== experimental_utils_1.AST_NODE_TYPES.ArrayPattern) {
return false;
}
const senderTsNode = esTreeNodeToTSNodeMap.get(senderNode);
const senderType = checker.getTypeAtLocation(senderTsNode);
return checkArrayDestructure(receiverNode, senderType, senderTsNode);
}
// returns true if the assignment reported
function checkArrayDestructure(receiverNode, senderType, senderNode) {
// any array
// const [x] = ([] as any[]);
if (util.isTypeAnyArrayType(senderType, checker)) {
context.report({
node: receiverNode,
messageId: 'unsafeArrayPattern',
});
return false;
}
if (!checker.isTupleType(senderType)) {
return true;
}
const tupleElements = util.getTypeArguments(senderType, checker);
// tuple with any
// const [x] = [1 as any];
let didReport = false;
for (let receiverIndex = 0; receiverIndex < receiverNode.elements.length; receiverIndex += 1) {
const receiverElement = receiverNode.elements[receiverIndex];
if (!receiverElement) {
continue;
}
if (receiverElement.type === experimental_utils_1.AST_NODE_TYPES.RestElement) {
// don't handle rests as they're not a 1:1 assignment
continue;
}
const senderType = tupleElements[receiverIndex];
if (!senderType) {
continue;
}
// check for the any type first so we can handle [[[x]]] = [any]
if (util.isTypeAnyType(senderType)) {
context.report({
node: receiverElement,
messageId: 'unsafeArrayPatternFromTuple',
});
// we want to report on every invalid element in the tuple
didReport = true;
}
else if (receiverElement.type === experimental_utils_1.AST_NODE_TYPES.ArrayPattern) {
didReport = checkArrayDestructure(receiverElement, senderType, senderNode);
}
else if (receiverElement.type === experimental_utils_1.AST_NODE_TYPES.ObjectPattern) {
didReport = checkObjectDestructure(receiverElement, senderType, senderNode);
}
}
return didReport;
}
// returns true if the assignment reported
function checkObjectDestructureHelper(receiverNode, senderNode) {
if (receiverNode.type !== experimental_utils_1.AST_NODE_TYPES.ObjectPattern) {
return false;
}
const senderTsNode = esTreeNodeToTSNodeMap.get(senderNode);
const senderType = checker.getTypeAtLocation(senderTsNode);
return checkObjectDestructure(receiverNode, senderType, senderTsNode);
}
// returns true if the assignment reported
function checkObjectDestructure(receiverNode, senderType, senderNode) {
const properties = new Map(senderType
.getProperties()
.map(property => [
property.getName(),
checker.getTypeOfSymbolAtLocation(property, senderNode),
]));
let didReport = false;
for (let receiverIndex = 0; receiverIndex < receiverNode.properties.length; receiverIndex += 1) {
const receiverProperty = receiverNode.properties[receiverIndex];
if (receiverProperty.type === experimental_utils_1.AST_NODE_TYPES.RestElement) {
// don't bother checking rest
continue;
}
let key;
if (receiverProperty.computed === false) {
key =
receiverProperty.key.type === experimental_utils_1.AST_NODE_TYPES.Identifier
? receiverProperty.key.name
: String(receiverProperty.key.value);
}
else if (receiverProperty.key.type === experimental_utils_1.AST_NODE_TYPES.Literal) {
key = String(receiverProperty.key.value);
}
else if (receiverProperty.key.type === experimental_utils_1.AST_NODE_TYPES.TemplateLiteral &&
receiverProperty.key.quasis.length === 1) {
key = String(receiverProperty.key.quasis[0].value.cooked);
}
else {
// can't figure out the name, so skip it
continue;
}
const senderType = properties.get(key);
if (!senderType) {
continue;
}
// check for the any type first so we can handle {x: {y: z}} = {x: any}
if (util.isTypeAnyType(senderType)) {
context.report({
node: receiverProperty.value,
messageId: 'unsafeArrayPatternFromTuple',
});
didReport = true;
}
else if (receiverProperty.value.type === experimental_utils_1.AST_NODE_TYPES.ArrayPattern) {
didReport = checkArrayDestructure(receiverProperty.value, senderType, senderNode);
}
else if (receiverProperty.value.type === experimental_utils_1.AST_NODE_TYPES.ObjectPattern) {
didReport = checkObjectDestructure(receiverProperty.value, senderType, senderNode);
}
}
return didReport;
}
// returns true if the assignment reported
function checkAssignment(receiverNode, senderNode, reportingNode, comparisonType) {
var _a;
const receiverTsNode = esTreeNodeToTSNodeMap.get(receiverNode);
const receiverType = comparisonType === 2 /* Contextual */
? (_a = util.getContextualType(checker, receiverTsNode)) !== null && _a !== void 0 ? _a : checker.getTypeAtLocation(receiverTsNode) : checker.getTypeAtLocation(receiverTsNode);
const senderType = checker.getTypeAtLocation(esTreeNodeToTSNodeMap.get(senderNode));
if (util.isTypeAnyType(senderType)) {
// handle cases when we assign any ==> unknown.
if (util.isTypeUnknownType(receiverType)) {
return false;
}
context.report({
node: reportingNode,
messageId: 'anyAssignment',
});
return true;
}
if (comparisonType === 0 /* None */) {
return false;
}
const result = util.isUnsafeAssignment(senderType, receiverType, checker);
if (!result) {
return false;
}
const { sender, receiver } = result;
context.report({
node: reportingNode,
messageId: 'unsafeAssignment',
data: {
sender: checker.typeToString(sender),
receiver: checker.typeToString(receiver),
},
});
return true;
}
function getComparisonType(typeAnnotation) {
return typeAnnotation
? // if there's a type annotation, we can do a comparison
1 /* Basic */
: // no type annotation means the variable's type will just be inferred, thus equal
0 /* None */;
}
return {
'VariableDeclarator[init != null]'(node) {
const init = util.nullThrows(node.init, util.NullThrowsReasons.MissingToken(node.type, 'init'));
let didReport = checkAssignment(node.id, init, node, getComparisonType(node.id.typeAnnotation));
if (!didReport) {
didReport = checkArrayDestructureHelper(node.id, init);
}
if (!didReport) {
checkObjectDestructureHelper(node.id, init);
}
},
'ClassProperty[value != null]'(node) {
checkAssignment(node.key, node.value, node, getComparisonType(node.typeAnnotation));
},
'AssignmentExpression[operator = "="], AssignmentPattern'(node) {
let didReport = checkAssignment(node.left, node.right, node, 1 /* Basic */);
if (!didReport) {
didReport = checkArrayDestructureHelper(node.left, node.right);
}
if (!didReport) {
checkObjectDestructureHelper(node.left, node.right);
}
},
// object pattern props are checked via assignments
':not(ObjectPattern) > Property'(node) {
if (node.value.type === experimental_utils_1.AST_NODE_TYPES.AssignmentPattern ||
node.value.type === experimental_utils_1.AST_NODE_TYPES.TSEmptyBodyFunctionExpression) {
// handled by other selector
return;
}
checkAssignment(node.key, node.value, node, 2 /* Contextual */);
},
'ArrayExpression > SpreadElement'(node) {
const resetNode = esTreeNodeToTSNodeMap.get(node.argument);
const restType = checker.getTypeAtLocation(resetNode);
if (util.isTypeAnyType(restType) ||
util.isTypeAnyArrayType(restType, checker)) {
context.report({
node: node,
messageId: 'unsafeArraySpread',
});
}
},
'JSXAttribute[value != null]'(node) {
const value = util.nullThrows(node.value, util.NullThrowsReasons.MissingToken(node.type, 'value'));
if (value.type !== experimental_utils_1.AST_NODE_TYPES.JSXExpressionContainer ||
value.expression.type === experimental_utils_1.AST_NODE_TYPES.JSXEmptyExpression) {
return;
}
checkAssignment(node.name, value.expression, value.expression, 2 /* Contextual */);
},
};
},
});
//# sourceMappingURL=no-unsafe-assignment.js.map