Eslint参考手册
规则 | Rules
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
- requirePaddingNewLinesAfterBlocks
- disallowPaddingNewLinesAfterBlocks
版本
该规则在 ESLint 4.9.0 中引入。
资源
- 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 |