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中引入。

资源

规则资源

文档资源