pve-eslint/eslint/docs/rules/no-import-assign.md
Dominik Csapak eb39fafa4f first commit
includes a (minimal) working wrapper

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-04-06 15:06:03 +02:00

45 lines
1.1 KiB
Markdown

# disallow assigning to imported bindings (no-import-assign)
The updates of imported bindings by ES Modules cause runtime errors.
## Rule Details
This rule warns the assignments, increments, and decrements of imported bindings.
Examples of **incorrect** code for this rule:
```js
/*eslint no-import-assign: "error"*/
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' is readonly.
mod_ns = {} // ERROR: 'mod_ns' is readonly.
```
Examples of **correct** code for this rule:
```js
/*eslint no-import-assign: "error"*/
import mod, { named } from "./mod.mjs"
import * as mod_ns from "./mod.mjs"
mod.prop = 1
named.prop = 2
mod_ns.named.prop = 3
// Known Limitation
function test(obj) {
obj.named = 4 // Not errored because 'obj' is not namespace objects.
}
test(mod_ns) // Not errored because it doesn't know that 'test' updates the member of the argument.
```
## When Not To Use It
If you don't want to be notified about modifying imported bindings, you can disable this rule.