ESLintrequire or disallow padding within blocks (padded-blocks)
要求或禁止块内填充 (padded-blocks)
The --fix option on the command line can automatically fix some of the problems reported by this rule.
命令行中的 --fix 选项可以自动修复一些该规则报告的问题。
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.
代码风格统一是非常有好处的，你应总是写填充的块或永远不这么做。
Rule Details
This rule enforces consistent empty line padding within blocks.
该规则强制块内空行填充的一致性。
Options
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.
此规则有两个选项，第一个可以是字符串选项或对象选项。第二个是对象选项，它允许异常。
First option
String option:
字符串选项：
"always"(default) requires empty lines at the beginning and ending of block statements and classes"always"(默认) 要求块语句和类的开始或末尾有空行"never"disallows empty lines at the beginning and ending of block statements and classes"never"禁止块语句和类的开始或末尾有空行
Object option:
对象选项：
"blocks"require or disallow padding within block statements"blocks"要求或禁止块内填充"classes"require or disallow padding within classes"classes"要求或禁止类内填充"switches"require or disallow padding withinswitchstatements"switches"要求或禁止在switch语句中填充
Second option
"allowSingleLineBlocks": trueallows single-line blocks"allowSingleLineBlocks": true允许单行块
always
Examples of incorrect code for this rule with the default "always" option:
默认选项 "always" 的 错误 代码示例：
/*eslint padded-blocks: ["error", "always"]*/
if (a) {
b();
}
if (a) { b(); }
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
// comment
b();
}
Examples of correct code for this rule with the default "always" option:
默认选项 "always" 的 正确 代码示例：
/*eslint padded-blocks: ["error", "always"]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
// comment
b();
}
never
Examples of incorrect code for this rule with the "never" option:
选项 "never" 的 错误 代码示例：
/*eslint padded-blocks: ["error", "never"]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
b();
}
Examples of correct code for this rule with the "never" option:
选项 "never" 的 正确 代码示例：
/*eslint padded-blocks: ["error", "never"]*/
if (a) {
b();
}
if (a)
{
b();
}
blocks
Examples of incorrect code for this rule with the { "blocks": "always" } option:
选项 { "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();
}
Examples of correct code for this rule with the { "blocks": "always" } option:
选项 { "blocks": "always" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "blocks": "always" }]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
// comment
b();
}
Examples of incorrect code for this rule with the { "blocks": "never" } option:
选项 { "blocks": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "blocks": "never" }]*/
if (a) {
b();
}
if (a)
{
b();
}
if (a) {
b();
}
if (a) {
b();
}
Examples of correct code for this rule with the { "blocks": "never" } option:
选项 { "blocks": "never" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "blocks": "never" }]*/
if (a) {
b();
}
if (a)
{
b();
}
classes
Examples of incorrect code for this rule with the { "classes": "always" } option:
选项 { "classes": "always" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "classes": "always" }]*/
class A {
constructor(){
}
}
Examples of correct code for this rule with the { "classes": "always" } option:
选项 { "classes": "always" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "classes": "always" }]*/
class A {
constructor(){
}
}
Examples of incorrect code for this rule with the { "classes": "never" } option:
选项 { "classes": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "classes": "never" }]*/
class A {
constructor(){
}
}
Examples of correct code for this rule with the { "classes": "never" } option:
选项 { "classes": "never" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "classes": "never" }]*/
class A {
constructor(){
}
}
switches
Examples of incorrect code for this rule with the { "switches": "always" } option:
选项 { "switches": "always" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "switches": "always" }]*/
switch (a) {
case 0: foo();
}
Examples of correct code for this rule with the { "switches": "always" } option:
选项 { "switches": "always" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "switches": "always" }]*/
switch (a) {
case 0: foo();
}
if (a) {
b();
}
Examples of incorrect code for this rule with the { "switches": "never" } option:
选项 { "switches": "never" } 的 错误 代码示例：
/*eslint padded-blocks: ["error", { "switches": "never" }]*/
switch (a) {
case 0: foo();
}
Examples of correct code for this rule with the { "switches": "never" } option:
选项 { "switches": "never" } 的 正确 代码示例：
/*eslint padded-blocks: ["error", { "switches": "never" }]*/
switch (a) {
case 0: foo();
}
if (a) {
b();
}
always + allowSingleLineBlocks
Examples of incorrect code for this rule with the "always", {"allowSingleLineBlocks": true} options:
选项 "always", {"allowSingleLineBlocks": true} 的 错误 代码示例：
/*eslint padded-blocks: ["error", "always", { allowSingleLineBlocks: true }]*/
if (a) {
b();
}
if (a) {
b();
}
if (a) {
b();
}
Examples of correct code for this rule with the "always", {"allowSingleLineBlocks": true} options:
选项 "always", {"allowSingleLineBlocks": true} 的 正确 代码示例：
/*eslint padded-blocks: ["error", "always", { allowSingleLineBlocks: true }]*/
if (a) { b(); }
if (a) {
b();
}
When Not To Use It
You can turn this rule off if you are not concerned with the consistency of padding within blocks.
如果你并不关心块内填充的一致性，你可以关闭此规则。
Related Rules
Version
This rule was introduced in ESLint 0.9.0.
该规则在 ESLint 0.9.0 中被引入。