space-in-brackets

强制执行对象字面量的花括号和数组字面量的方括号内的一致空格。

虽然格式化偏好非常个人化，但许多风格指南要求或禁止在括号之间使用空格

var obj = { foo: 'bar' };
var arr = [ 'foo', 'bar' ];
foo[ 'bar' ];

var obj = {foo: 'bar'};
var arr = ['foo', 'bar'];
foo['bar'];
1
2
3
4
5
6
7

规则详情

此规则旨在维护方括号内空格的一致性，要么禁止括号内括号和其他标记之间的空格，要么强制使用空格。与相邻值之间用换行符分隔的括号在此规则中被豁免，因为这是一种常见的模式。用作数组中第一个或最后一个元素的对象字面量也被忽略。

选项

此规则有两个选项

"always" 强制在对象和数组字面量内部使用空格
"never" 强制在对象和数组字面量内部不使用空格（默认）

根据您的编码约定，您可以通过在配置中指定来选择任一选项

"space-in-brackets": ["error", "always"]
1

“never”

对于使用默认 "never" 选项的此规则的错误代码示例

foo[ 'bar' ];
foo['bar' ];

var arr = [ 'foo', 'bar' ];
var arr = ['foo', 'bar' ];
var arr = [ ['foo'], 'bar'];
var arr = [[ 'foo' ], 'bar'];
var arr = ['foo',
  'bar'
];

var obj = { 'foo': 'bar' };
var obj = {'foo': 'bar' };
var obj = { baz: {'foo': 'qux'}, bar};
var obj = {baz: { 'foo': 'qux' }, bar};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

对于使用默认 "never" 选项的此规则的正确代码示例

// When options are ["error", "never"]

foo['bar'];
foo[
  'bar'
];
foo[
  'bar'];

var arr = [];
var arr = ['foo', 'bar', 'baz'];
var arr = [['foo'], 'bar', 'baz'];
var arr = [
  'foo',
  'bar',
  'baz'
];

var arr = [
  'foo',
  'bar'];

var obj = {'foo': 'bar'};

var obj = {'foo': {'bar': 'baz'}, 'qux': 'quxx'};

var obj = {
  'foo': 'bar'
};
var obj = {'foo': 'bar'
};
var obj = {
  'foo':'bar'};

var obj = {};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

“always”

对于使用 "always" 选项的此规则的错误代码示例

foo['bar'];
foo['bar' ];
foo[ 'bar'];

var arr = ['foo', 'bar'];
var arr = ['foo', 'bar' ];
var arr = [ ['foo'], 'bar' ];
var arr = ['foo',
  'bar'
];

var arr = [
  'foo',
  'bar'];

var obj = {'foo': 'bar'};
var obj = {'foo': 'bar' };
var obj = { baz: {'foo': 'qux'}, bar};
var obj = {baz: { 'foo': 'qux' }, bar};
var obj = {'foo': 'bar'
};

var obj = {
  'foo':'bar'};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

对于使用 "always" 选项的此规则的正确代码示例

foo[ 'bar' ];
foo[
  'bar'
];

var arr = [];
var arr = [ 'foo', 'bar', 'baz' ];
var arr = [ [ 'foo' ], 'bar', 'baz' ];

var arr = [
  'foo',
  'bar',
  'baz'
];

var obj = {};
var obj = { 'foo': 'bar' };
var obj = { 'foo': { 'bar': 'baz' }, 'qux': 'quxx' };
var obj = {
  'foo': 'bar'
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

请注意，"always" 有一个特殊情况，其中 {} 和 [] 不被认为是问题。

例外

对象字面量可以用作第三个数组项，以指定空格例外。这些例外在第一个选项的上下文中起作用。也就是说，如果 "always" 设置为强制空格，并且例外设置为 false，则对于与例外匹配的情况，它将禁止空格。同样，如果 "never" 设置为禁止空格，并且例外设置为 true，则对于与例外匹配的情况，它将强制空格。

您可以像这样添加例外

对于 "always" 选项，将例外设置为 false 以启用它

"space-in-brackets": ["error", "always", {
  "singleValue": false,
  "objectsInArrays": false,
  "arraysInArrays": false,
  "arraysInObjects": false,
  "objectsInObjects": false,
  "propertyName": false
}]
1
2
3
4
5
6
7
8

对于 "never" 选项，将例外设置为 true 以启用它

"space-in-brackets": ["error", "never", {
  "singleValue": true,
  "objectsInArrays": true,
  "arraysInArrays": true,
  "arraysInObjects": true,
  "objectsInObjects": true,
  "propertyName": true
}]
1
2
3
4
5
6
7
8

以下例外可用

singleValue 设置数组的方括号内单个值的空格。
objectsInArrays 设置作为数组中第一个或最后一个元素的对象字面量的花括号和方括号之间的空格。
arraysInArrays 设置作为数组中第一个或最后一个元素的数组字面量的方括号之间的空格。
arraysInObjects 设置作为对象中最后一个元素的数组字面量的方括号和花括号之间的空格。
objectsInObjects 设置作为对象中最后一个元素的对象字面量的花括号和包含对象的花括号之间的空格。
propertyName 设置计算成员表达式的方括号中的空格。

在以下每个示例中，都假定使用 "always" 选项。

当 "singleValue" 设置为 false 时，此规则的错误代码示例

var foo = [ 'foo' ];
var foo = [ 'foo'];
var foo = ['foo' ];
var foo = [ 1 ];
var foo = [ 1];
var foo = [1 ];
var foo = [ [ 1, 2 ] ];
var foo = [ { 'foo': 'bar' } ];
1
2
3
4
5
6
7
8

当 "singleValue" 设置为 false 时，此规则的正确代码示例

var foo = ['foo'];
var foo = [1];
var foo = [[ 1, 1 ]];
var foo = [{ 'foo': 'bar' }];
1
2
3
4

当 "objectsInArrays" 设置为 false 时的错误代码示例

var arr = [ { 'foo': 'bar' } ];
var arr = [ {
  'foo': 'bar'
} ]
1
2
3
4

当 "objectsInArrays" 设置为 false 时的正确代码示例

var arr = [{ 'foo': 'bar' }];
var arr = [{
  'foo': 'bar'
}];
1
2
3
4

当 "arraysInArrays" 设置为 false 时的错误代码示例

var arr = [ [ 1, 2 ], 2, 3, 4 ];
var arr = [ [ 1, 2 ], 2, [ 3, 4 ] ];
1
2

当 "arraysInArrays" 设置为 false 时的正确代码示例

var arr = [[ 1, 2 ], 2, 3, 4 ];
var arr = [[ 1, 2 ], 2, [ 3, 4 ]];
1
2

当 "arraysInObjects" 设置为 false 时的错误代码示例

var obj = { "foo": [ 1, 2 ] };
var obj = { "foo": [ "baz", "bar" ] };
1
2

当 "arraysInObjects" 设置为 false 时的正确代码示例

var obj = { "foo": [ 1, 2 ]};
var obj = { "foo": [ "baz", "bar" ]};
1
2

当 "objectsInObjects" 设置为 false 时的错误代码示例

var obj = { "foo": { "baz": 1, "bar": 2 } };
var obj = { "foo": [ "baz", "bar" ], "qux": { "baz": 1, "bar": 2 } };
1
2

当 "objectsInObjects" 设置为 false 时的正确代码示例

var obj = { "foo": { "baz": 1, "bar": 2 }};
var obj = { "foo": [ "baz", "bar" ], "qux": { "baz": 1, "bar": 2 }};
1
2

当 "propertyName" 设置为 false 时的错误代码示例

var foo = obj[ 1 ];
var foo = obj[ bar ];
1
2

当 "propertyName" 设置为 false 时，此规则的正确代码示例

var foo = obj[bar];
var foo = obj[0, 1];
1
2

何时不使用它

如果您不关心括号之间空格的一致性，则可以关闭此规则。

版本

此规则在 ESLint v0.4.1 中引入，并在 v1.0.0-rc-1 中移除。

编辑此页