no-restricted-properties

禁止在某些对象上使用某些属性

在代码库中，某些对象上的某些属性可能会被禁止。这对于弃用 API 或限制模块方法的使用非常有用。例如，您可能希望在使用 Mocha 时禁止使用 describe.only，或者告诉人们使用 Object.assign 而不是 _.extend。

规则详情

此规则查找在读取属性值或将其作为函数调用时，在给定对象名称上访问给定属性键的情况。您可以指定一个可选消息来指示替代 API 或限制的原因。此规则适用于通过点表示法和解构访问的属性。

选项

此规则获取一个对象列表，其中指定了对象名称和属性名称。

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "disallowedObjectName",
            "property": "disallowedPropertyName"
        }]
    }
}
1
2
3
4
5
6
7
8

可以禁止多个对象/属性值，并且您可以指定一个可选消息。

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "disallowedObjectName",
            "property": "disallowedPropertyName"
        }, {
            "object": "disallowedObjectName",
            "property": "anotherDisallowedPropertyName",
            "message": "Please use allowedObjectName.allowedPropertyName."
        }]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

如果省略对象名称，则对所有对象禁止该属性。

{
    "rules": {
        "no-restricted-properties": [2, {
            "property": "__defineGetter__",
            "message": "Please use Object.defineProperty instead."
        }]
    }
}
1
2
3
4
5
6
7
8

如果省略属性名称，则禁止访问给定对象的任何属性。

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "require",
            "message": "Please call require() directly."
        }]
    }
}
1
2
3
4
5
6
7
8

此规则的错误代码示例

/* eslint no-restricted-properties: [2, {
    "object": "disallowedObjectName",
    "property": "disallowedPropertyName"
}] */

var example = disallowedObjectName.disallowedPropertyName; /*error Disallowed object property: disallowedObjectName.disallowedPropertyName.*/

disallowedObjectName.disallowedPropertyName(); /*error Disallowed object property: disallowedObjectName.disallowedPropertyName.*/
1
2
3
4
5
6
7
8

/* eslint no-restricted-properties: [2, {
    "property": "__defineGetter__"
}] */

foo.__defineGetter__(bar, baz);

const { __defineGetter__ } = qux();

({ __defineGetter__ }) => {};
1
2
3
4
5
6
7
8
9

/* eslint no-restricted-properties: [2, {
    "object": "require"
}] */

require.resolve('foo');
1
2
3
4
5

此规则的正确代码示例

/* eslint no-restricted-properties: [2, {
    "object": "disallowedObjectName",
    "property": "disallowedPropertyName"
}] */

var example = disallowedObjectName.somePropertyName;

allowedObjectName.disallowedPropertyName();
1
2
3
4
5
6
7
8

/* eslint no-restricted-properties: [2, {
    "object": "require"
}] */

require('foo');
1
2
3
4
5

何时不使用它

如果您没有任何要限制的对象/属性组合，则不应使用此规则。

相关规则

• no-restricted-globals
• no-restricted-syntax

版本

此规则在 ESLint v3.5.0 中引入。

资源

• 规则源代码
• 测试源代码