Eslint参考手册
规则 | Rules
arrow-parens
在--fix
命令行上的选项可以自动修复一些被这条规则反映的问题。
当它们只有一个参数时,箭头函数可以省略括号。在所有其他情况下,参数必须包含在括号内。该规则强制箭头函数中一致使用圆括号。
规则细节
无论参数如何,该规则都会在箭头函数参数周围加上括号。例如:
/*eslint-env es6*/
// Bad
a => {}
// Good
(a) => {}
遵循这种风格可以帮助您找到箭头函数(=>
),这些箭头函数可能会错误地包含在条件中,比如>=
意图。
/*eslint-env es6*/
// Bad
if (a => 2) {
}
// Good
if (a >= 2) {
}
这个规则也可以配置为在不需要时阻止使用父类:
/*eslint-env es6*/
// Bad
(a) => {}
// Good
a => {}
选项
这条规则有一个字符串选项和一个对象。
字符串选项是:
-
"always"
(默认)在所有情况下都需要参数。 -
"as-needed"
当只有一个参数时允许省略参数。
"as-needed"
选项变体的对象属性:
- 如果函数体位于指令块中(由大括号包围),则
"requireForBlockBody": true
修改需按规则以便要求parens。
always
"always"
规则的默认错误代码示例:
/*eslint arrow-parens: ["error", "always"]*/
/*eslint-env es6*/
a => {};
a => a;
a => {'\n'};
a.then(foo => {});
a.then(foo => a);
a(foo => { if (true) {} });
具有默认选项的"always"
规则的正确代码示例:
/*eslint arrow-parens: ["error", "always"]*/
/*eslint-env es6*/
() => {};
(a) => {};
(a) => a;
(a) => {'\n'}
a.then((foo) => {});
a.then((foo) => { if (true) {} });
If Statements
这个选项的好处之一是它可以防止在条件中错误地使用箭头函数:
/*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
声明的内容是一个箭头函数,而不是比较。
如果箭头功能是有意的,它应该被包裹在父类身上以消除歧义。
/*eslint-env es6*/
var a = 1;
var b = 0;
// ...
if ((a) => b) {
console.log('truthy value returned');
} else {
console.log('falsey value returned');
}
// outputs 'truthy value returned'
以下是此行为的另一个示例:
/*eslint-env es6*/
var a = 1, b = 2, c = 3, d = 4;
var f = a => b ? c: d;
// f = ?
f
是一个箭头函数,a
作为一个参数并返回结果b ? c: d
。
这应该像这样重写:
/*eslint-env es6*/
var a = 1, b = 2, c = 3, d = 4;
var f = (a) => b ? c: d;
as-needed
"as-needed"
选项规则的错误代码示例包含以下:
/*eslint arrow-parens: ["error", "as-needed"]*/
/*eslint-env es6*/
(a) => {};
(a) => a;
(a) => {'\n'};
a.then((foo) => {});
a.then((foo) => a);
a((foo) => { if (true) {} });
"as-needed"
选项规则的正确代码示例包含以下:
/*eslint 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;
requireForBlockBody
{ "requireForBlockBody": true }
选项的错误代码示例:
/*eslint 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 => {});
{ "requireForBlockBody": true }
选项的正确代码示例:
/*eslint 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;
进一步阅读
-
"as-needed", { "requireForBlockBody": true }
规则接受到 Airbnb JS Style Guide的 启发。
版本
规则在 ESLint 1.0.0-rc-1 中引入。
资源
- Rule source
- Documentation source
规则 | Rules相关
ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。
主页 | https://eslint.org/ |
源码 | https://github.com/eslint/eslint |
发布版本 | 4.12.0 |