no-restricted-globals

禁止指定全局变量

禁止使用特定全局变量可能很有用，如果您希望通过启用环境来允许一组全局变量，但仍希望禁止其中一些。

例如，早期的 Internet Explorer 版本将当前 DOM 事件公开为全局变量 event，但使用此变量长期以来一直被视为不良做法。限制这一点将确保此变量不会在浏览器代码中使用。

规则详细信息

此规则允许您指定不想在应用程序中使用的全局变量名称。

选项

此规则接受字符串列表，其中每个字符串都是要限制的全局变量。

{
    "rules": {
        "no-restricted-globals": ["error", "event", "fdescribe"]
    }
}
1
2
3
4
5

或者，该规则还接受对象，其中指定了全局变量名称和可选的自定义消息。

{
    "rules": {
        "no-restricted-globals": [
            "error",
            {
                "name": "event",
                "message": "Use local parameter instead."
            },
            {
                "name": "fdescribe",
                "message": "Do not commit fdescribe. Use describe instead."
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

针对示例 "event", "fdescribe" 全局变量名称的不正确代码示例

/*global event, fdescribe*/
/*eslint no-restricted-globals: ["error", "event", "fdescribe"]*/

function onClick() {
    console.log(event);
}

fdescribe("foo", function() {
});
1
2
3
4
5
6
7
8
9

针对示例 "event" 全局变量名称的正确代码示例

/*global event*/
/*eslint no-restricted-globals: ["error", "event"]*/

import event from "event-module";
1
2
3
4

/*global event*/
/*eslint no-restricted-globals: ["error", "event"]*/

var event = 1;
1
2
3
4

针对示例 "event" 全局变量名称的不正确代码示例，以及自定义错误消息

/*global event*/
/* eslint no-restricted-globals: ["error", { name: "event", message: "Use local parameter instead." }] */

function onClick() {
    console.log(event);    // Unexpected global variable 'event'. Use local parameter instead.
}
1
2
3
4
5
6

相关规则

• no-restricted-properties
• no-restricted-syntax

版本

此规则是在 ESLint v2.3.0 中引入的。

资源

• 规则来源
• 测试来源