no-multiple-empty-lines

禁止多个空行

一些该规则报告的问题可以通过 --fix 命令行选项 自动修复

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

规则详情

此规则旨在减少阅读代码时所需的滚动。超过最大空行数时会发出警告。

选项

此规则有一个对象选项：

• "max"（默认值：2）强制执行最大数量的连续空行。
• "maxEOF" 在文件末尾强制执行最大数量的连续空行。
• "maxBOF" 强制在文件开头有最大数量的连续空行。

max

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

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

var foo = 5;

var bar = 3;

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

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

var foo = 5;

var bar = 3;

maxEOF

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

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

var foo = 5;

var bar = 3;

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

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

var foo = 5;

var bar = 3;

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

不正确的：

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

正确的：

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

maxBOF

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

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

var foo = 5;

var bar = 3;

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

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

var foo = 5;

var bar = 3;

何时不使用

如果您不关心多余的空行，请将其关闭。