非常教程

Eslint参考手册

规则 | Rules

brace-style

--fix命令行上的选项可以自动修复一些被这条规则反映的问题。

Brace风格与编程中的缩进风格密切相关,并描述了花括号相对于其控制语句和正文的位置。世界上可能有十几种支架,如果不是更多的话。

在一个真正的大括号的风格是在 JavaScrip 中最常见的主要款式,其中一个块的左大括号放在同一行及其相应的说明或声明中的一个。例如:

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

一种真正的大括号风格的一种常见变体称为 Stroustrup,其中构造体中的else语句if-else以及catchfinally必须在前一个大括号之后在其自己的行上。例如:

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

另一种风格叫做 Allman,其中所有的大括号预计将在他们自己的路线上没有任何额外的缩进。例如:

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

尽管没有哪种风格比其他风格更好,但大多数开发人员都认为,在整个项目中保持一致的风格对于其长期可维护性来说非常重要。

规则细节

规则为块执行一致的括号样式。

选项

这条规则有字符串选项:

  • "1tbs" (默认)强制执行一个真正的大括号风格
  • "stroustrup" 强制执行Stroustrup风格
  • "allman" 强制Allman风格

规则具有异常的对象选项:

  • "allowSingleLine": true(默认false)允许一个块打开和关闭括号在同一行上

1tbs

"1tbs"规则的默认错误代码示例:

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

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

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

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

具有默认选项"1tbs"的规则正确代码示例:

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

function foo() {
  return true;
}

if (foo) {
  bar();
}

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

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

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();

"1tbs", { "allowSingleLine": true }选项的规则正确代码示例包含以下:

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

function nop() { return; }

if (foo) { bar(); }

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

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

stroustrup

"stroustrup"选项的规则错误代码示例包含以下:

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

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

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

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

"stroustrup"选项的规则正确代码示例包含以下:

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

function foo() {
  return true;
}

if (foo) {
  bar();
}

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

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

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();

使用"stroustrup", { "allowSingleLine": true }选项的规则正确代码示例包含以下:

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

function nop() { return; }

if (foo) { bar(); }

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

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

allman

使用"allman"选项的规则错误代码示例包含以下:

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

function foo() {
  return true;
}

if (foo)
{
  bar(); }

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

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

"allman"选项的规则正确代码示例包含以下:

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

function foo()
{
  return true;
}

if (foo)
{
  bar();
}

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

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

// when there are no braces, there are no problems
if (foo) bar();
else if (baz) boom();

"allman", { "allowSingleLine": true }规则的正确代码示例包含以下选项:

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

function nop() { return; }

if (foo) { bar(); }

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

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

何时不使用它

如果您不想执行特定的大括号样式,请不要启用此规则。

进一步阅读

  • Indent style

版本

这个规则在 ESLint 0.0.7 中引入。

资源

  • Rule source
  • Documentation source

规则 | Rules相关

1.accessor-pairs
2.array-bracket-newline
3.array-bracket-spacing
4.array-callback-return
5.array-element-newline
6.arrow-body-style
7.arrow-parens
8.arrow-spacing
9.block-scoped-var
10.block-spacing
11.callback-return
12.camelcase
13.capitalized-comments
14.class-methods-use-this
15.comma-dangle
16.comma-spacing
17.comma-style
18.complexity
19.computed-property-spacing
20.consistent-return
21.consistent-this
22.constructor-super
23.curly
24.default-case
25.dot-location
26.dot-notation
27.eol-last
28.eqeqeq
29.for-direction
30.func-call-spacing
31.func-name-matching
32.func-names
33.func-style
34.function-paren-newline
35.generator-star
36.generator-star-spacing
37.getter-return
38.global-require
39.global-strict
40.guard-for-in
41.handle-callback-err
42.id-blacklist
43.id-length
44.id-match
45.implicit-arrow-linebreak
46.indent
47.indent-legacy
48.init-declarations
49.jsx-quotes
50.key-spacing
51.keyword-spacing
52.line-comment-position
53.linebreak-style
54.lines-around-comment
55.lines-around-directive
56.lines-between-class-members
57.max-depth
58.max-len
59.max-lines
60.max-nested-callbacks
61.max-params
62.max-statements
63.max-statements-per-line
64.multiline-comment-style
65.multiline-ternary
66.new-cap
67.new-parens
68.newline-after-var
69.newline-before-return
70.newline-per-chained-call
71.no-alert
72.no-array-constructor
73.no-arrow-condition
74.no-await-in-loop
75.no-bitwise
76.no-buffer-constructor
77.no-caller
78.no-case-declarations
79.no-catch-shadow
80.no-class-assign
81.no-comma-dangle
82.no-compare-neg-zero
83.no-cond-assign
84.no-confusing-arrow
85.no-console
86.no-const-assign
87.no-constant-condition
88.no-continue
89.no-control-regex
90.no-debugger
91.no-delete-var
92.no-div-regex
93.no-dupe-args
94.no-dupe-class-members
95.no-dupe-keys
96.no-duplicate-case
97.no-duplicate-imports
98.no-else-return
99.no-empty
100.no-empty-character-class
Eslint

ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。

主页 https://eslint.org/
源码 https://github.com/eslint/eslint
发布版本 4.12.0

Eslint目录

1.指南 | Guide
2.规则 | Rules