在线文档教程
Eslint
规则 | Rules

id-blacklist

disallow specified identifiers (id-blacklist)

“计算机科学只有两件难事:缓存失效和命名事情。” - Phil Karlton

错误的名字会导致难以破译的代码。通用名称,例如data,不会推断代码和它接收的值。此规则允许您配置不想在代码中看到的错误标识符名称的黑名单。

规则细节

此规则不允许在分配和function定义中指定标识符。

该规则将捕获列入黑名单的标识符:

  • 变量声明

  • 函数声明

  • 在创建对象期间分配给对象的属性

它不会捕获列入黑名单的标识符:

  • 函数调用(所以你仍然可以使用你没有控制权的函数)

  • 对象属性(所以你仍然可以使用你没有控制权的对象)

选项

该规则将一个或多个字符串作为选项:限制标识符的名称。

例如,要限制使用通用通用标识符:

{ "id-blacklist": ["error", "data", "err", "e", "cb", "callback"] }

带有样本限制标识符的此规则的不正确代码示例"data", "callback"

/*eslint id-blacklist: ["error", "data", "callback"] */ var data = {...}; function callback() { // ... } element.callback = function() { // ... }; var itemSet = { data: [...] };

带有样本限制标识符的此规则的正确代码示例"data", "callback"

/*eslint id-blacklist: ["error", "data", "callback"] */ var encodingOptions = {...}; function processFileResult() { // ... } element.successHandler = function() { // ... }; var itemSet = { entities: [...] }; callback( // all function calls are ignored foo.callback( // all function calls are ignored foo.data; // all property names that are not assignments are ignored

何时不使用它

如果您愿意自由地命名标识符,则可以关闭此规则。

版本

该规则在ESLint 2.0.0-beta.2中引入。

资源