-
-
Notifications
You must be signed in to change notification settings - Fork 394
/
no_import_assign.rs
263 lines (245 loc) · 13.4 KB
/
no_import_assign.rs
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
use oxc_ast::{ast::Expression, AstKind};
use oxc_diagnostics::{
miette::{self, Diagnostic},
thiserror::Error,
};
use oxc_macros::declare_oxc_lint;
use oxc_semantic::{AstNodeId, SymbolId};
use oxc_span::{GetSpan, Span};
use oxc_syntax::operator::UnaryOperator;
use phf::phf_set;
use crate::{context::LintContext, rule::Rule};
#[derive(Debug, Error, Diagnostic)]
#[error("eslint(no-import-assign): do not assign to imported bindings")]
#[diagnostic(severity(warning), help("imported bindings are readonly"))]
struct NoImportAssignDiagnostic(#[label] pub Span);
#[derive(Debug, Default, Clone)]
pub struct NoImportAssign;
declare_oxc_lint!(
/// ### What it does
///
/// Disallow assigning to imported bindings
///
/// ### Why is this bad?
///
/// The updates of imported bindings by ES Modules cause runtime errors.
///
///
/// ### Example
/// ```javascript
/// import mod, { named } from "./mod.mjs"
/// import * as mod_ns from "./mod.mjs"
///
/// mod = 1 // ERROR: 'mod' is readonly.
/// named = 2 // ERROR: 'named' is readonly.
/// mod_ns.named = 3 // ERROR: The members of 'mod_ns' are readonly.
/// mod_ns = {} // ERROR: 'mod_ns' is readonly.
/// // Can't extend 'mod_ns'
/// Object.assign(mod_ns, { foo: "foo" }) // ERROR: The members of 'mod_ns' are readonly.
/// ```
NoImportAssign,
nursery
);
const OBJECT_MUTATION_METHODS: phf::Set<&'static str> =
phf_set!("assign", "defineProperty", "defineProperties", "freeze", "setPrototypeOf");
const REFLECT_MUTATION_METHODS: phf::Set<&'static str> =
phf_set!("defineProperty", "deleteProperty", "set", "setPrototypeOf");
impl Rule for NoImportAssign {
fn run_on_symbol(&self, symbol_id: SymbolId, ctx: &LintContext<'_>) {
let symbol_table = ctx.semantic().symbols();
if symbol_table.get_flag(symbol_id).is_import_binding() {
let kind = ctx.nodes().kind(symbol_table.get_declaration(symbol_id));
let is_namespace_specifier = matches!(kind, AstKind::ImportNamespaceSpecifier(_));
for reference in symbol_table.get_resolved_references(symbol_id) {
if is_namespace_specifier {
let Some(parent_node) = ctx.nodes().parent_node(reference.node_id()) else {
return;
};
if let AstKind::MemberExpression(expr) = parent_node.kind() {
let Some(parent_parent_node) = ctx.nodes().parent_node(parent_node.id())
else {
return;
};
let is_unary_expression_with_delete_operator = |kind| matches!(kind, AstKind::UnaryExpression(expr) if expr.operator == UnaryOperator::Delete);
let parent_parent_kind = parent_parent_node.kind();
if matches!(parent_parent_kind, AstKind::SimpleAssignmentTarget(_))
// delete namespace.module
|| is_unary_expression_with_delete_operator(parent_parent_kind)
// delete namespace?.module
|| matches!(parent_parent_kind, AstKind::ChainExpression(_) if ctx.nodes().parent_kind(parent_parent_node.id()).is_some_and(is_unary_expression_with_delete_operator))
{
if let Some((span, _)) = expr.static_property_info() {
if span != reference.span() {
return ctx.diagnostic(NoImportAssignDiagnostic(expr.span()));
}
}
}
}
}
if reference.is_write()
|| (is_namespace_specifier
&& is_argument_of_well_known_mutation_function(reference.node_id(), ctx))
{
ctx.diagnostic(NoImportAssignDiagnostic(reference.span()));
}
}
}
}
}
/// Check if a given node is at the first argument of a well-known mutation function.
/// - `Object.assign`
/// - `Object.defineProperty`
/// - `Object.defineProperties`
/// - `Object.freeze`
/// - `Object.setPrototypeOf`
/// - `Reflect.defineProperty`
/// - `Reflect.deleteProperty`
/// - `Reflect.set`
/// - `Reflect.setPrototypeOf`
fn is_argument_of_well_known_mutation_function(node_id: AstNodeId, ctx: &LintContext<'_>) -> bool {
let current_node = ctx.nodes().get_node(node_id);
let call_expression_node =
ctx.nodes().parent_node(node_id).and_then(|node| ctx.nodes().parent_kind(node.id()));
let Some(AstKind::CallExpression(expr)) = call_expression_node else { return false };
let Some(member_expr) = &expr.callee.get_member_expr() else { return false };
if let Expression::Identifier(ident) = member_expr.object() {
let Some(property_name) = member_expr.static_property_name() else {
return false;
};
if ((ident.name == "Object" && OBJECT_MUTATION_METHODS.contains(property_name))
|| (ident.name == "Reflect" && REFLECT_MUTATION_METHODS.contains(property_name)))
&& !ctx.scopes().has_binding(current_node.scope_id(), &ident.name)
{
return expr
.arguments
.first()
.is_some_and(|argument| argument.span() == current_node.kind().span());
}
}
false
}
#[test]
fn test() {
use crate::tester::Tester;
let pass = vec![
("import mod from 'mod'; mod.prop = 0", None),
("import mod from 'mod'; mod.prop += 0", None),
("import mod from 'mod'; mod.prop++", None),
("import mod from 'mod'; delete mod.prop", None),
("import mod from 'mod'; for (mod.prop in foo);", None),
("import mod from 'mod'; for (mod.prop of foo);", None),
("import mod from 'mod'; [mod.prop] = foo;", None),
("import mod from 'mod'; [...mod.prop] = foo;", None),
("import mod from 'mod'; ({ bar: mod.prop } = foo);", None),
("import mod from 'mod'; ({ ...mod.prop } = foo);", None),
("import {named} from 'mod'; named.prop = 0", None),
("import {named} from 'mod'; named.prop += 0", None),
("import {named} from 'mod'; named.prop++", None),
("import {named} from 'mod'; delete named.prop", None),
("import {named} from 'mod'; for (named.prop in foo);", None),
("import {named} from 'mod'; for (named.prop of foo);", None),
("import {named} from 'mod'; [named.prop] = foo;", None),
("import {named} from 'mod'; [...named.prop] = foo;", None),
("import {named} from 'mod'; ({ bar: named.prop } = foo);", None),
("import {named} from 'mod'; ({ ...named.prop } = foo);", None),
("import * as mod from 'mod'; mod.named.prop = 0", None),
("import * as mod from 'mod'; mod.named.prop += 0", None),
("import * as mod from 'mod'; mod.named.prop++", None),
("import * as mod from 'mod'; delete mod.named.prop", None),
("import * as mod from 'mod'; for (mod.named.prop in foo);", None),
("import * as mod from 'mod'; for (mod.named.prop of foo);", None),
("import * as mod from 'mod'; [mod.named.prop] = foo;", None),
("import * as mod from 'mod'; [...mod.named.prop] = foo;", None),
("import * as mod from 'mod'; ({ bar: mod.named.prop } = foo);", None),
("import * as mod from 'mod'; ({ ...mod.named.prop } = foo);", None),
("import * as mod from 'mod'; obj[mod] = 0", None),
("import * as mod from 'mod'; obj[mod.named] = 0", None),
("import * as mod from 'mod'; for (var foo in mod.named);", None),
("import * as mod from 'mod'; for (var foo of mod.named);", None),
("import * as mod from 'mod'; [bar = mod.named] = foo;", None),
("import * as mod from 'mod'; ({ bar = mod.named } = foo);", None),
("import * as mod from 'mod'; ({ bar: baz = mod.named } = foo);", None),
("import * as mod from 'mod'; ({ [mod.named]: bar } = foo);", None),
("import * as mod from 'mod'; var obj = { ...mod.named };", None),
("import * as mod from 'mod'; var obj = { foo: mod.named };", None),
("import mod from 'mod'; { let mod = 0; mod = 1 }", None),
("import * as mod from 'mod'; { let mod = 0; mod = 1 }", None),
("import * as mod from 'mod'; { let mod = 0; mod.named = 1 }", None),
("import {} from 'mod'", None),
("import 'mod'", None),
("import mod from 'mod'; Object.assign(mod, obj);", None),
("import {named} from 'mod'; Object.assign(named, obj);", None),
("import * as mod from 'mod'; Object.assign(mod.prop, obj);", None),
("import * as mod from 'mod'; Object.assign(obj, mod, other);", None),
("import * as mod from 'mod'; Object[assign](mod, obj);", None),
("import * as mod from 'mod'; Object.getPrototypeOf(mod);", None),
("import * as mod from 'mod'; Reflect.set(obj, key, mod);", None),
("import * as mod from 'mod'; { var Object; Object.assign(mod, obj); }", None),
("import * as mod from 'mod'; var Object; Object.assign(mod, obj);", None),
("import * as mod from 'mod'; Object.seal(mod, obj)", None),
("import * as mod from 'mod'; Object.preventExtensions(mod)", None),
("import * as mod from 'mod'; Reflect.preventExtensions(mod)", None),
];
let fail = vec![
("import mod1 from 'mod'; mod1 = 0", None),
("import mod2 from 'mod'; mod2 += 0", None),
("import mod3 from 'mod'; mod3++", None),
("import mod4 from 'mod'; for (mod4 in foo);", None),
("import mod5 from 'mod'; for (mod5 of foo);", None),
("import mod6 from 'mod'; [mod6] = foo", None),
("import mod7 from 'mod'; [mod7 = 0] = foo", None),
("import mod8 from 'mod'; [...mod8] = foo", None),
("import mod9 from 'mod'; ({ bar: mod9 } = foo)", None),
("import mod10 from 'mod'; ({ bar: mod10 = 0 } = foo)", None),
("import mod11 from 'mod'; ({ ...mod11 } = foo)", None),
("import {named1} from 'mod'; named1 = 0", None),
("import {named2} from 'mod'; named2 += 0", None),
("import {named3} from 'mod'; named3++", None),
("import {named4} from 'mod'; for (named4 in foo);", None),
("import {named5} from 'mod'; for (named5 of foo);", None),
("import {named6} from 'mod'; [named6] = foo", None),
("import {named7} from 'mod'; [named7 = 0] = foo", None),
("import {named8} from 'mod'; [...named8] = foo", None),
("import {named9} from 'mod'; ({ bar: named9 } = foo)", None),
("import {named10} from 'mod'; ({ bar: named10 = 0 } = foo)", None),
("import {named11} from 'mod'; ({ ...named11 } = foo)", None),
("import {named12 as foo} from 'mod'; foo = 0; named12 = 0", None),
("import * as mod1 from 'mod'; mod1 = 0", None),
("import * as mod2 from 'mod'; mod2 += 0", None),
("import * as mod3 from 'mod'; mod3++", None),
("import * as mod4 from 'mod'; for (mod4 in foo);", None),
("import * as mod5 from 'mod'; for (mod5 of foo);", None),
("import * as mod6 from 'mod'; [mod6] = foo", None),
("import * as mod7 from 'mod'; [mod7 = 0] = foo", None),
("import * as mod8 from 'mod'; [...mod8] = foo", None),
("import * as mod9 from 'mod'; ({ bar: mod9 } = foo)", None),
("import * as mod10 from 'mod'; ({ bar: mod10 = 0 } = foo)", None),
("import * as mod11 from 'mod'; ({ ...mod11 } = foo)", None),
("import * as mod1 from 'mod'; mod1.named = 0", None),
("import * as mod2 from 'mod'; mod2.named += 0", None),
("import * as mod3 from 'mod'; mod3.named++", None),
("import * as mod4 from 'mod'; for (mod4.named in foo);", None),
("import * as mod5 from 'mod'; for (mod5.named of foo);", None),
("import * as mod6 from 'mod'; [mod6.named] = foo", None),
("import * as mod7 from 'mod'; [mod7.named = 0] = foo", None),
("import * as mod8 from 'mod'; [...mod8.named] = foo", None),
("import * as mod9 from 'mod'; ({ bar: mod9.named } = foo)", None),
("import * as mod10 from 'mod'; ({ bar: mod10.named = 0 } = foo)", None),
("import * as mod11 from 'mod'; ({ ...mod11.named } = foo)", None),
("import * as mod12 from 'mod'; delete mod12.named", None),
("import * as mod from 'mod'; Object.assign(mod, obj)", None),
("import * as mod from 'mod'; Object.defineProperty(mod, key, d)", None),
("import * as mod from 'mod'; Object.defineProperties(mod, d)", None),
("import * as mod from 'mod'; Object.setPrototypeOf(mod, proto)", None),
("import * as mod from 'mod'; Object.freeze(mod)", None),
("import * as mod from 'mod'; Reflect.defineProperty(mod, key, d)", None),
("import * as mod from 'mod'; Reflect.deleteProperty(mod, key)", None),
("import * as mod from 'mod'; Reflect.set(mod, key, value)", None),
("import * as mod from 'mod'; Reflect.setPrototypeOf(mod, proto)", None),
("import mod, * as mod_ns from 'mod'; mod.prop = 0; mod_ns.prop = 0", None),
("import * as mod from 'mod'; Object?.defineProperty(mod, key, d)", None),
("import * as mod from 'mod'; (Object?.defineProperty)(mod, key, d)", None),
("import * as mod from 'mod'; delete mod?.prop", None),
];
Tester::new(NoImportAssign::NAME, pass, fail).test_and_snapshot();
}