# space-in-brackets

在对象字面的大括号和数组字面的括号内强制保持一致的间距。

(已删除)此规则在 ESLint v1.0 中已删除,并由 object-curly-spacingarray-bracket-spacing 规则替换。

虽然格式偏好非常个人化,但许多样式指南要求或不允许括号之间有空格:

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

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

# 规则详情

此规则旨在保持方括号内间距的一致性,方法是禁止括号内的空格和其他标记之间的括号内的空格或强制空格。用新行与相邻值分隔的括号不适用此规则,因为这是一种常见模式。用作数组中第一个或最后一个元素的对象字面也将被忽略。

# 选项

此规则有两个选项:

  • "always" 在对象和数组字面量内强制使用空格
  • "never" 在对象和数组字面量内强制使用零空格(默认)

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

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

# "never"

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

/*eslint-env es6*/

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};

此规则使用默认 "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 = {};

# "always"

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

/*eslint-env es6*/

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'};

此规则使用 "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'
};

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

# 异常

对象字面量可以用作第三个数组项来指定间距异常。这些例外在第一个选项的上下文中起作用。也就是说,如果 "always" 设置为强制间距,而异常设置为 false,它将不允许与异常匹配的案例使用间距。同样,如果 "never" 设置为不允许间距,并且异常设置为 true,它将强制为匹配异常的案例设置间距。

您可以像这样添加例外:

"always" 选项的情况下,为 false 设置一个例外以启用它:

"space-in-brackets": ["error", "always", {
  "singleValue": false,
  "objectsInArrays": false,
  "arraysInArrays": false,
  "arraysInObjects": false,
  "objectsInObjects": false,
  "propertyName": false
}]

"never" 选项的情况下,为 true 设置一个例外以启用它:

"space-in-brackets": ["error", "never", {
  "singleValue": true,
  "objectsInArrays": true,
  "arraysInArrays": true,
  "arraysInObjects": true,
  "objectsInObjects": true,
  "propertyName": true
}]

以下例外情况可用:

  • 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' } ];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"propertyName" 设置为 false 时的正确代码示例:

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

# 何时不使用

如果您不关心括号间距的一致性,您可以关闭此规则。

Last Updated: 5/13/2023, 8:55:38 PM