array-bracket-spacing

強制陣列括號內的一致間距

許多風格指南要求或禁止陣列括號和其他符號之間有空格。此規則適用於陣列字面值和解構賦值（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

何時不應使用

如果您不關心陣列括號之間間距的一致性，則可以關閉此規則。

相關規則

• space-in-parens
• object-curly-spacing
• computed-property-spacing

版本

此規則在 ESLint v0.24.0 中引入。

資源

• 規則來源
• 測試來源