no-multiple-empty-lines

Disallow multiple empty lines

有些开发者喜欢删除多个空白行，而另一些开发者则认为这有助于提高可读性。留白对于分隔代码的逻辑部分很有用，但多余的留白会占用更多的屏幕。

规则细节

这个规则旨在减少阅读你的代码时需要的滚动。它将在超过最大空行数时发出警告。

选项

此规则选项为对象：

• "max"（默认：2）强制执行一个最大的连续空行数。
• "maxEOF" 在文件的结尾处执行最大的连续空行数。
• "maxBOF" 强制执行文件开头的最大连续空行数。

max

使用此规则与默认的 { "max": 2 } 选项的错误示例：

/*eslint no-multiple-empty-lines: "error"*/

var foo = 5;



var bar = 3;
1
2
3
4
5
6
7

使用此规则与默认的 { "max": 2 } 选项的正确示例：

/*eslint no-multiple-empty-lines: "error"*/

var foo = 5;


var bar = 3;
1
2
3
4
5
6

maxEOF

使用此规则与 { max: 2, maxEOF: 0 } 选项的错误示例：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxEOF": 0 }]*/

var foo = 5;


var bar = 3;


1
2
3
4
5
6
7
8

使用此规则与 { max: 2, maxEOF: 0 } 选项的正确示例：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxEOF": 0 }]*/

var foo = 5;


var bar = 3;
1
2
3
4
5
6

注意：尽管这样可以确保 EOF 处没有空行，但如果文件以换行方式结束，大多数编辑器仍然会在最后显示一个空行，如下图所示。在最后一个 \n 之后的文件末尾没有空行，尽管编辑器可能会显示一个附加行。一个真正的附加行将用 \n\n 表示。

错误：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxEOF": 0 }]*/⏎
⏎
var foo = 5;⏎
⏎
⏎
var bar = 3;⏎
⏎

1
2
3
4
5
6
7
8

正确：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxEOF": 0 }]*/⏎
⏎
var foo = 5;⏎
⏎
⏎
var bar = 3;⏎

1
2
3
4
5
6
7

maxBOF

使用此规则与 { max: 2, maxBOF: 1 } 选项的错误示例：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxBOF": 1 }]*/


var foo = 5;


var bar = 3;
1
2
3
4
5
6
7

使用此规则与 { max: 2, maxBOF: 1 } 选项的正确示例：

/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxBOF": 1}]*/

var foo = 5;


var bar = 3;
1
2
3
4
5
6

何时不用

如果你不关心额外的空行，就把它关掉。

Version

This rule was introduced in ESLint v0.9.0.

Resources

• Rule source
• Tests source