nonblock-statement-body-position

强制执行单行语句的位置

一些该规则报告的问题可以通过 --fix 命令行选项 自动修复

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

例如，一些开发人员避免编写这样的代码：

if (foo)
  bar();

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

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

为避免此问题，可能需要所有单行 if 语句直接出现在条件之后，没有换行符：

if (foo) bar();

规则详情

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

请注意，此规则通常不强制使用单行语句。如果您想禁止单行语句，请改用 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)

此规则使用默认 "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();
}

此规则使用 "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)

此规则使用 "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) {
}

此规则与 "beside", { "overrides": { "while": "below" } } 规则的错误代码示例：

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

if (foo)
  bar();

while (foo) bar();

此规则与 "beside", { "overrides": { "while": "below" } } 规则的正确代码示例：

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

if (foo) bar();

while (foo)
  bar();

何时不使用

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