Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
309 lines (229 sloc) 7.34 KB

space-in-brackets: enforce consistent spacing inside braces of object literals and brackets of array literals

(removed) This rule was removed in ESLint v1.0 and replaced by the object-curly-spacing and array-bracket-spacing rules.

While formatting preferences are very personal, a number of style guides require or disallow spaces between brackets:

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

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

Rule Details

This rule aims to maintain consistency around the spacing inside of square brackets, either by disallowing spaces inside of brackets between the brackets and other tokens or enforcing spaces. Brackets that are separated from the adjacent value by a new line are excepted from this rule, as this is a common pattern. Object literals that are used as the first or last element in an array are also ignored.

Options

There are two options for this rule:

  • "always" enforces a space inside of object and array literals
  • "never" enforces zero spaces inside of object and array literals (default)

Depending on your coding conventions, you can choose either option by specifying it in your configuration:

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

"never"

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

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

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

// 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"

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

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

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

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

Note that "always" has a special case where {} and [] are not considered problems.

Exceptions

An object literal may be used as a third array item to specify spacing exceptions. These exceptions work in the context of the first option. That is, if "always" is set to enforce spacing and an exception is set to false, it will disallow spacing for cases matching the exception. Likewise, if "never" is set to disallow spacing and an exception is set to true, it will enforce spacing for cases matching the exception.

You can add exceptions like so:

In case of "always" option, set an exception to false to enable it:

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

In case of "never" option, set an exception to true to enable it:

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

The following exceptions are available:

  • singleValue sets the spacing of a single value inside of square brackets of an array.
  • objectsInArrays sets the spacings between the curly braces and square brackets of object literals that are the first or last element in an array.
  • arraysInArrays sets the spacing between the square brackets of array literals that are the first or last element in an array.
  • arraysInObjects sets the spacing between the square bracket and the curly brace of an array literal that is the last element in an object.
  • objectsInObjects sets the spacing between the curly brace of an object literal that is the last element in an object and the curly brace of the containing object.
  • propertyName sets the spacing in square brackets of computed member expressions.

In each of the following examples, the "always" option is assumed.

Examples of incorrect code for this rule when "singleValue" is set to 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' } ];

Examples of correct code for this rule when "singleValue" is set to false:

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

Examples of incorrect code when "objectsInArrays" is set to false:

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

Examples of correct code when "objectsInArrays" is set to false:

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

Examples of incorrect code when "arraysInArrays" is set to false:

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

Examples of correct code when "arraysInArrays" is set to false:

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

Examples of incorrect code when "arraysInObjects" is set to false:

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

Examples of correct code when "arraysInObjects" is set to false:

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

Examples of incorrect code when "objectsInObjects" is set to false:

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

Examples of correct code when "objectsInObjects" is set to false:

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

Examples of incorrect code when "propertyName" is set to false:

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

Examples of correct code when "propertyName" is set to false:

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

When Not To Use It

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

Related Rules

You can’t perform that action at this time.