非常教程

Eslint参考手册

规则 | Rules

object-shorthand

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

ECMAScript 6为定义对象字面值方法和属性提供了一个简明的形式。这种语法可以使定义复杂的对象文字更清晰。

以下是使用 ES5语法的几个常见示例:

// properties
var foo = {
    x: x,
    y: y,
    z: z,
};

// methods
var foo = {
    a: function() {},
    b: function() {}
};

现在这里是 ES6等价物:

/*eslint-env es6*/

// properties
var foo = {x, y, z};

// methods
var foo = {
    a() {},
    b() {}
};

规则细节

此规则强制使用简写语法。这适用于在对象文字中定义的所有方法(包括生成器)以及在键名称与分配的变量的名称相匹配时定义的所有属性。

以下每个属性都会警告:

/*eslint object-shorthand: "error"*/
/*eslint-env es6*/

var foo = {
    w: function() {},
    x: function *() {},
    [y]: function() {},
    z: z
};

在这种情况下,预期的语法是:

/*eslint object-shorthand: "error"*/
/*eslint-env es6*/

var foo = {
    w() {},
    *x() {},
    [y]() {},
    z
};

此规则不会标记对象文字内的箭头函数。以下将不会警告:

/*eslint object-shorthand: "error"*/
/*eslint-env es6*/

var foo = {
    x: (y) => y
};

选项

该规则带有一个选项,指定何时应用该选项。它可以设置为以下值之一:

  • "always" (默认)期望尽可能使用速记。
  • "methods" 确保使用方法速记(也适用于生成器)。
  • "properties" 确保使用属性速记(密钥和变量名称匹配的地方)。
  • "never" 确保在任何对象字面上不使用属性或方法速记。
  • "consistent" 确保所有速记或全部 longform 将用于对象文字。
  • "consistent-as-needed" 确保所有速记或全部长格式都将用于对象字面,但可确保尽可能缩短速度。

你可以像这样在配置中设置选项:

{
    "object-shorthand": ["error", "always"]
}

另外,该规则采用可选的对象配置:

  • "avoidQuotes": true指示只要对象键是字符串文字(默认值:false),longform 语法就是首选。需要注意的是,当串选项设置为这个选项只能启用"always""methods""properties"
  • "ignoreConstructors": true可以用来防止规则报告构造函数的错误。(默认情况下,规则以与其他函数相同的方式处理构造函数。)请注意,仅当字符串选项设置为"always""methods"时才能启用此选项。
  • "avoidExplicitReturnArrows": true指示方法优于函数属性的显式返回箭头函数。(默认情况下,规则允许使用其中任何一种。)请注意,只有在字符串选项设置为"always""methods"时,才能启用此选项。

avoidQuotes

{
    "object-shorthand": ["error", "always", { "avoidQuotes": true }]
}

此规则的错误代码示例包含以下"always", { "avoidQuotes": true }选项:

/*eslint object-shorthand: ["error", "always", { "avoidQuotes": true }]*/
/*eslint-env es6*/

var foo = {
    "bar-baz"() {}
};

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

/*eslint object-shorthand: ["error", "always", { "avoidQuotes": true }]*/
/*eslint-env es6*/

var foo = {
    "bar-baz": function() {},
    "qux": qux
};

ignoreConstructors

{
    "object-shorthand": ["error", "always", { "ignoreConstructors": true }]
}

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

/*eslint object-shorthand: ["error", "always", { "ignoreConstructors": true }]*/
/*eslint-env es6*/

var foo = {
    ConstructorFunction: function() {}
};

avoidExplicitReturnArrows

{
    "object-shorthand": ["error", "always", { "avoidExplicitReturnArrows": true }]
}

此规则的错误代码示例包含以下"always", { "avoidExplicitReturnArrows": true }选项:

/*eslint object-shorthand: ["error", "always", { "avoidExplicitReturnArrows": true }]*/
/*eslint-env es6*/

var foo = {
  foo: (bar, baz) => {
    return bar + baz;
  },

  qux: (foobar) => {
    return foobar * 2;
  }
};

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

/*eslint object-shorthand: ["error", "always", { "avoidExplicitReturnArrows": true }]*/
/*eslint-env es6*/

var foo = {
  foo(bar, baz) {
    return bar + baz;
  },

  qux: foobar => foobar * 2
};

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

/*eslint object-shorthand: [2, "consistent"]*/
/*eslint-env es6*/

var foo = {
    a,
    b: "foo",
};

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

/*eslint object-shorthand: [2, "consistent"]*/
/*eslint-env es6*/

var foo = {
    a: a,
    b: "foo"
};

var bar = {
    a,
    b,
};

使用非常类似于"consistent""consistent-as-needed"选项的错误代码示例,:

/*eslint object-shorthand: [2, "consistent-as-needed"]*/
/*eslint-env es6*/

var foo = {
    a: a,
    b: b,
};

何时不使用它

尚未在 ES6环境中的任何人都不希望应用此规则。其他人可能会发现简写语法的简洁性难以阅读,可能不希望用此规则来鼓励它。

进一步阅读

Object initializer - MDN

版本

此规则在 ESLint 0.20.0中引入。

资源

  • 规则资源
  • 文档资源

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