| 规则名 | 规则类型 | 关联规则 | ||
|---|---|---|---|---|
padded-blocks |
layout |
|
Some style guides require block statements to start and end with blank lines. The goal is to improve readability by visually separating the block content and the surrounding code.
if (a) {
b();
}Since it's good to have a consistent code style, you should either always write padded blocks or never do it.
This rule enforces consistent empty line padding within blocks.
This rule has two options, the first one can be a string option or an object option. The second one is an object option, it can allow exceptions.
String option:
"always"(default) requires empty lines at the beginning and ending of block statements, function bodies, class static blocks, classes, andswitchstatements."never"disallows empty lines at the beginning and ending of block statements, function bodies, class static blocks, classes, andswitchstatements.
Object option:
"blocks"require or disallow padding within block statements, function bodies, and class static blocks"classes"require or disallow padding within classes"switches"require or disallow padding withinswitchstatements
"allowSingleLineBlocks": trueallows single-line blocks
选项 "always" 默认值的 错误 代码示例：
/*eslint padded-blocks: ["error", "always"]*/
if (a) {
b();
}
if (a) { b(); }
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
// comment
b();
}
class C {
static {
a();
}
}选项 "always" 默认值的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", "always"]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
// comment
b();
}
class C {
static {
a();
}
}选项 "never" 的 错误 代码示例：
/*eslint padded-blocks: ["error", "never"]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
b();
}
class C {
static {
a();
}
}选项 "never" 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", "never"]*/
if (a) {
b();
}
if (a)
{
b();
}
class C {
static {
a();
}
}选项 { "blocks": "always" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "blocks": "always" }]*/
if (a) {
b();
}
if (a) { b(); }
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
b();
}
if (a) {
// comment
b();
}
class C {
static {
a();
}
}选项 { "blocks": "always" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "blocks": "always" }]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
// comment
b();
}
class C {
static {
a();
}
}
class D {
static {
a();
}
}选项 { "blocks": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "blocks": "never" }]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
b();
}
class C {
static {
a();
}
}选项 { "blocks": "never" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "blocks": "never" }]*/
if (a) {
b();
}
if (a)
{
b();
}
class C {
static {
a();
}
}
class D {
static {
a();
}
}选项 { "classes": "always" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "classes": "always" }]*/
class A {
constructor(){
}
}选项 { "classes": "always" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "classes": "always" }]*/
class A {
constructor(){
}
}选项 { "classes": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "classes": "never" }]*/
class A {
constructor(){
}
}选项 { "classes": "never" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "classes": "never" }]*/
class A {
constructor(){
}
}选项 { "switches": "always" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "switches": "always" }]*/
switch (a) {
case 0: foo();
}选项 { "switches": "always" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "switches": "always" }]*/
switch (a) {
case 0: foo();
}
if (a) {
b();
}选项 { "switches": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "switches": "never" }]*/
switch (a) {
case 0: foo();
}选项 { "switches": "never" } 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", { "switches": "never" }]*/
switch (a) {
case 0: foo();
}
if (a) {
b();
}选项 "always", {"allowSingleLineBlocks": true} 的 错误 代码示例：
/*eslint padded-blocks: ["error", "always", { allowSingleLineBlocks: true }]*/
if (a) {
b();
}
if (a) {
b();
}
if (a) {
b();
}选项 "always", {"allowSingleLineBlocks": true} 的 正确 代码示例：
::: correct
/*eslint padded-blocks: ["error", "always", { allowSingleLineBlocks: true }]*/
if (a) { b(); }
if (a) {
b();
}You can turn this rule off if you are not concerned with the consistency of padding within blocks.