computed-property-spacing

强制在计算属性括号内使用一致的空格

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

虽然格式化偏好非常个人化，但许多风格指南在以下情况下要求或禁止计算属性之间的空格。

var obj = { prop: "value" };
var a = "prop";
var x = obj[a]; // computed property in object member expression

var a = "prop";
var obj = {
  [a]: "value" // computed property key in object literal (ECMAScript 6)
};

var obj = { prop: "value" };
var a = "prop";
var { [a]: x } = obj; // computed property key in object destructuring pattern (ECMAScript 6)
1
2
3
4
5
6
7
8
9
10
11
12

规则详情

此规则强制在计算属性括号内使用一致的空格。

它要么要求要么禁止括号与其内部的值之间的空格。此规则不适用于由换行符分隔的括号。

选项

此规则有两个选项，一个字符串选项和一个对象选项。

字符串选项

• "never"（默认）禁止计算属性括号内的空格。
• "always"要求计算属性括号内有一个或多个空格。

对象选项

• "enforceForClassMembers": true（默认）另外将此规则应用于类成员。

never

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

/*eslint computed-property-spacing: ["error", "never"]*/

obj[foo ]
obj[ 'foo']
var x = {[ b ]: a}
obj[foo[ bar ]]

const { [ a ]: someProp } = obj;
({ [ b ]: anotherProp } = anotherObj);
1
2
3
4
5
6
7
8
9

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

/*eslint computed-property-spacing: ["error", "never"]*/

obj[foo]
obj['foo']
var x = {[b]: a}
obj[foo[bar]]

const { [a]: someProp } = obj;
({ [b]: anotherProp } = anotherObj);
1
2
3
4
5
6
7
8
9

always

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

/*eslint computed-property-spacing: ["error", "always"]*/

obj[foo]
var x = {[b]: a}
obj[ foo]
obj['foo' ]
obj[foo[ bar ]]
var x = {[ b]: a}
const { [a]: someProp } = obj;
({ [b ]: anotherProp } = anotherObj);
1
2
3
4
5
6
7
8
9
10

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

/*eslint computed-property-spacing: ["error", "always"]*/

obj[ foo ]
obj[ 'foo' ]
var x = {[ b ]: a}
obj[ foo[ bar ] ]
const { [ a ]: someProp } = obj;
({ [ b ]: anotherProp } = anotherObj);
1
2
3
4
5
6
7
8

enforceForClassMembers

当enforceForClassMembers设置为true（默认）时，该规则还禁止/强制类方法、getter 和 setter 的计算键内的空格。

使用"never"和{ "enforceForClassMembers": true }（默认）时，此规则的错误代码示例。

/*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": true }]*/

class Foo {
  [a ]() {}
  get [b ]() {}
  set [b ](value) {}
}

const Bar = class {
  [ a](){}
  static [ b]() {}
  static get [ c ]() {}
  static set [ c ](value) {}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

使用"never"和{ "enforceForClassMembers": true }（默认）时，此规则的正确代码示例。

/*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": true }]*/

class Foo {
  [a]() {}
  get [b]() {}
  set [b](value) {}
}

const Bar = class {
  [a](){}
  static [b]() {}
  static get [c]() {}
  static set [c](value) {}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

使用"never"和{ "enforceForClassMembers": false }时，此规则的正确代码示例。

/*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": false }]*/

class Foo {
  [a ]() {}
  get [b ]() {}
  set [b ](value) {}
}

const Bar = class {
  [ a](){}
  static [ b]() {}
  static get [ c ]() {}
  static set [ c ](value) {}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

何时不使用它

如果您不关心计算属性的一致性，可以关闭此规则。

相关规则

• array-bracket-spacing
• comma-spacing
• space-in-parens

版本

此规则是在 ESLint v0.23.0 中引入的。

资源

• 规则源代码
• 测试源代码