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();

何时不使用它

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

进一步阅读

• JSCS：requireNewlineBeforeSingleStatementsInIf VersionThis 规则在 ESLint 3.17.0.Resources 中引入

• 规则资源

• 文档资源