arrow-parens

要求在箭头函数参数周围使用括号

🔧

此规则报告的一些问题可以通过 --fix 命令行选项自动修复。

此规则已在 ESLint v8.53.0 中 **弃用**。请在 @stylistic/eslint-plugin-js 中使用相应的规则。

箭头函数在只有一个参数时可以省略括号。在所有其他情况下，参数必须用括号括起来。此规则强制在箭头函数中一致使用括号。

规则详情

此规则强制在箭头函数参数周围使用括号，无论其元数如何。例如

// Bad
a => {}

// Good
(a) => {}
1
2
3
4
5

遵循此样式将帮助您找到箭头函数 (=>)，这些函数可能在条件中错误地包含在内，而比较例如 >= 是意图。

// Bad
if (a => 2) {
}

// Good
if (a >= 2) {
}
1
2
3
4
5
6
7

该规则还可以配置为在不需要时不鼓励使用括号

// Bad
(a) => {}

// Good
a => {}
1
2
3
4
5

选项

此规则具有字符串选项和对象选项。

字符串选项为

"always"（默认）在所有情况下都需要在参数周围使用括号。
"as-needed" 在可以省略括号的地方强制不使用括号。

"as-needed" 选项变体的对象属性

"requireForBlockBody": true 修改 as-needed 规则以在函数体位于指令块（用大括号括起来）中时需要括号。

always

使用默认 "always" 选项时，此规则的错误代码示例

在游乐场中打开

/*eslint arrow-parens: ["error", "always"]*/

a => {};
a => a;
a => {'\n'};
a.then(foo => {});
a.then(foo => a);
a(foo => { if (true) {} });
1
2
3
4
5
6
7
8

使用默认 "always" 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint arrow-parens: ["error", "always"]*/

() => {};
(a) => {};
(a) => a;
(a) => {'\n'}
a.then((foo) => {});
a.then((foo) => { if (true) {} });
1
2
3
4
5
6
7
8

如果语句

此选项的好处之一是它可以防止在条件语句中错误地使用箭头函数。

var a = 1;
var b = 2;
// ...
if (a => b) {
 console.log('bigger');
} else {
 console.log('smaller');
}
// outputs 'bigger', not smaller as expected
1
2
3
4
5
6
7
8
9

if 语句的内容是箭头函数，而不是比较。

如果箭头函数是故意的，则应将其括在括号中以消除歧义。

var a = 1;
var b = 0;
// ...
if ((a) => b) {
 console.log('truthy value returned');
} else {
 console.log('falsy value returned');
}
// outputs 'truthy value returned'
1
2
3
4
5
6
7
8
9

以下是此行为的另一个示例

var a = 1, b = 2, c = 3, d = 4;
var f = a => b ? c: d;
// f = ?
1
2
3

f 是一个箭头函数，它将 a 作为参数并返回 b ? c: d 的结果。

这应该像这样重写

var a = 1, b = 2, c = 3, d = 4;
var f = (a) => b ? c: d;
1
2

as-needed

使用 "as-needed" 选项时，此规则的错误代码示例

在游乐场中打开

/*eslint arrow-parens: ["error", "as-needed"]*/

(a) => {};
(a) => a;
(a) => {'\n'};
a.then((foo) => {});
a.then((foo) => a);
a((foo) => { if (true) {} });
const f = /** @type {number} */(a) => a + a;
const g = /* comment */ (a) => a + a;
const h = (a) /* comment */ => a + a;
1
2
3
4
5
6
7
8
9
10
11

使用 "as-needed" 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint arrow-parens: ["error", "as-needed"]*/

() => {};
a => {};
a => a;
a => {'\n'};
a.then(foo => {});
a.then(foo => { if (true) {} });
(a, b, c) => a;
(a = 10) => a;
([a, b]) => a;
({a, b}) => a;
const f = (/** @type {number} */a) => a + a;
const g = (/* comment */ a) => a + a;
const h = (a /* comment */) => a + a;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

requireForBlockBody

{ "requireForBlockBody": true } 选项的错误代码示例

在游乐场中打开

/*eslint arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/

(a) => a;
a => {};
a => {'\n'};
a.map((x) => x * x);
a.map(x => {
  return x * x;
});
a.then(foo => {});
1
2
3
4
5
6
7
8
9
10

{ "requireForBlockBody": true } 选项的正确代码示例

在游乐场中打开

/*eslint arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/

(a) => {};
(a) => {'\n'};
a => ({});
() => {};
a => a;
a.then((foo) => {});
a.then((foo) => { if (true) {} });
a((foo) => { if (true) {} });
(a, b, c) => a;
(a = 10) => a;
([a, b]) => a;
({a, b}) => a;
1
2
3
4
5
6
7
8
9
10
11
12
13
14

版本

此规则是在 ESLint v1.0.0-rc-1 中引入的。

进一步阅读

GitHub - airbnb/javascript: JavaScript 样式指南
github.com

资源

编辑此页面