padding-line-between-statements
要求或禁止语句之间有填充行
此规则报告的某些问题可以通过 --fix
命令行 选项自动修复
此规则要求或禁止在给定的 2 种语句之间使用空行。适当的空行有助于开发人员理解代码。
例如,以下配置要求在变量声明和 return
语句之间有一个空行。
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: "var", next: "return" }
]*/
function foo() {
var a = 1;
return a;
}
规则详情
如果没有提供配置,则此规则不执行任何操作。
配置是一个对象,它有 3 个属性:blankLine
、prev
和 next
。例如,{ blankLine: "always", prev: "var", next: "return" }
表示“变量声明和 return
语句之间需要一个或多个空行。” 您可以提供任意数量的配置。如果一个语句对匹配多个配置,则将使用最后匹配的配置。
{
"padding-line-between-statements": [
"error",
{ "blankLine": LINEBREAK_TYPE, "prev": STATEMENT_TYPE, "next": STATEMENT_TYPE },
{ "blankLine": LINEBREAK_TYPE, "prev": STATEMENT_TYPE, "next": STATEMENT_TYPE },
{ "blankLine": LINEBREAK_TYPE, "prev": STATEMENT_TYPE, "next": STATEMENT_TYPE },
{ "blankLine": LINEBREAK_TYPE, "prev": STATEMENT_TYPE, "next": STATEMENT_TYPE },
...
]
}
-
LINEBREAK_TYPE
是以下之一。"any"
只是忽略语句对。"never"
禁止空行。"always"
要求一个或多个空行。请注意,它不将存在注释的行计为空行。
-
STATEMENT_TYPE
是以下之一,或以下内容的数组。"*"
是通配符。这匹配任何语句。"block"
是独立的代码块。"block-like"
是类似代码块的语句。这匹配最后一个标记是代码块的右花括号的语句;例如{ }
、if (a) { }
和while (a) { }
。也匹配立即调用的函数表达式语句。"break"
是break
语句。"case"
是switch
语句中的case
子句。"cjs-export"
是 CommonJS 的export
语句;例如module.exports = 0
、module.exports.foo = 1
和exports.foo = 2
。这是赋值语句的一种特殊情况。"cjs-import"
是 CommonJS 的import
语句;例如const foo = require("foo")
。这是变量声明的一种特殊情况。"class"
是class
声明。"const"
是const
变量声明,包括单行和多行。"continue"
是continue
语句。"debugger"
是debugger
语句。"default"
是switch
语句中的default
子句。"directive"
是指令序言。这匹配指令;例如"use strict"
。"do"
是do-while
语句。这匹配第一个标记是do
关键字的所有语句。"empty"
是空语句。"export"
是export
声明。"expression"
是表达式语句。"for"
是for
循环族。这匹配第一个标记是for
关键字的所有语句。"function"
是函数声明。"if"
是if
语句。"iife"
是立即调用的函数表达式语句。这匹配对函数表达式的调用,可以选择以一元运算符为前缀。"import"
是import
声明。"let"
是let
变量声明,包括单行和多行。"multiline-block-like"
是类似代码块的语句。这与block-like
类型相同,但仅当代码块是多行时。"multiline-const"
是多行const
变量声明。"multiline-expression"
是表达式语句。这与expression
类型相同,但仅当语句是多行时。"multiline-let"
是多行let
变量声明。"multiline-var"
是多行var
变量声明。"return"
是return
语句。"singleline-const"
是单行const
变量声明。"singleline-let"
是单行let
变量声明。"singleline-var"
是单行var
变量声明。"switch"
是switch
语句。"throw"
是throw
语句。"try"
是try
语句。"var"
是var
变量声明,包括单行和多行。"while"
是while
循环语句。"with"
是with
语句。
示例
此配置将要求所有 return
语句之前都有空行,类似于 newline-before-return 规则。
[{ blankLine: "always", prev: "*", next: "return" }]
配置的错误代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: "*", next: "return" }
]*/
function foo() {
bar();
}
[{ blankLine: "always", prev: "*", next: "return" }]
配置的正确代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: "*", next: "return" }
]*/
function foo1() {
bar();
return;
}
function foo2() {
return;
}
此配置将要求每个变量声明序列之后都有空行,类似于 newline-after-var 规则。
[{ blankLine: "always", prev: ["const", "let", "var"], next: "*"}, { blankLine: "any", prev: ["const", "let", "var"], next: ["const", "let", "var"]}]
配置的错误代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: ["const", "let", "var"], next: "*"},
{ blankLine: "any", prev: ["const", "let", "var"], next: ["const", "let", "var"]}
]*/
function foo1() {
var a = 0;
}
function foo2() {
let a = 0;
}
function foo3() {
const a = 0;
}
class C {
static {
let a = 0;
}
}
[{ blankLine: "always", prev: ["const", "let", "var"], next: "*"}, { blankLine: "any", prev: ["const", "let", "var"], next: ["const", "let", "var"]}]
配置的正确代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: ["const", "let", "var"], next: "*"},
{ blankLine: "any", prev: ["const", "let", "var"], next: ["const", "let", "var"]}
]*/
function foo1() {
var a = 0;
var b = 0;
bar();
}
function foo2() {
let a = 0;
const b = 0;
bar();
}
function foo3() {
const a = 0;
const b = 0;
bar();
}
class C {
static {
let a = 0;
let b = 0;
bar();
}
}
此配置将要求所有指令序言之后都有空行,类似于 lines-around-directive 规则。
[{ blankLine: "always", prev: "directive", next: "*" }, { blankLine: "any", prev: "directive", next: "directive" }]
配置的错误代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: "directive", next: "*" },
{ blankLine: "any", prev: "directive", next: "directive" }
]*/
"use strict";
[{ blankLine: "always", prev: "directive", next: "*" }, { blankLine: "any", prev: "directive", next: "directive" }]
配置的正确代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: "directive", next: "*" },
{ blankLine: "any", prev: "directive", next: "directive" }
]*/
"use strict";
"use asm";
foo();
此配置将要求 switch
语句中的子句之间有空行。
[{ blankLine: "always", prev: ["case", "default"], next: "*" }]
配置的错误代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: ["case", "default"], next: "*" }
]*/
switch (foo) {
case 1:
bar();
break;
}
[{ blankLine: "always", prev: ["case", "default"], next: "*" }]
配置的正确代码示例
/*eslint padding-line-between-statements: [
"error",
{ blankLine: "always", prev: ["case", "default"], next: "*" }
]*/
switch (foo) {
case 1:
bar();
break;
case 2:
case 3:
baz();
break;
default:
quux();
}
何时不使用
如果您不想收到关于换行符的警告,那么禁用此规则是安全的。
兼容性
- JSCS: requirePaddingNewLineAfterVariableDeclaration
- JSCS: requirePaddingNewLinesAfterBlocks
- JSCS: disallowPaddingNewLinesAfterBlocks
- JSCS: requirePaddingNewLinesAfterUseStrict
- JSCS: disallowPaddingNewLinesAfterUseStrict
- JSCS: requirePaddingNewLinesBeforeExport
- JSCS: disallowPaddingNewLinesBeforeExport
- JSCS: requirePaddingNewlinesBeforeKeywords
- JSCS: disallowPaddingNewlinesBeforeKeywords
版本
此规则在 ESLint v4.0.0-beta.0 中引入。