no-multiple-empty-lines
禁止使用多个空行
🔧 可修复
此规则报告的一些问题可以通过 --fix
命令行 选项自动修复。
此规则在 ESLint v8.53.0 中已 **弃用**。请使用 相应的规则 在 @stylistic/eslint-plugin-js
中。
一些开发者更喜欢移除多余的空行,而另一些开发者则认为它有助于提高可读性。空格用于分隔代码的逻辑部分,但过多的空格会占用更多的屏幕空间。
规则详情
此规则旨在减少阅读代码时所需的滚动次数。当超过最大空行数时,它会发出警告。
选项
此规则具有一个对象选项
"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
表示。
正确:
在游乐场中打开
/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxEOF": 0 }]*/⏎
⏎
var foo = 5;⏎
⏎
⏎
var bar = 3;⏎
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;
在游乐场中打开
/*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxBOF": 1}]*/
var foo = 5;
var bar = 3;
何时不使用它
如果您不关心额外的空行,请将其关闭。
版本
此规则在 ESLint v0.9.0 中引入。