Index

array-bracket-spacing

在数组括号内强制执行一致的间距

🔧

此规则报告的一些问题可通过 --fix 命令行 选项自动修复

Important

This rule was deprecated in ESLint v8.53.0. It will be removed in v11.0.0. Please use the corresponding rule in @stylistic/eslint-plugin.

Learn more

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

🌐 A number of style guides require or disallow spaces between array brackets and other tokens. This rule applies to both array literals and destructuring assignments (ECMAScript 6).

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

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

规则详情

🌐 Rule Details

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

🌐 This rule enforces consistent spacing inside array brackets.

选项

🌐 Options

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

🌐 This rule has a string option:

  • "never"（默认）不允许数组括号内有空格
  • "always" 需要在数组括号内有一个或多个空格或换行符

此规则有一个对象选项用于 "never" 选项的例外情况：

🌐 This rule has an object option for exceptions to the "never" option:

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

此规则有一个对象选项用于 "always" 选项的例外情况：

🌐 This rule has an object option for exceptions to the "always" option:

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

此规则具有内置例外：

🌐 This rule has built-in exceptions:

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

never

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

🌐 Examples of incorrect code for this rule with the default "never" option:

在线运行 
/*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;

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

🌐 Examples of correct code for this rule with the default "never" option:

在线运行 
/*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;

always

使用 "always" 选项时违反此规则的错误代码示例：

🌐 Examples of incorrect code for this rule with the "always" option:

在线运行 
/*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;

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

🌐 Examples of correct code for this rule with the "always" option:

在线运行 
/*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;

singleValue

使用 "always", { "singleValue": false } 选项时违反此规则的错误代码示例：

🌐 Examples of incorrect code for this rule with the "always", { "singleValue": false } options:

在线运行 
/*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' } ];

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

🌐 Examples of correct code for this rule with the "always", { "singleValue": false } options:

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

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

objectsInArrays

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

🌐 Examples of incorrect code for this rule with the "always", { "objectsInArrays": false } options:

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

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

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

🌐 Examples of correct code for this rule with the "always", { "objectsInArrays": false } options:

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

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

arraysInArrays

使用 "always", { "arraysInArrays": false } 选项时违反此规则的错误代码示例：

🌐 Examples of incorrect code for this rule with the "always", { "arraysInArrays": false } options:

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

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

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

🌐 Examples of correct code for this rule with the "always", { "arraysInArrays": false } options:

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

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

何时不使用

🌐 When Not To Use It

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

🌐 You can turn this rule off if you are not concerned with the consistency of spacing between array brackets.

版本

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

资源