enforce consistent indentation (indent)

There are several common guidelines which require specific indentation of nested blocks and statements, like:

function hello(indentSize, type) {
    if (indentSize === 4 && type !== 'tab') {
        console.log('Each next indentation will increase on 4 spaces');
    }
}

These are the most common scenarios recommended in different style guides:

• Two spaces, not longer and no tabs: Google, npm, Node.js, Idiomatic, Felix
• Tabs: jQuery
• Four spaces: Crockford

Rule Details

This rule enforces a consistent indentation style. The default style is 4 spaces.

Options

This rule has a mixed option:

For example, for 2-space indentation:

{
    "indent": ["error", 2]
}

Or for tabbed indentation:

{
    "indent": ["error", "tab"]
}

Examples of incorrect code for this rule with the default options:

/*eslint indent: "error"*/

if (a) {
  b=c;
  function foo(d) {
    e=f;
  }
}

Examples of correct code for this rule with the default options:

/*eslint indent: "error"*/

if (a) {
    b=c;
    function foo(d) {
        e=f;
    }
}

This rule has an object option:

• "SwitchCase" (default: 0) enforces indentation level for case clauses in switch statements
• "VariableDeclarator" (default: 1) enforces indentation level for var declarators; can also take an object to define separate rules for var, let and const declarations.
• "outerIIFEBody" (default: 1) enforces indentation level for file-level IIFEs.
• "MemberExpression" (off by default) enforces indentation level for multi-line property chains (except in variable declarations and assignments)
• "FunctionDeclaration" takes an object to define rules for function declarations.
  • parameters (off by default) enforces indentation level for parameters in a function declaration. This can either be a number indicating indentation level, or the string "first" indicating that all parameters of the declaration must be aligned with the first parameter.
  • body (default: 1) enforces indentation level for the body of a function declaration.
• "FunctionExpression" takes an object to define rules for function expressions.
  • parameters (off by default) enforces indentation level for parameters in a function expression. This can either be a number indicating indentation level, or the string "first" indicating that all parameters of the expression must be aligned with the first parameter.
  • body (default: 1) enforces indentation level for the body of a function expression.
• "CallExpression" takes an object to define rules for function call expressions.
  • arguments (off by default) enforces indentation level for arguments in a call expression. This can either be a number indicating indentation level, or the string "first" indicating that all arguments of the expression must be aligned with the first argument.
• "ArrayExpression" (default: 1) enforces indentation level for elements in arrays. It can also be set to the string "first", indicating that all the elements in the array should be aligned with the first element.
• "ObjectExpression" (default: 1) enforces indentation level for properties in objects. It can be set to the string "first", indicating that all properties in the object should be aligned with the first property.

Level of indentation denotes the multiple of the indent specified. Example:

• Indent of 4 spaces with VariableDeclarator set to 2 will indent the multi-line variable declarations with 8 spaces.
• Indent of 2 spaces with VariableDeclarator set to 2 will indent the multi-line variable declarations with 4 spaces.
• Indent of 2 spaces with VariableDeclarator set to {"var": 2, "let": 2, "const": 3} will indent the multi-line variable declarations with 4 spaces for var and let, 6 spaces for const statements.
• Indent of tab with VariableDeclarator set to 2 will indent the multi-line variable declarations with 2 tabs.
• Indent of 2 spaces with SwitchCase set to 0 will not indent case clauses with respect to switch statements.
• Indent of 2 spaces with SwitchCase set to 1 will indent case clauses with 2 spaces with respect to switch statements.
• Indent of 2 spaces with SwitchCase set to 2 will indent case clauses with 4 spaces with respect to switch statements.
• Indent of tab with SwitchCase set to 2 will indent case clauses with 2 tabs with respect to switch statements.
• Indent of 2 spaces with MemberExpression set to 0 will indent the multi-line property chains with 0 spaces.
• Indent of 2 spaces with MemberExpression set to 1 will indent the multi-line property chains with 2 spaces.
• Indent of 2 spaces with MemberExpression set to 2 will indent the multi-line property chains with 4 spaces.
• Indent of 4 spaces with MemberExpression set to 0 will indent the multi-line property chains with 0 spaces.
• Indent of 4 spaces with MemberExpression set to 1 will indent the multi-line property chains with 4 spaces.
• Indent of 4 spaces with MemberExpression set to 2 will indent the multi-line property chains with 8 spaces.

tab

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

/*eslint indent: ["error", "tab"]*/

if (a) {
     b=c;
function foo(d) {
           e=f;
 }
}

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

/*eslint indent: ["error", "tab"]*/

if (a) {
/*tab*/b=c;
/*tab*/function foo(d) {
/*tab*//*tab*/e=f;
/*tab*/}
}

SwitchCase

Examples of incorrect code for this rule with the 2, { "SwitchCase": 1 } options:

/*eslint indent: ["error", 2, { "SwitchCase": 1 }]*/

switch(a){
case "a":
    break;
case "b":
    break;
}

Examples of correct code for this rule with the 2, { "SwitchCase": 1 } option:

/*eslint indent: ["error", 2, { "SwitchCase": 1 }]*/

switch(a){
  case "a":
    break;
  case "b":
    break;
}

VariableDeclarator

Examples of incorrect code for this rule with the 2, { "VariableDeclarator": 1 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 1 }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
    b = 2,
    c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": 1 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 1 }]*/
/*eslint-env es6*/

var a,
  b,
  c;
let a,
  b,
  c;
const a = 1,
  b = 2,
  c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": 2 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 2 }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
    b = 2,
    c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": { "var": 2, "let": 2, "const": 3 } } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": { "var": 2, "let": 2, "const": 3 } }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
      b = 2,
      c = 3;

outerIIFEBody

Examples of incorrect code for this rule with the options 2, { "outerIIFEBody": 0 }:

/*eslint indent: ["error", 2, { "outerIIFEBody": 0 }]*/

(function() {

  function foo(x) {
    return x + 1;
  }

})();


if(y) {
console.log('foo');
}

Examples of correct code for this rule with the options 2, {"outerIIFEBody": 0}:

/*eslint indent: ["error", 2, { "outerIIFEBody": 0 }]*/

(function() {

function foo(x) {
  return x + 1;
}

})();


if(y) {
   console.log('foo');
}

MemberExpression

Examples of incorrect code for this rule with the 2, { "MemberExpression": 1 } options:

/*eslint indent: ["error", 2, { "MemberExpression": 1 }]*/

foo
.bar
.baz()

Examples of correct code for this rule with the 2, { "MemberExpression": 1 } option:

/*eslint indent: ["error", 2, { "MemberExpression": 1 }]*/

foo
  .bar
  .baz();

// Any indentation is permitted in variable declarations and assignments.
var bip = aardvark.badger
                  .coyote;

FunctionDeclaration

Examples of incorrect code for this rule with the 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }]*/

function foo(bar,
  baz,
  qux) {
    qux();
}

Examples of correct code for this rule with the 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }]*/

function foo(bar,
    baz,
    qux) {
  qux();
}

Examples of incorrect code for this rule with the 2, { "FunctionDeclaration": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionDeclaration": {"parameters": "first"}}]*/

function foo(bar, baz,
  qux, boop) {
  qux();
}

Examples of correct code for this rule with the 2, { "FunctionDeclaration": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionDeclaration": {"parameters": "first"}}]*/

function foo(bar, baz,
             qux, boop) {
  qux();
}

FunctionExpression

Examples of incorrect code for this rule with the 2, { "FunctionExpression": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionExpression": {"body": 1, "parameters": 2} }]*/

var foo = function(bar,
  baz,
  qux) {
    qux();
}

Examples of correct code for this rule with the 2, { "FunctionExpression": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionExpression": {"body": 1, "parameters": 2} }]*/

var foo = function(bar,
    baz,
    qux) {
  qux();
}

Examples of incorrect code for this rule with the 2, { "FunctionExpression": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionExpression": {"parameters": "first"}}]*/

var foo = function(bar, baz,
  qux, boop) {
  qux();
}

Examples of correct code for this rule with the 2, { "FunctionExpression": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionExpression": {"parameters": "first"}}]*/

var foo = function(bar, baz,
                   qux, boop) {
  qux();
}

CallExpression

Examples of incorrect code for this rule with the 2, { "CallExpression": {"arguments": 1} } option:

/*eslint indent: ["error", 2, { "CallExpression": {"arguments": 1} }]*/

foo(bar,
    baz,
      qux
);

Examples of correct code for this rule with the 2, { "CallExpression": {"arguments": 1} } option:

/*eslint indent: ["error", 2, { "CallExpression": {"arguments": 1} }]*/

foo(bar,
  baz,
  qux
);

Examples of incorrect code for this rule with the 2, { "CallExpression": {"arguments": "first"} } option:

/*eslint indent: ["error", 2, {"CallExpression": {"arguments": "first"}}]*/

foo(bar, baz,
  baz, boop, beep);

Examples of correct code for this rule with the 2, { "CallExpression": {"arguments": "first"} } option:

/*eslint indent: ["error", 2, {"CallExpression": {"arguments": "first"}}]*/

foo(bar, baz,
    baz, boop, beep);

ArrayExpression

Examples of incorrect code for this rule with the 2, { "ArrayExpression": 1 } option:

/*eslint indent: ["error", 2, { "ArrayExpression": 1 }]*/

var foo = [
    bar,
baz,
      qux
];

Examples of correct code for this rule with the 2, { "ArrayExpression": 1 } option:

/*eslint indent: ["error", 2, { "ArrayExpression": 1 }]*/

var foo = [
  bar,
  baz,
  qux
];

Examples of incorrect code for this rule with the 2, { "ArrayExpression": "first" } option:

/*eslint indent: ["error", 2, {"ArrayExpression": "first"}]*/

var foo = [bar,
  baz,
  qux
];

Examples of correct code for this rule with the 2, { "ArrayExpression": "first" } option:

/*eslint indent: ["error", 2, {"ArrayExpression": "first"}]*/

var foo = [bar,
           baz,
           qux
];

ObjectExpression

Examples of incorrect code for this rule with the 2, { "ObjectExpression": 1 } option:

/*eslint indent: ["error", 2, { "ObjectExpression": 1 }]*/

var foo = {
    bar: 1,
baz: 2,
      qux: 3
};

Examples of correct code for this rule with the 2, { "ObjectExpression": 1 } option:

/*eslint indent: ["error", 2, { "ObjectExpression": 1 }]*/

var foo = {
  bar: 1,
  baz: 2,
  qux: 3
};

Examples of incorrect code for this rule with the 2, { "ObjectExpression": "first" } option:

/*eslint indent: ["error", 2, {"ObjectExpression": "first"}]*/

var foo = { bar: 1,
  baz: 2 };

Examples of correct code for this rule with the 2, { "ObjectExpression": "first" } option:

/*eslint indent: ["error", 2, {"ObjectExpression": "first"}]*/

var foo = { bar: 1,
            baz: 2 };

Compatibility

• JSHint: indent
• JSCS: validateIndentation Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

enforce consistent indentation (indent)

There are several common guidelines which require specific indentation of nested blocks and statements, like:

function hello(indentSize, type) {
    if (indentSize === 4 && type !== 'tab') {
        console.log('Each next indentation will increase on 4 spaces');
    }
}

These are the most common scenarios recommended in different style guides:

• Two spaces, not longer and no tabs: Google, npm, Node.js, Idiomatic, Felix
• Tabs: jQuery
• Four spaces: Crockford

Rule Details

This rule enforces a consistent indentation style. The default style is 4 spaces.

Options

This rule has a mixed option:

For example, for 2-space indentation:

{
    "indent": ["error", 2]
}

Or for tabbed indentation:

{
    "indent": ["error", "tab"]
}

Examples of incorrect code for this rule with the default options:

/*eslint indent: "error"*/

if (a) {
  b=c;
  function foo(d) {
    e=f;
  }
}

Examples of correct code for this rule with the default options:

/*eslint indent: "error"*/

if (a) {
    b=c;
    function foo(d) {
        e=f;
    }
}

This rule has an object option:

• "SwitchCase" (default: 0) enforces indentation level for case clauses in switch statements
• "VariableDeclarator" (default: 1) enforces indentation level for var declarators; can also take an object to define separate rules for var, let and const declarations.
• "outerIIFEBody" (default: 1) enforces indentation level for file-level IIFEs.
• "MemberExpression" (off by default) enforces indentation level for multi-line property chains (except in variable declarations and assignments)
• "FunctionDeclaration" takes an object to define rules for function declarations.
  • parameters (off by default) enforces indentation level for parameters in a function declaration. This can either be a number indicating indentation level, or the string "first" indicating that all parameters of the declaration must be aligned with the first parameter.
  • body (default: 1) enforces indentation level for the body of a function declaration.
• "FunctionExpression" takes an object to define rules for function expressions.
  • parameters (off by default) enforces indentation level for parameters in a function expression. This can either be a number indicating indentation level, or the string "first" indicating that all parameters of the expression must be aligned with the first parameter.
  • body (default: 1) enforces indentation level for the body of a function expression.
• "CallExpression" takes an object to define rules for function call expressions.
  • arguments (off by default) enforces indentation level for arguments in a call expression. This can either be a number indicating indentation level, or the string "first" indicating that all arguments of the expression must be aligned with the first argument.
• "ArrayExpression" (default: 1) enforces indentation level for elements in arrays. It can also be set to the string "first", indicating that all the elements in the array should be aligned with the first element.
• "ObjectExpression" (default: 1) enforces indentation level for properties in objects. It can be set to the string "first", indicating that all properties in the object should be aligned with the first property.

Level of indentation denotes the multiple of the indent specified. Example:

• Indent of 4 spaces with VariableDeclarator set to 2 will indent the multi-line variable declarations with 8 spaces.
• Indent of 2 spaces with VariableDeclarator set to 2 will indent the multi-line variable declarations with 4 spaces.
• Indent of 2 spaces with VariableDeclarator set to {"var": 2, "let": 2, "const": 3} will indent the multi-line variable declarations with 4 spaces for var and let, 6 spaces for const statements.
• Indent of tab with VariableDeclarator set to 2 will indent the multi-line variable declarations with 2 tabs.
• Indent of 2 spaces with SwitchCase set to 0 will not indent case clauses with respect to switch statements.
• Indent of 2 spaces with SwitchCase set to 1 will indent case clauses with 2 spaces with respect to switch statements.
• Indent of 2 spaces with SwitchCase set to 2 will indent case clauses with 4 spaces with respect to switch statements.
• Indent of tab with SwitchCase set to 2 will indent case clauses with 2 tabs with respect to switch statements.
• Indent of 2 spaces with MemberExpression set to 0 will indent the multi-line property chains with 0 spaces.
• Indent of 2 spaces with MemberExpression set to 1 will indent the multi-line property chains with 2 spaces.
• Indent of 2 spaces with MemberExpression set to 2 will indent the multi-line property chains with 4 spaces.
• Indent of 4 spaces with MemberExpression set to 0 will indent the multi-line property chains with 0 spaces.
• Indent of 4 spaces with MemberExpression set to 1 will indent the multi-line property chains with 4 spaces.
• Indent of 4 spaces with MemberExpression set to 2 will indent the multi-line property chains with 8 spaces.

tab

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

/*eslint indent: ["error", "tab"]*/

if (a) {
     b=c;
function foo(d) {
           e=f;
 }
}

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

/*eslint indent: ["error", "tab"]*/

if (a) {
/*tab*/b=c;
/*tab*/function foo(d) {
/*tab*//*tab*/e=f;
/*tab*/}
}

SwitchCase

Examples of incorrect code for this rule with the 2, { "SwitchCase": 1 } options:

/*eslint indent: ["error", 2, { "SwitchCase": 1 }]*/

switch(a){
case "a":
    break;
case "b":
    break;
}

Examples of correct code for this rule with the 2, { "SwitchCase": 1 } option:

/*eslint indent: ["error", 2, { "SwitchCase": 1 }]*/

switch(a){
  case "a":
    break;
  case "b":
    break;
}

VariableDeclarator

Examples of incorrect code for this rule with the 2, { "VariableDeclarator": 1 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 1 }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
    b = 2,
    c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": 1 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 1 }]*/
/*eslint-env es6*/

var a,
  b,
  c;
let a,
  b,
  c;
const a = 1,
  b = 2,
  c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": 2 } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": 2 }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
    b = 2,
    c = 3;

Examples of correct code for this rule with the 2, { "VariableDeclarator": { "var": 2, "let": 2, "const": 3 } } options:

/*eslint indent: ["error", 2, { "VariableDeclarator": { "var": 2, "let": 2, "const": 3 } }]*/
/*eslint-env es6*/

var a,
    b,
    c;
let a,
    b,
    c;
const a = 1,
      b = 2,
      c = 3;

outerIIFEBody

Examples of incorrect code for this rule with the options 2, { "outerIIFEBody": 0 }:

/*eslint indent: ["error", 2, { "outerIIFEBody": 0 }]*/

(function() {

  function foo(x) {
    return x + 1;
  }

})();


if(y) {
console.log('foo');
}

Examples of correct code for this rule with the options 2, {"outerIIFEBody": 0}:

/*eslint indent: ["error", 2, { "outerIIFEBody": 0 }]*/

(function() {

function foo(x) {
  return x + 1;
}

})();


if(y) {
   console.log('foo');
}

MemberExpression

Examples of incorrect code for this rule with the 2, { "MemberExpression": 1 } options:

/*eslint indent: ["error", 2, { "MemberExpression": 1 }]*/

foo
.bar
.baz()

Examples of correct code for this rule with the 2, { "MemberExpression": 1 } option:

/*eslint indent: ["error", 2, { "MemberExpression": 1 }]*/

foo
  .bar
  .baz();

// Any indentation is permitted in variable declarations and assignments.
var bip = aardvark.badger
                  .coyote;

FunctionDeclaration

Examples of incorrect code for this rule with the 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }]*/

function foo(bar,
  baz,
  qux) {
    qux();
}

Examples of correct code for this rule with the 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }]*/

function foo(bar,
    baz,
    qux) {
  qux();
}

Examples of incorrect code for this rule with the 2, { "FunctionDeclaration": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionDeclaration": {"parameters": "first"}}]*/

function foo(bar, baz,
  qux, boop) {
  qux();
}

Examples of correct code for this rule with the 2, { "FunctionDeclaration": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionDeclaration": {"parameters": "first"}}]*/

function foo(bar, baz,
             qux, boop) {
  qux();
}

FunctionExpression

Examples of incorrect code for this rule with the 2, { "FunctionExpression": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionExpression": {"body": 1, "parameters": 2} }]*/

var foo = function(bar,
  baz,
  qux) {
    qux();
}

Examples of correct code for this rule with the 2, { "FunctionExpression": {"body": 1, "parameters": 2} } option:

/*eslint indent: ["error", 2, { "FunctionExpression": {"body": 1, "parameters": 2} }]*/

var foo = function(bar,
    baz,
    qux) {
  qux();
}

Examples of incorrect code for this rule with the 2, { "FunctionExpression": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionExpression": {"parameters": "first"}}]*/

var foo = function(bar, baz,
  qux, boop) {
  qux();
}

Examples of correct code for this rule with the 2, { "FunctionExpression": {"parameters": "first"} } option:

/*eslint indent: ["error", 2, {"FunctionExpression": {"parameters": "first"}}]*/

var foo = function(bar, baz,
                   qux, boop) {
  qux();
}

CallExpression

Examples of incorrect code for this rule with the 2, { "CallExpression": {"arguments": 1} } option:

/*eslint indent: ["error", 2, { "CallExpression": {"arguments": 1} }]*/

foo(bar,
    baz,
      qux
);

Examples of correct code for this rule with the 2, { "CallExpression": {"arguments": 1} } option:

/*eslint indent: ["error", 2, { "CallExpression": {"arguments": 1} }]*/

foo(bar,
  baz,
  qux
);

Examples of incorrect code for this rule with the 2, { "CallExpression": {"arguments": "first"} } option:

/*eslint indent: ["error", 2, {"CallExpression": {"arguments": "first"}}]*/

foo(bar, baz,
  baz, boop, beep);

Examples of correct code for this rule with the 2, { "CallExpression": {"arguments": "first"} } option:

/*eslint indent: ["error", 2, {"CallExpression": {"arguments": "first"}}]*/

foo(bar, baz,
    baz, boop, beep);

ArrayExpression

Examples of incorrect code for this rule with the 2, { "ArrayExpression": 1 } option:

/*eslint indent: ["error", 2, { "ArrayExpression": 1 }]*/

var foo = [
    bar,
baz,
      qux
];

Examples of correct code for this rule with the 2, { "ArrayExpression": 1 } option:

/*eslint indent: ["error", 2, { "ArrayExpression": 1 }]*/

var foo = [
  bar,
  baz,
  qux
];

Examples of incorrect code for this rule with the 2, { "ArrayExpression": "first" } option:

/*eslint indent: ["error", 2, {"ArrayExpression": "first"}]*/

var foo = [bar,
  baz,
  qux
];

Examples of correct code for this rule with the 2, { "ArrayExpression": "first" } option:

/*eslint indent: ["error", 2, {"ArrayExpression": "first"}]*/

var foo = [bar,
           baz,
           qux
];

ObjectExpression

Examples of incorrect code for this rule with the 2, { "ObjectExpression": 1 } option:

/*eslint indent: ["error", 2, { "ObjectExpression": 1 }]*/

var foo = {
    bar: 1,
baz: 2,
      qux: 3
};

Examples of correct code for this rule with the 2, { "ObjectExpression": 1 } option:

/*eslint indent: ["error", 2, { "ObjectExpression": 1 }]*/

var foo = {
  bar: 1,
  baz: 2,
  qux: 3
};

Examples of incorrect code for this rule with the 2, { "ObjectExpression": "first" } option:

/*eslint indent: ["error", 2, {"ObjectExpression": "first"}]*/

var foo = { bar: 1,
  baz: 2 };

Examples of correct code for this rule with the 2, { "ObjectExpression": "first" } option:

/*eslint indent: ["error", 2, {"ObjectExpression": "first"}]*/

var foo = { bar: 1,
            baz: 2 };

Compatibility

• JSHint: indent
• JSCS: validateIndentation Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Enforce newline before and after dot (dot-location)

JavaScript allows you to place newlines before or after a dot in a member expression.

Consistency in placing a newline before or after the dot can greatly increase readability.

var a = universe.
        galaxy;

var b = universe
       .galaxy;

Rule Details

This rule aims to enforce newline consistency in member expressions. This rule prevents the use of mixed newlines around the dot in a member expression.

Options

The rule takes one option, a string:

• If it is "object", the dot in a member expression should be on the same line as the object portion. The default is "object".
• If it is "property", the dot in a member expression should be on the same line as the property portion.

object

The default "object" option requires the dot to be on the same line as the object.

Examples of incorrect code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object
.property;

Examples of correct code for the default "object" option:

/*eslint dot-location: ["error", "object"]*/

var foo = object.
property;
var bar = object.property;

property

The "property" option requires the dot to be on the same line as the property.

Examples of incorrect code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object.
property;

Examples of correct code for the "property" option:

/*eslint dot-location: ["error", "property"]*/

var foo = object
.property;
var bar = object.property;

When Not To Use It

You can turn this rule off if you are not concerned with the consistency of newlines before or after dots in member expressions.

Related Rules

• [newline-after-var](newline-after-var.md)
• [dot-notation](dot-notation.md) Source: http://eslint.org/docs/rules/

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 95.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

• Extract Method
• Extract Class
• Form Template Method
• Introduce Null Object
• Pull Up Method
• Pull Up Field
• Substitute Algorithm

Further Reading

• Don't Repeat Yourself on the C2 Wiki
• Duplicated Code on SourceMaking
• Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 95.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

• Extract Method
• Extract Class
• Form Template Method
• Introduce Null Object
• Pull Up Method
• Pull Up Field
• Substitute Algorithm

Further Reading

• Don't Repeat Yourself on the C2 Wiki
• Duplicated Code on SourceMaking
• Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

For more information visit Source: http://eslint.org/docs/rules/