跳至内容

@stylistic/js/

no-multiple-empty-lines

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

规则详情

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

选项

此规则有一个对象选项

  • "max" (默认值: 2) 强制执行连续空行的最大数量。
  • "maxEOF" 强制执行文件末尾连续空行的最大数量。
  • "maxBOF" 强制执行文件开头连续空行的最大数量。

max

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

js
/*eslint @stylistic/js/no-multiple-empty-lines: "error"*/

var foo = 5;


var bar = 3;
错误

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

js
/*eslint @stylistic/js/no-multiple-empty-lines: "error"*/

var foo = 5;


var bar = 3;
正确

maxEOF

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

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

var foo = 5;


var bar = 3;
错误

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

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

var foo = 5;


var bar = 3;
正确

注意:虽然这确保了 EOF 处没有空行,但大多数编辑器仍然会在文件以换行符结尾的情况下在末尾显示一个空行,如下所示。在最后一个\n之后,文件末尾没有空行,尽管编辑器可能会显示一个额外的行。真正的额外行将由\n\n表示。

正确:

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

var foo = 5;


var bar = 3;
正确

maxBOF

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

js

/*eslint @stylistic/js/no-multiple-empty-lines: ["error", { "max": 2, "maxBOF": 1 }]*/ var foo = 5; var bar = 3;
错误

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

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

var foo = 5;


var bar = 3;
正确
js

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

var foo = 5;


var bar = 3;
正确

何时不使用它

如果您不关心额外的空行,请将其关闭。