# 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" 确保在对象字面中使用所有速记或所有长格式。
"consistent-as-needed" 确保在对象字面中使用所有速记或所有长格式，但尽可能确保所有速记。

您可以像这样在配置中设置选项：

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

此外，该规则采用可选的对象配置：

"avoidQuotes": true 表示当对象键是字符串字面量时首选长格式语法（默认值：false）。请注意，仅当字符串选项设置为 "always"、"methods" 或 "properties" 时，才能启用此选项。
"ignoreConstructors": true 可用于防止规则报告构造函数的错误。（默认情况下，该规则对构造函数的处理方式与其他函数相同。）请注意，此选项只能在字符串选项设置为 "always" 或 "methods" 时启用。
"methodsIgnorePattern" (string) 对于名称与此正则表达式模式匹配的方法，将不强制执行方法简写。请注意，此选项只能在字符串选项设置为 "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() {}
};

# methodsIgnorePattern

此规则使用 "always", { "methodsIgnorePattern": "^bar$" } 选项的正确代码示例：

/*eslint object-shorthand: ["error", "always", { "methodsIgnorePattern": "^bar$" }]*/

var foo = {
    bar: 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-as-needed" 选项的错误代码示例，与 "consistent" 非常相似：

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

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

# 何时不使用

任何尚未处于 ES6 环境中的人都不想应用此规则。其他人可能会发现简写语法的简洁性更难阅读，并且可能不想通过此规则来鼓励它。

← no-with one-var →