brace-style

强制块的一致的大括号风格

🔧

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

重要提示

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

了解更多

大括号风格与编程中的缩进风格密切相关，描述了大括号相对于其控制语句和主体的放置位置。世界上可能有一打甚至更多的大括号风格。

one true brace style 是 JavaScript 中最常见的大括号风格之一，其中块的左大括号与其对应的语句或声明放在同一行。例如

if (foo) {
  bar();
} else {
  baz();
}
1
2
3
4
5

one true brace style 的一个常见变体称为 Stroustrup，其中 if-else 结构中的 else 语句，以及 catch 和 finally，必须在前一个右大括号后的单独一行上。例如

if (foo) {
  bar();
}
else {
  baz();
}
1
2
3
4
5
6

另一种风格称为 Allman，其中所有大括号都应位于单独的行上，没有任何额外的缩进。例如

if (foo)
{
  bar();
}
else
{
  baz();
}
1
2
3
4
5
6
7
8

虽然没有哪种风格被认为比另一种更好，但大多数开发人员都同意，在整个项目中保持一致的风格对于其长期可维护性至关重要。

规则详情

此规则强制块的一致的大括号风格。

选项

此规则有一个字符串选项

"1tbs" (默认) 强制 one true brace style。
"stroustrup" 强制 Stroustrup 风格。
"allman" 强制 Allman 风格。

此规则有一个对象选项用于例外情况

"allowSingleLine": true (默认 false) 允许块的左右大括号在同一行上。

1tbs

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

在 Playground 中打开

/*eslint brace-style: "error"*/

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

try
{
  somethingRisky();
} catch(e)
{
  handleError();
}

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

class C
{
    static
    {
        foo();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

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

在 Playground 中打开

/*eslint brace-style: "error"*/

function foo() {
  return true;
}

if (foo) {
  bar();
}

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

try {
  somethingRisky();
} catch(e) {
  handleError();
}

class C {
    static {
        foo();
    }
}

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

使用 "1tbs", { "allowSingleLine": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint brace-style: ["error", "1tbs", { "allowSingleLine": true }]*/

function nop() { return; }

if (foo) { bar(); }

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

try { somethingRisky(); } catch(e) { handleError(); }

if (foo) { baz(); } else {
  boom();
}

if (foo) { baz(); } else if (bar) {
  boom();
}

if (foo) { baz(); } else
if (bar) {
  boom();
}

if (foo) { baz(); } else if (bar) {
  boom();
}

try { somethingRisky(); } catch(e) {
  handleError();
}

class C {
    static { foo(); }
}

class D { static { foo(); } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

stroustrup

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

在 Playground 中打开

/*eslint brace-style: ["error", "stroustrup"]*/

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

try
{
  somethingRisky();
} catch(e)
{
  handleError();
}

class C
{
    static
    {
        foo();
    }
}

if (foo) {
  bar();
} else {
  baz();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

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

在 Playground 中打开

/*eslint brace-style: ["error", "stroustrup"]*/

function foo() {
  return true;
}

if (foo) {
  bar();
}

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

try {
  somethingRisky();
}
catch(e) {
  handleError();
}

class C {
    static {
        foo();
    }
}

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

使用 "stroustrup", { "allowSingleLine": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint brace-style: ["error", "stroustrup", { "allowSingleLine": true }]*/

function nop() { return; }

if (foo) { bar(); }

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

try { somethingRisky(); }
catch(e) { handleError(); }

class C {
    static { foo(); }
}

class D { static { foo(); } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

allman

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

在 Playground 中打开

/*eslint brace-style: ["error", "allman"]*/

function foo() {
  return true;
}

if (foo)
{
  bar(); }

try
{
  somethingRisky();
} catch(e)
{
  handleError();
}

class C {
    static {
        foo();
    }
}

if (foo) {
  bar();
} else {
  baz();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

在 Playground 中打开

/*eslint brace-style: ["error", "allman"]*/

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

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

try
{
  somethingRisky();
}
catch(e)
{
  handleError();
}

class C
{
    static
    {
        foo();
    }
}

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

使用 "allman", { "allowSingleLine": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint brace-style: ["error", "allman", { "allowSingleLine": true }]*/

function nop() { return; }

if (foo) { bar(); }

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

try { somethingRisky(); }
catch(e) { handleError(); }

class C
{
    static { foo(); }

    static
    { foo(); }
}

class D { static { foo(); } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

何时不使用

如果您不想强制特定的的大括号风格，请不要启用此规则。

版本

此规则在 ESLint v0.0.7 中引入。

延伸阅读

缩进风格 - 维基百科
en.wikipedia.org

资源

编辑此页

brace-style

规则详情

选项

1tbs

stroustrup

allman

何时不使用

相关规则

版本

延伸阅读

资源