跳至内容

@stylistic/js/

arrow-parens

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

规则详细信息

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

js
/*eslint-env es6*/

// Bad
a => {}

// Good
(a) => {}

遵循此样式将帮助您找到箭头函数 (=>),这些函数可能在条件中被错误地包含在内,而实际上是 >= 等比较。

js
/*eslint-env es6*/

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

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

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

js
/*eslint-env es6*/

// Bad
(a) => {}

// Good
a => {}

选项

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

字符串选项为

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

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

  • "requireForBlockBody": true 修改 as-needed 规则,以便在函数体位于指令块(用大括号包围)中时要求使用括号。

always

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

js
/*eslint @stylistic/js/arrow-parens: ["error", "always"]*/
/*eslint-env es6*/

a
=> {};
a
=> a;
a
=> {'\n'};
a.then(
foo
=> {});
a.then(
foo
=> a);
a(
foo
=> { if (true) {} });
incorrect

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

js
/*eslint @stylistic/js/arrow-parens: ["error", "always"]*/
/*eslint-env es6*/

() => {};
(a) => {};
(a) => a;
(a) => {'\n'}
a.then((foo) => {});
a.then((foo) => { if (true) {} });
correct

If 语句

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

js
/*eslint-env es6*/

var a = 1;
var b = 2;
// ...
if (a => b) {
 console.log('bigger');
} else {
 console.log('smaller');
}
// outputs 'bigger', not smaller as expected

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

如果箭头函数是故意的,则应将其用括号括起来以消除歧义。

js
/*eslint-env es6*/

var a = 1;
var b = 0;
// ...
if ((a) => b) {
 console.log('truthy value returned');
} else {
 console.log('falsy value returned');
}
// outputs 'truthy value returned'

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

js
/*eslint-env es6*/

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

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

这应该像这样重写

js
/*eslint-env es6*/

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

as-needed

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

js
/*eslint @stylistic/js/arrow-parens: ["error", "as-needed"]*/
/*eslint-env es6*/

(
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;
incorrect

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

js
/*eslint @stylistic/js/arrow-parens: ["error", "as-needed"]*/
/*eslint-env es6*/

() => {};
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;
correct

requireForBlockBody

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

js
/*eslint @stylistic/js/arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/
/*eslint-env es6*/

(
a
) => a;
a
=> {};
a
=> {'\n'};
a.map((
x
) => x * x);
a.map(
x
=> {
return x * x; }); a.then(
foo
=> {});
incorrect

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

js
/*eslint @stylistic/js/arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/
/*eslint-env es6*/

(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;
correct