no-underscore-dangle

Disallow dangling underscores in identifiers

就标识符的命名规则而言，悬空的下划线可能是 JavaScript 中最有争议的。悬空的下划线是指在标识符的开头或结尾处的下划线，例如：

var _foo;
1

在 JavaScript 中，有着长时间的历史将“私有”成员标记为带有下划线的方式，最早是由 SpiderMonkey 添加非标准方法，如 __defineGetter__()。从那时起，使用单个下划线前缀已成为指示成员不是对象公共接口的最流行约定。

建议使用在 ECMAScript 2022 中引入的正式的私有类特性来封装私有数据和方法，而不是依赖命名约定。

允许在标识符中使用悬挂下划线纯粹是一种约定，不会影响性能、可读性或复杂性。即使启用了此规则，它们也不具有与私有类特性相同的封装优势。

规则细节

这条规则不允许在标识符中使用悬空的下划线。

使用此规则的错误示例：

/*eslint no-underscore-dangle: "error"*/

var foo_;
var __proto__ = {};
foo._bar();
const [_foo, ..._bar] = list;
1
2
3
4
5
6

使用此规则的正确示例：

/*eslint no-underscore-dangle: "error"*/

var _ = require('underscore');
var obj = _.contains(items, item);
obj.__proto__ = {};
var file = __filename;
function foo(_bar) {};
const foo = { onClick(_bar) {} };
const foo = (_bar) => {};
1
2
3
4
5
6
7
8
9

选项

此规则选项为对象：

• "allow" 允许指定的标识符有悬空的下划线
• "allowAfterThis": false（默认值）不允许在 this 对象的成员中使用悬空的下划线
• "allowAfterSuper": false（默认值）不允许在 super 对象的成员中使用悬空的下划线
• "allowAfterThisConstructor": false（默认值）不允许在 this.constructor 对象的成员中使用悬空的下划线
• "enforceInMethodNames": false（默认值）允许在方法名称中使用悬空的下划线
• "enforceInClassFields": false（默认值）允许在 es2022 类字段名中使用悬空的下划线
• "allowInArrayDestructuring": true（默认值）允许在由数组解构分配的变量名称中使用悬空的下划线
• "allowInObjectDestructuring": true（默认值）允许在对象解构分配的变量名称中使用悬空的下划线
• "allowFunctionParams": true（默认值）允许在函数参数名称中使用悬空的下划线

allow

使用此规则与 { "allow": ["foo_", "_bar"] } 选项的额外正确示例：

/*eslint no-underscore-dangle: ["error", { "allow": ["foo_", "_bar"] }]*/

var foo_;
foo._bar();
1
2
3
4

allowAfterThis

使用此规则与 { "allowAfterThis": true } 选项的正确示例：

/*eslint no-underscore-dangle: ["error", { "allowAfterThis": true }]*/

var a = this.foo_;
this._bar();
1
2
3
4

allowAfterSuper

使用此规则与 { "allowAfterSuper": true } 选项的正确示例：

/*eslint no-underscore-dangle: ["error", { "allowAfterSuper": true }]*/

var a = super.foo_;
super._bar();
1
2
3
4

allowAfterThisConstructor

使用此规则与 { "allowAfterThisConstructor": true } 选项的正确示例：

/*eslint no-underscore-dangle: ["error", { "allowAfterThisConstructor": true }]*/

var a = this.constructor.foo_;
this.constructor._bar();
1
2
3
4

enforceInMethodNames

使用此规则与 { "enforceInMethodNames": true } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "enforceInMethodNames": true }]*/

class Foo {
  _bar() {}
}

class Foo {
  bar_() {}
}

const o = {
  _bar() {}
};

const o = {
  bar_() = {}
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

enforceInClassFields

使用此规则与 { "enforceInClassFields": true } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "enforceInClassFields": true }]*/

class Foo {
    _bar;
}

class Foo {
    _bar = () => {};
}

class Foo {
    bar_;
}

class Foo {
    #_bar;
}

class Foo {
    #bar_;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

allowInArrayDestructuring

使用此规则与 { "allowInArrayDestructuring": false } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "allowInArrayDestructuring": false }]*/
const [_foo, _bar] = list;
const [foo_, ..._bar] = list;
const [foo, [bar, _baz]] = list;
1
2
3
4

allowInObjectDestructuring

使用此规则与 { "allowInObjectDestructuring": false } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "allowInObjectDestructuring": false }]*/
const { foo, bar: _bar } = collection;
const { foo, bar, _baz } = collection;
1
2
3

使用此规则与 { "allowInObjectDestructuring": false } 选项的正确示例：

/*eslint no-underscore-dangle: ["error", { "allowInObjectDestructuring": false }]*/
const { foo, bar, _baz: { a, b } } = collection;
const { foo, bar, _baz: baz } = collection;
1
2
3

allowInArrayDestructuring

使用此规则与 { "allowInArrayDestructuring": false } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "allowInArrayDestructuring": false }]*/
const [_foo, _bar] = list;
const [foo_, ..._bar] = list;
const [foo, [bar, _baz]] = list;
1
2
3
4

allowInObjectDestructuring

使用此规则与 { "allowInObjectDestructuring": false } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "allowInObjectDestructuring": false }]*/
const { foo, bar: _bar } = collection;
const { foo, bar, _baz } = collection;
1
2
3

使用此规则与 { "allowInObjectDestructuring": false } 选项的正确示例：

/*eslint no-underscore-dangle: ["error", { "allowInObjectDestructuring": false }]*/
const { foo, bar, _baz: { a, b } } = collection;
const { foo, bar, _baz: baz } = collection;
1
2
3

allowFunctionParams

使用此规则与 { "allowFunctionParams": false } 选项的错误示例：

/*eslint no-underscore-dangle: ["error", { "allowFunctionParams": false }]*/

function foo (_bar) {}
function foo (_bar = 0) {}
function foo (..._bar) {}

const foo = function onClick (_bar) {}
const foo = function onClick (_bar = 0) {}
const foo = function onClick (..._bar) {}

const foo = (_bar) => {};
const foo = (_bar = 0) => {};
const foo = (..._bar) => {};
1
2
3
4
5
6
7
8
9
10
11
12
13

何时不用

如果你想在标识符中允许悬空的下划线，那么你可以安全地关闭这个规则。

Version

This rule was introduced in ESLint v0.0.9.

Resources

• Rule source
• Tests source