nonblock-statement-body-position

强制执行单行语句的位置

此规则已在 ESLint v8.53.0 中 **弃用**。请在 相应的规则 中使用 @stylistic/eslint-plugin-js。

在编写if、else、while、do-while和for语句时，语句体可以是单个语句而不是代码块。强制执行这些单行语句的一致位置可能很有用。

例如，一些开发人员避免编写如下代码

if (foo)
  bar();
1
2

如果另一个开发人员尝试向if语句添加baz();，他们可能会错误地将代码更改为

if (foo)
  bar();
  baz(); // this line is not in the `if` statement!
1
2
3

为了避免此问题，可以要求所有单行if语句直接出现在条件之后，不换行

if (foo) bar();
1

规则详细信息

此规则旨在强制执行单行语句的一致位置。

请注意，此规则通常不强制执行单行语句的使用。如果您想禁止单行语句，请改用curly规则。

选项

此规则接受一个字符串选项

• "beside"（默认）禁止在单行语句之前换行。
• "below"要求在单行语句之前换行。
• "any"不强制执行单行语句的位置。

此外，该规则还接受一个可选的对象选项，其中包含一个"overrides"键。这可用于为覆盖默认值的特定语句指定位置。例如

• "beside", { "overrides": { "while": "below" } }要求所有单行语句都出现在其父语句的同一行，除非父语句是while语句，在这种情况下，单行语句必须不在同一行。
• "below", { "overrides": { "do": "any" } }禁止所有单行语句出现在其父语句的同一行，除非父语句是do-while语句，在这种情况下，单行语句的位置不受强制。

使用默认"beside"选项时，此规则的错误代码示例

/* eslint nonblock-statement-body-position: ["error", "beside"] */

if (foo)
  bar();
else
  baz();

while (foo)
  bar();

for (let i = 1; i < foo; i++)
  bar();

do
  bar();
while (foo)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

使用默认"beside"选项时，此规则的正确代码示例

/* eslint nonblock-statement-body-position: ["error", "beside"] */

if (foo) bar();
else baz();

while (foo) bar();

for (let i = 1; i < foo; i++) bar();

do bar(); while (foo)

if (foo) { // block statements are always allowed with this rule
  bar();
} else {
  baz();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

使用"below"选项时，此规则的错误代码示例

/* eslint nonblock-statement-body-position: ["error", "below"] */

if (foo) bar();
else baz();

while (foo) bar();

for (let i = 1; i < foo; i++) bar();

do bar(); while (foo)
1
2
3
4
5
6
7
8
9
10

使用"below"选项时，此规则的正确代码示例

/* eslint nonblock-statement-body-position: ["error", "below"] */

if (foo)
  bar();
else
  baz();

while (foo)
  bar();

for (let i = 1; i < foo; i++)
  bar();

do
  bar();
while (foo)

if (foo) {
  // Although the second `if` statement is on the same line as the `else`, this is a very common
  // pattern, so it's not checked by this rule.
} else if (bar) {
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

使用"beside", { "overrides": { "while": "below" } }规则时，此规则的错误代码示例

/* eslint nonblock-statement-body-position: ["error", "beside", { "overrides": { "while": "below" } }] */

if (foo)
  bar();

while (foo) bar();
1
2
3
4
5
6

使用"beside", { "overrides": { "while": "below" } }规则时，此规则的正确代码示例

/* eslint nonblock-statement-body-position: ["error", "beside", { "overrides": { "while": "below" } }] */

if (foo) bar();

while (foo)
  bar();
1
2
3
4
5
6

何时不使用它

如果您不关心单行语句的一致位置，则不应启用此规则。如果您对curly规则使用"all"选项，您也可以禁用此规则，因为这将完全禁止单行语句。

版本

此规则是在 ESLint v3.17.0 中引入的。

进一步阅读

JSCS
jscs-dev.github.io

资源

• 规则源代码
• 测试源代码