lines-between-class-members
要求或不允许类成员之间的空行(类之间的成员)
在--fix
命令行上的选项可以自动修复一些被这条规则反映的问题。
此规则通过在类成员之间强制执行来提高可读性。它不会在第一个成员之前和最后一个成员之后检查空行,因为这已经由填充块处理。
规则细节
此规则的错误
代码示例:
/* eslint lines-between-class-members: ["error", "always"]*/
class MyClass {
foo() {
//...
}
bar() {
//...
}
}
此规则的正确
代码示例:
/* eslint lines-between-class-members: ["error", "always"]*/
class MyClass {
foo() {
//...
}
bar() {
//...
}
}
选项
该规则具有字符串选项和对象选项。
字符串选项:
"always"
(默认)在课堂成员之后需要一个空行
"never"
在班级成员之后不允许空行
对象选项:
"exceptAfterSingleLine": false
(默认)不要
在单行类成员之后跳过检查空行
"exceptAfterSingleLine": true
在单线类成员之后跳过检查空行
带有字符串选项的此规则的错误
代码示例:
/* eslint lines-between-class-members: ["error", "always"]*/
class Foo{
bar(){}
baz(){}
}
/* eslint lines-between-class-members: ["error", "never"]*/
class Foo{
bar(){}
baz(){}
}
带有字符串选项的此规则的正确
代码示例:
/* eslint lines-between-class-members: ["error", "always"]*/
class Foo{
bar(){}
baz(){}
}
/* eslint lines-between-class-members: ["error", "never"]*/
class Foo{
bar(){}
baz(){}
}
带有对象选项的此规则的正确
代码示例:
/* eslint lines-between-class-members: ["error", "always", { exceptAfterSingleLine: true }]*/
class Foo{
bar(){} // single line class member
baz(){
// multi line class member
}
qux(){}
}
何时不使用它
如果您不想强制类成员之间的空行,可以禁用此规则。
相关规则
- padded-blocks
- padding-line-between-statements
版本
该规则在 ESLint 4.9.0 中引入。