no-underscore-dangle

禁止标识符中出现悬挂的下划线

就标识符的命名约定而言，悬挂的下划线可能是 JavaScript 中最具争议的。悬挂的下划线是指标识符开头或结尾的下划线，例如

var _foo;
1

在 JavaScript 中，使用悬挂的下划线来标记“私有”成员的历史由来已久，最早可以追溯到 SpiderMonkey 添加了诸如 __defineGetter__() 之类的非标准方法。从那时起，使用单个下划线前缀已成为表示成员不是对象公共接口一部分的最流行约定。

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

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

规则详情

此规则禁止标识符中出现悬挂的下划线。

此规则的错误代码示例

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

var foo_;
var __proto__ = {};
foo._bar();
1
2
3
4
5

此规则的正确代码示例

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

var _ = require('underscore');
var obj = _.contains(items, item);
obj.__proto__ = {};
var file = __filename;
function foo(_bar) {};
const bar = { onClick(_bar) {} };
const baz = (_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 }]*/

class Foo extends Bar {
  doSomething() {
    var a = super.foo_;
    super._bar();
  }
}
1
2
3
4
5
6
7
8

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 Bar {
  bar_() {}
}

const o1 = {
  _bar() {}
};

const o2 = {
  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 Bar {
    _bar = () => {};
}

class Baz {
    bar_;
}

class Qux {
    #_bar;
}

class FooBar {
    #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_, ..._qux] = list;
const [foo, [bar, _baz]] = list;
1
2
3
4
5

allowInObjectDestructuring

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

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

const { foo, bar: _bar } = collection;
const { qux, xyz, _baz } = collection;
1
2
3
4

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

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

const { foo, bar, _baz: { a, b } } = collection;
const { qux, xyz, _baz: baz } = collection;
1
2
3
4

allowFunctionParams

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

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

function foo1 (_bar) {}
function foo2 (_bar = 0) {}
function foo3 (..._bar) {}

const foo4 = function onClick (_bar) {}
const foo5 = function onClick (_bar = 0) {}
const foo6 = function onClick (..._bar) {}

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

何时不使用它

如果要允许标识符中出现悬挂的下划线，则可以安全地关闭此规则。

版本

此规则在 ESLint v0.0.9 中引入。

资源

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