数组括号间距

强制在数组括号内保持一致的间距

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

许多风格指南要求或禁止在数组括号和其他标记之间使用空格。此规则适用于数组字面量和解构赋值（ECMAScript 6）。

var arr = [ 'foo', 'bar' ];
var [ x, y ] = z;

var arr = ['foo', 'bar'];
var [x,y] = z;
1
2
3
4
5

规则详情

此规则强制在数组括号内保持一致的间距。

选项

此规则具有一个字符串选项

• "never"（默认）禁止在数组括号内使用空格
• "always" 要求在数组括号内使用一个或多个空格或换行符

此规则有一个对象选项，用于对 "never" 选项进行例外处理

• "singleValue": true 要求在包含单个元素的数组字面量的括号内使用一个或多个空格或换行符
• "objectsInArrays": true 要求在数组字面量的括号与其对象字面量元素的大括号之间使用一个或多个空格或换行符 [ { 或 } ]
• "arraysInArrays": true 要求在数组字面量的括号与其数组字面量元素的括号之间使用一个或多个空格或换行符 [ [ 或 ] ]

此规则有一个对象选项，用于对 "always" 选项进行例外处理

• "singleValue": false 禁止在包含单个元素的数组字面量的括号内使用空格
• "objectsInArrays": false 禁止在数组字面量的括号与其对象字面量元素的大括号之间使用空格 [{ 或 }]
• "arraysInArrays": false 禁止在数组字面量的括号与其数组字面量元素的括号之间使用空格 [[ 或 ]]

此规则具有内置例外

• "never"（以及对 "always" 选项的例外）允许在数组括号内使用换行符，因为这是一种常见的模式
• "always" 不要求在空数组字面量 [] 中使用空格或换行符

never

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

/*eslint array-bracket-spacing: ["error", "never"]*/

var arr = [ 'foo', 'bar' ];
var arr = ['foo', 'bar' ];
var arr = [ ['foo'], 'bar'];
var arr = [[ 'foo' ], 'bar'];
var arr = [ 'foo',
  'bar'
];
var [ x, y ] = z;
var [ x,y ] = z;
var [ x, ...y ] = z;
var [ ,,x, ] = z;
1
2
3
4
5
6
7
8
9
10
11
12
13

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

/*eslint array-bracket-spacing: ["error", "never"]*/

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

var [x, y] = z;
var [x,y] = z;
var [x, ...y] = z;
var [,,x,] = z;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

always

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

/*eslint array-bracket-spacing: ["error", "always"]*/

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

var [x, y] = z;
var [x,y] = z;
var [x, ...y] = z;
var [,,x,] = z;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

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

/*eslint array-bracket-spacing: ["error", "always"]*/

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

var [ x, y ] = z;
var [ x,y ] = z;
var [ x, ...y ] = z;
var [ ,,x, ] = z;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

singleValue

此规则使用 "always", { "singleValue": false } 选项的不正确代码示例

/*eslint array-bracket-spacing: ["error", "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
9
10

此规则使用 "always", { "singleValue": false } 选项的正确代码示例

/*eslint array-bracket-spacing: ["error", "always", { "singleValue": false }]*/

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

objectsInArrays

此规则使用 "always", { "objectsInArrays": false } 选项的不正确代码示例

/*eslint array-bracket-spacing: ["error", "always", { "objectsInArrays": false }]*/

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

此规则使用 "always", { "objectsInArrays": false } 选项的正确代码示例

/*eslint array-bracket-spacing: ["error", "always", { "objectsInArrays": false }]*/

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

arraysInArrays

此规则使用 "always", { "arraysInArrays": false } 选项的不正确代码示例

/*eslint array-bracket-spacing: ["error", "always", { "arraysInArrays": false }]*/

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

此规则使用 "always", { "arraysInArrays": false } 选项的正确代码示例

/*eslint array-bracket-spacing: ["error", "always", { "arraysInArrays": false }]*/

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

何时不使用它

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

相关规则

• 括号内间距
• 对象大括号间距
• 计算属性间距

版本

此规则在 ESLint v0.24.0 中引入。

资源

• 规则来源
• 测试来源