缩进

强制执行一致的缩进

🔧

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

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

有几个常见的指南需要嵌套块和语句的特定缩进，例如

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

这些是在不同风格指南中推荐的最常见场景

两个空格，不超过且不使用制表符：Google、npm、Node.js、惯用、Felix
制表符：jQuery
四个空格：Crockford

规则详情

此规则强制执行一致的缩进风格。默认风格为 4 个空格。

选项

此规则具有混合选项

例如，对于 2 个空格缩进

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

或者对于制表符缩进

{
    "indent": ["error", "tab"]
}
1
2
3

使用默认选项时，此规则的 **错误** 代码示例

在游乐场中打开

/*eslint indent: "error"*/

if (a) {
  b=c;
  function foo(d) {
    e=f;
  }
}
1
2
3
4
5
6
7
8

使用默认选项时，此规则的 **正确** 代码示例

在游乐场中打开

/*eslint indent: "error"*/

if (a) {
    b=c;
    function foo(d) {
        e=f;
    }
}
1
2
3
4
5
6
7
8

此规则具有对象选项

"ignoredNodes" 可用于禁用任何 AST 节点的缩进检查。这接受一个选择器数组。如果 AST 节点与任何选择器匹配，则该节点的直接子节点的标记缩进将被忽略。如果不同意它对特定语法模式强制执行的缩进，则可以使用它作为一种变通方法来放宽规则。
"SwitchCase"（默认值：0）强制执行 switch 语句中 case 子句的缩进级别
"VariableDeclarator"（默认值：1）强制执行 var 声明符的缩进级别；还可以采用对象来为 var、let 和 const 声明定义单独的规则。它也可以是 "first"，表示所有声明符都应与第一个声明符对齐。
"outerIIFEBody"（默认值：1）强制执行文件级 IIFE 的缩进级别。这也可以设置为 "off" 以禁用对文件级 IIFE 的检查。
"MemberExpression"（默认值：1）强制执行多行属性链的缩进级别。这也可以设置为 "off" 以禁用对 MemberExpression 缩进的检查。
"FunctionDeclaration" 采用对象来定义函数声明的规则。
- parameters（默认值：1）强制执行函数声明中参数的缩进级别。这可以是表示缩进级别的数字，也可以是字符串 "first"，表示声明的所有参数都必须与第一个参数对齐。这也可以设置为 "off" 以禁用对 FunctionDeclaration 参数的检查。
- body（默认值：1）强制执行函数声明主体部分的缩进级别。
"FunctionExpression" 采用对象来定义函数表达式的规则。
- parameters（默认值：1）强制执行函数表达式中参数的缩进级别。这可以是表示缩进级别的数字，也可以是字符串 "first"，表示表达式的所有参数都必须与第一个参数对齐。这也可以设置为 "off" 以禁用对 FunctionExpression 参数的检查。
- body（默认值：1）强制执行函数表达式主体部分的缩进级别。
"StaticBlock" 采用对象来定义类静态块的规则。
- body（默认值：1）强制执行类静态块主体部分的缩进级别。
"CallExpression" 采用对象来定义函数调用表达式的规则。
- arguments（默认值：1）强制执行调用表达式中参数的缩进级别。这可以是表示缩进级别的数字，也可以是字符串 "first"，表示表达式的所有参数都必须与第一个参数对齐。这也可以设置为 "off" 以禁用对 CallExpression 参数的检查。
"ArrayExpression"（默认值：1）强制执行数组中元素的缩进级别。它也可以设置为字符串 "first"，表示数组中的所有元素都应与第一个元素对齐。这也可以设置为 "off" 以禁用对数组元素的检查。
"ObjectExpression"（默认值：1）强制执行对象中属性的缩进级别。它可以设置为字符串 "first"，表示对象中的所有属性都应与第一个属性对齐。这也可以设置为 "off" 以禁用对对象属性的检查。
"ImportDeclaration"（默认值：1）强制执行导入语句的缩进级别。它可以设置为字符串 "first"，表示来自模块的所有导入成员都应与列表中的第一个成员对齐。这也可以设置为 "off" 以禁用对导入模块成员的检查。
"flatTernaryExpressions": true（默认值为 false）不需要缩进嵌套在其他三元表达式中的三元表达式。
"offsetTernaryExpressions": true（默认值为 false）要求缩进三元表达式的值。
"ignoreComments"（默认值：false）可以在不需要将注释与前一行或下一行上的节点对齐时使用。

缩进级别表示缩进倍数。例子

缩进 4 个空格，并将 VariableDeclarator 设置为 2 将使多行变量声明缩进 8 个空格。
缩进 2 个空格，并将 VariableDeclarator 设置为 2 将使多行变量声明缩进 4 个空格。
缩进 2 个空格，并将 VariableDeclarator 设置为 {"var": 2, "let": 2, "const": 3} 将使 var 和 let 的多行变量声明缩进 4 个空格，const 语句缩进 6 个空格。
缩进制表符，并将 VariableDeclarator 设置为 2 将使多行变量声明缩进 2 个制表符。
缩进 2 个空格，并将 SwitchCase 设置为 0 将不会相对于 switch 语句缩进 case 子句。
缩进 2 个空格，并将 SwitchCase 设置为 1 将相对于 switch 语句缩进 case 子句 2 个空格。
缩进 2 个空格，并将 SwitchCase 设置为 2 将相对于 switch 语句缩进 case 子句 4 个空格。
缩进制表符，并将 SwitchCase 设置为 2 将相对于 switch 语句缩进 case 子句 2 个制表符。
缩进 2 个空格，并将 MemberExpression 设置为 0 将使多行属性链缩进 0 个空格。
缩进 2 个空格，并将 MemberExpression 设置为 1 将使多行属性链缩进 2 个空格。
缩进 2 个空格，并将 MemberExpression 设置为 2 将使多行属性链缩进 4 个空格。
缩进 4 个空格，并将 MemberExpression 设置为 0 将使多行属性链缩进 0 个空格。
缩进 4 个空格，并将 MemberExpression 设置为 1 将使多行属性链缩进 4 个空格。
缩进 4 个空格，并将 MemberExpression 设置为 2 将使多行属性链缩进 8 个空格。

制表符

使用 "tab" 选项时，此规则的 **错误** 代码示例

在游乐场中打开

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

if (a) {
     b=c;
function foo(d) {
           e=f;
 }
}
1
2
3
4
5
6
7
8

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

在游乐场中打开

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

if (a) {
	b=c;
	function foo(d) {
		e=f;
	}
}
1
2
3
4
5
6
7
8

ignoredNodes

以下配置忽略 ConditionalExpression（“三元表达式”）节点的缩进

使用 4, { "ignoredNodes": ["ConditionalExpression"] } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ignoredNodes": ["ConditionalExpression"] }]*/

var a = foo
      ? bar
      : baz;

var a = foo
                ? bar
: baz;
1
2
3
4
5
6
7
8
9

以下配置忽略 IIFE 主体部分的缩进。

使用 4, { "ignoredNodes": ["CallExpression > FunctionExpression.callee > BlockStatement.body"] } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ignoredNodes": ["CallExpression > FunctionExpression.callee > BlockStatement.body"] }]*/

(function() {

foo();
bar();

})();
1
2
3
4
5
6
7
8

所有 AST 节点类型都可以在 ESTree 规范中找到。您可以使用 AST Explorer 和 espree 解析器来检查代码片段的 AST 树。

SwitchCase

使用 2, { "SwitchCase": 1 } 选项时，此规则的 **错误** 代码示例

在游乐场中打开

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

switch(a){
case "a":
    break;
case "b":
    break;
}
1
2
3
4
5
6
7
8

使用 2, { "SwitchCase": 1 } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

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

switch(a){
  case "a":
    break;
  case "b":
    break;
}
1
2
3
4
5
6
7
8

VariableDeclarator

使用 2, { "VariableDeclarator": 1 } 选项时，此规则的 **错误** 代码示例

在游乐场中打开

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

var a,
    b,
    c;
let d,
    e,
    f;
const g = 1,
    h = 2,
    i = 3;
1
2
3
4
5
6
7
8
9
10
11

使用 2, { "VariableDeclarator": 1 } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

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

var a,
  b,
  c;
let d,
  e,
  f;
const g = 1,
  h = 2,
  i = 3;
1
2
3
4
5
6
7
8
9
10
11

使用 2, { "VariableDeclarator": 2 } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

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

var a,
    b,
    c;
let d,
    e,
    f;
const g = 1,
    h = 2,
    i = 3;
1
2
3
4
5
6
7
8
9
10
11

使用 2, { "VariableDeclarator": "first" } 选项时，此规则的 **错误** 代码示例

在游乐场中打开

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

var a,
  b,
  c;
let d,
  e,
  f;
const g = 1,
  h = 2,
  i = 3;
1
2
3
4
5
6
7
8
9
10
11

使用 2, { "VariableDeclarator": "first" } 选项时，此规则的 **正确** 代码示例

在游乐场中打开

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

var a,
    b,
    c;
let d,
    e,
    f;
const g = 1,
      h = 2,
      i = 3;
1
2
3
4
5
6
7
8
9
10
11

此规则使用2, { "VariableDeclarator": { "var": 2, "let": 2, "const": 3 } }选项的正确代码示例

在游乐场中打开

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

var a,
    b,
    c;
let d,
    e,
    f;
const g = 1,
      h = 2,
      i = 3;
1
2
3
4
5
6
7
8
9
10
11

outerIIFEBody

此规则使用2, { "outerIIFEBody": 0 }选项的错误代码示例

在游乐场中打开

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

(function() {

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

})();

if (y) {
console.log('foo');
}
1
2
3
4
5
6
7
8
9
10
11
12
13

此规则使用2, { "outerIIFEBody": 0 }选项的正确代码示例

在游乐场中打开

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

(function() {

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

})();

if (y) {
  console.log('foo');
}
1
2
3
4
5
6
7
8
9
10
11
12
13

此规则使用2, { "outerIIFEBody": "off" }选项的正确代码示例

在游乐场中打开

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

(function() {

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

})();

(function() {

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

})();

if (y) {
  console.log('foo');
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

MemberExpression

此规则使用2, { "MemberExpression": 1 }选项的错误代码示例

在游乐场中打开

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

foo
.bar
.baz()
1
2
3
4
5

此规则使用2, { "MemberExpression": 1 }选项的正确代码示例

在游乐场中打开

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

foo
  .bar
  .baz();
1
2
3
4
5

FunctionDeclaration

此规则使用2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }选项的错误代码示例

在游乐场中打开

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

function foo(bar,
  baz,
  qux) {
    qux();
}
1
2
3
4
5
6
7

此规则使用2, { "FunctionDeclaration": {"body": 1, "parameters": 2} }选项的正确代码示例

在游乐场中打开

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

function foo(bar,
    baz,
    qux) {
  qux();
}
1
2
3
4
5
6
7

此规则使用2, { "FunctionDeclaration": {"parameters": "first"} }选项的错误代码示例

在游乐场中打开

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

function foo(bar, baz,
  qux, boop) {
  qux();
}
1
2
3
4
5
6

此规则使用2, { "FunctionDeclaration": {"parameters": "first"} }选项的正确代码示例

在游乐场中打开

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

function foo(bar, baz,
             qux, boop) {
  qux();
}
1
2
3
4
5
6

FunctionExpression

此规则使用2, { "FunctionExpression": {"body": 1, "parameters": 2} }选项的错误代码示例

在游乐场中打开

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

var foo = function(bar,
  baz,
  qux) {
    qux();
}
1
2
3
4
5
6
7

此规则使用2, { "FunctionExpression": {"body": 1, "parameters": 2} }选项的正确代码示例

在游乐场中打开

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

var foo = function(bar,
    baz,
    qux) {
  qux();
}
1
2
3
4
5
6
7

此规则使用2, { "FunctionExpression": {"parameters": "first"} }选项的错误代码示例

在游乐场中打开

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

var foo = function(bar, baz,
  qux, boop) {
  qux();
}
1
2
3
4
5
6

此规则使用2, { "FunctionExpression": {"parameters": "first"} }选项的正确代码示例

在游乐场中打开

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

var foo = function(bar, baz,
                   qux, boop) {
  qux();
}
1
2
3
4
5
6

StaticBlock

此规则使用2, { "StaticBlock": {"body": 1} }选项的错误代码示例

在游乐场中打开

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

class C {
  static {
      foo();
  }
}
1
2
3
4
5
6
7

此规则使用2, { "StaticBlock": {"body": 1} }选项的正确代码示例

在游乐场中打开

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

class C {
  static {
    foo();
  }
}
1
2
3
4
5
6
7

此规则使用2, { "StaticBlock": {"body": 2} }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "StaticBlock": {"body": 2} }]*/

class C {
  static {
    foo();
  }
}
1
2
3
4
5
6
7

此规则使用2, { "StaticBlock": {"body": 2} }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "StaticBlock": {"body": 2} }]*/

class C {
  static {
      foo();
  }
}
1
2
3
4
5
6
7

CallExpression

此规则使用2, { "CallExpression": {"arguments": 1} }选项的错误代码示例

在游乐场中打开

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

foo(bar,
    baz,
      qux
);
1
2
3
4
5
6

此规则使用2, { "CallExpression": {"arguments": 1} }选项的正确代码示例

在游乐场中打开

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

foo(bar,
  baz,
  qux
);
1
2
3
4
5
6

此规则使用2, { "CallExpression": {"arguments": "first"} }选项的错误代码示例

在游乐场中打开

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

foo(bar, baz,
  baz, boop, beep);
1
2
3
4

此规则使用2, { "CallExpression": {"arguments": "first"} }选项的正确代码示例

在游乐场中打开

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

foo(bar, baz,
    baz, boop, beep);
1
2
3
4

ArrayExpression

此规则使用2, { "ArrayExpression": 1 }选项的错误代码示例

在游乐场中打开

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

var foo = [
    bar,
baz,
      qux
];
1
2
3
4
5
6
7

此规则使用2, { "ArrayExpression": 1 }选项的正确代码示例

在游乐场中打开

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

var foo = [
  bar,
  baz,
  qux
];
1
2
3
4
5
6
7

此规则使用2, { "ArrayExpression": "first" }选项的错误代码示例

在游乐场中打开

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

var foo = [bar,
  baz,
  qux
];
1
2
3
4
5
6

此规则使用2, { "ArrayExpression": "first" }选项的正确代码示例

在游乐场中打开

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

var foo = [bar,
           baz,
           qux
];
1
2
3
4
5
6

ObjectExpression

此规则使用2, { "ObjectExpression": 1 }选项的错误代码示例

在游乐场中打开

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

var foo = {
    bar: 1,
baz: 2,
      qux: 3
};
1
2
3
4
5
6
7

此规则使用2, { "ObjectExpression": 1 }选项的正确代码示例

在游乐场中打开

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

var foo = {
  bar: 1,
  baz: 2,
  qux: 3
};
1
2
3
4
5
6
7

此规则使用2, { "ObjectExpression": "first" }选项的错误代码示例

在游乐场中打开

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

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

此规则使用2, { "ObjectExpression": "first" }选项的正确代码示例

在游乐场中打开

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

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

ImportDeclaration

此规则使用4, { "ImportDeclaration": 1 }选项（默认值）的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ImportDeclaration": 1 }]*/

import { foo,
    bar,
    baz,
} from 'qux';
1
2
3
4
5
6

在游乐场中打开

/*eslint indent: ["error", 4, { "ImportDeclaration": 1 }]*/

import {
    foo,
    bar,
    baz,
} from 'qux';
1
2
3
4
5
6
7

此规则使用4, { "ImportDeclaration": "first" }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ImportDeclaration": "first" }]*/

import { foo,
    bar,
    baz,
} from 'qux';
1
2
3
4
5
6

此规则使用4, { "ImportDeclaration": "first" }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ImportDeclaration": "first" }]*/

import { foo,
         bar,
         baz,
} from 'qux';
1
2
3
4
5
6

flatTernaryExpressions

此规则使用默认4, { "flatTernaryExpressions": false }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "flatTernaryExpressions": false }]*/

var a =
    foo ? bar :
    baz ? qux :
    boop;
1
2
3
4
5
6

此规则使用默认4, { "flatTernaryExpressions": false }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "flatTernaryExpressions": false }]*/

var a =
    foo ? bar :
        baz ? qux :
            boop;
1
2
3
4
5
6

此规则使用4, { "flatTernaryExpressions": true }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "flatTernaryExpressions": true }]*/

var a =
    foo ? bar :
        baz ? qux :
            boop;
1
2
3
4
5
6

此规则使用4, { "flatTernaryExpressions": true }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "flatTernaryExpressions": true }]*/

var a =
    foo ? bar :
    baz ? qux :
    boop;
1
2
3
4
5
6

offsetTernaryExpressions

此规则使用默认2, { "offsetTernaryExpressions": false }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "offsetTernaryExpressions": false }]*/

condition
  ? () => {
      return true
    }
  : () => {
      false
    }
1
2
3
4
5
6
7
8
9

此规则使用默认2, { "offsetTernaryExpressions": false }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "offsetTernaryExpressions": false }]*/

condition
  ? () => {
    return true
  }
  : condition2
    ? () => {
      return true
    }
    : () => {
      return false
    }
1
2
3
4
5
6
7
8
9
10
11
12
13

此规则使用2, { "offsetTernaryExpressions": true }选项的错误代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "offsetTernaryExpressions": true }]*/

condition
  ? () => {
    return true
  }
  : condition2
    ? () => {
      return true
    }
    : () => {
      return false
    }
1
2
3
4
5
6
7
8
9
10
11
12
13

此规则使用2, { "offsetTernaryExpressions": true }选项的正确代码示例

在游乐场中打开

/*eslint indent: ["error", 2, { "offsetTernaryExpressions": true }]*/

condition
  ? () => {
      return true
    }
  : condition2
    ? () => {
        return true
      }
    : () => {
        return false
      }
1
2
3
4
5
6
7
8
9
10
11
12
13

ignoreComments

此规则使用4, { "ignoreComments": true }选项的其他正确代码示例

在游乐场中打开

/*eslint indent: ["error", 4, { "ignoreComments": true }] */

if (foo) {
    doSomething();

// comment intentionally de-indented
    doSomethingElse();
}
1
2
3
4
5
6
7
8

兼容性

JSHint: indent
JSCS: validateIndentation

版本

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

资源

编辑此页面