no-shadow-restricted-names

禁止标识符隐藏受限名称

ES2020 §18.1 全局对象的值属性（globalThis、NaN、Infinity、undefined）以及严格模式限制的标识符 eval 和 arguments 在 JavaScript 中被视为受限制的名称。将它们定义为其他含义可能会产生意想不到的后果，并让阅读代码的其他人感到困惑。例如，没有任何东西能阻止你写成这样：

🌐 ES2020 §18.1 Value Properties of the Global Object (globalThis, NaN, Infinity, undefined) as well as strict mode restricted identifiers eval and arguments are considered to be restricted names in JavaScript. Defining them to mean something else can have unintended consequences and confuse others reading the code. For example, there’s nothing preventing you from writing:

const undefined = "foo";
1

那么在同一作用域内使用的任何代码都不会获得全局的 undefined，而是会获得意义完全不同的本地版本。

🌐 Then any code used within the same scope would not get the global undefined, but rather the local version with a very different meaning.

规则详情

🌐 Rule Details

此规则的错误代码示例：

🌐 Examples of incorrect code for this rule:

/*eslint no-shadow-restricted-names: "error"*/

function NaN(){}

!function(Infinity){};

const undefined = 5;

try {} catch(eval){}
1
2
3
4
5
6
7
8
9

/*eslint no-shadow-restricted-names: "error"*/

import NaN from "foo";

import { undefined } from "bar";

class Infinity {}
1
2
3
4
5
6
7

符合此规则的正确代码示例：

🌐 Examples of correct code for this rule:

/*eslint no-shadow-restricted-names: "error"*/

let Object;

function f(a, b){}

// Exception: `undefined` may be shadowed if the variable is never assigned a value.
let undefined;
1
2
3
4
5
6
7
8

/*eslint no-shadow-restricted-names: "error"*/

import { undefined as undef } from "bar";
1
2
3

选项

🌐 Options

此规则有一个对象选项：

🌐 This rule has an object option:

• "reportGlobalThis"：true（默认）报告 globalThis 的声明。

reportGlobalThis

默认 { "reportGlobalThis": true } 选项的错误代码示例：

🌐 Examples of incorrect code for the default { "reportGlobalThis": true } option:

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": true }]*/

const globalThis = "foo";
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": true }]*/

function globalThis() {}
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": true }]*/

import { globalThis } from "bar";
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": true }]*/

class globalThis {}
1
2
3

默认 { "reportGlobalThis": true } 选项的正确代码示例：

🌐 Examples of correct code for the default { "reportGlobalThis": true } option:

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": true }]*/

const foo = globalThis;

function bar() {
    return globalThis;
}

import { globalThis as baz } from "foo";
1
2
3
4
5
6
7
8
9

适用于 { "reportGlobalThis": false } 选项的正确代码示例：

🌐 Examples of correct code for the { "reportGlobalThis": false } option:

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": false }]*/

const globalThis = "foo";
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": false }]*/

function globalThis() {}
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": false }]*/

import { globalThis } from "bar";
1
2
3

/*eslint no-shadow-restricted-names: ["error", { "reportGlobalThis": false }]*/

class globalThis {}
1
2
3

相关规则

• no-shadow

版本

此规则是在 ESLint v0.1.4 中引入。

进阶读物

ECMAScript® 2020 Language Specification
262.ecma-international.org

ECMAScript® 2020 Language Specification
262.ecma-international.org

资源

• 规则源码
• 测试源码