no-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

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
8
9

使用 { 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

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

var foo = 5;


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

何时不使用

如果您不关心额外的空行，请关闭此规则。

版本

此规则在 ESLint v0.9.0 中引入。

资源

• 规则源代码
• 测试源代码