no-multi-spaces

Disallow multiple spaces

同一行中存在多个空格且不是用于缩进时，通常是错误的。比如：

if(foo  === "bar") {}

1
2
3

很难说，但在 foo 和 === 之间有两个空格。一般来说，像这样的多个空格是不允许的，而只有一个空格。

if(foo === "bar") {}

1
2
3

规则细节

这条规则的目的是不允许在逻辑表达式、条件表达式、声明、数组元素、对象属性、序列和函数参数周围有多个空格。

使用此规则的错误示例：

/*eslint no-multi-spaces: "error"*/

var a =  1;

if(foo   === "bar") {}

a <<  b

var arr = [1,  2];

a ?  b: c
1
2
3
4
5
6
7
8
9
10
11

使用此规则的正确示例：

/*eslint no-multi-spaces: "error"*/

var a = 1;

if(foo === "bar") {}

a << b

var arr = [1, 2];

a ? b: c
1
2
3
4
5
6
7
8
9
10
11

选项

这个规则的配置由一个具有以下属性的对象组成：

• "ignoreEOLComments": true（默认为 false) 忽略行末出现的注释前的多个空格
• "exceptions": { "Property": true }（"Property" 是默认指定的唯一节点）指定要忽略的节点

ignoreEOLComments

使用此规则与 { "ignoreEOLComments": false }（默认值）选项的错误示例：

/*eslint no-multi-spaces: ["error", { ignoreEOLComments: false }]*/

var x = 5;      // comment
var x = 5;      /* multiline
 * comment
 */
1
2
3
4
5
6

使用此规则与 { "ignoreEOLComments": false }（默认值）选项的正确示例：

/*eslint no-multi-spaces: ["error", { ignoreEOLComments: false }]*/

var x = 5; // comment
var x = 5; /* multiline
 * comment
 */
1
2
3
4
5
6

使用此规则与 { "ignoreEOLComments": true } 选项的正确示例：

/*eslint no-multi-spaces: ["error", { ignoreEOLComments: true }]*/

var x = 5; // comment
var x = 5;      // comment
var x = 5; /* multiline
 * comment
 */
var x = 5;      /* multiline
 * comment
 */
1
2
3
4
5
6
7
8
9
10

exceptions

为了避免与其他需要多个空格的规则相矛盾，该规则有一个 exceptions 选项来忽略某些节点。

这个选项是一个期望属性名是 AST 节点类型的对象，由 ESTree 定义。确定 exceptions 的节点类型的最简单方法是使用 AST Explorer 和 espree 解析器。

只有 Property 节点类型在默认情况下被忽略，因为对于 key-spacing 规则，一些对齐选项需要在对象字面的属性中使用多个空格。

使用默认的 "exceptions": { "Property": true } 选项的正确示例：

/*eslint no-multi-spaces: "error"*/
/*eslint key-spacing: ["error", { align: "value" }]*/

var obj = {
    first:  "first",
    second: "second"
};
1
2
3
4
5
6
7

使用 "exceptions": { "Property": false } 选项的错误示例：

/*eslint no-multi-spaces: ["error", { exceptions: { "Property": false } }]*/
/*eslint key-spacing: ["error", { align: "value" }]*/

var obj = {
    first:  "first",
    second: "second"
};
1
2
3
4
5
6
7

使用 "exceptions": { "BinaryExpression": true } 选项的正确示例：

/*eslint no-multi-spaces: ["error", { exceptions: { "BinaryExpression": true } }]*/

var a = 1  *  2;
1
2
3

使用 "exceptions": { "VariableDeclarator": true } 选项的正确示例：

/*eslint no-multi-spaces: ["error", { exceptions: { "VariableDeclarator": true } }]*/

var someVar      = 'foo';
var someOtherVar = 'barBaz';
1
2
3
4

使用 "exceptions": { "ImportDeclaration": true } 选项的正确示例：

/*eslint no-multi-spaces: ["error", { exceptions: { "ImportDeclaration": true } }]*/

import mod          from 'mod';
import someOtherMod from 'some-other-mod';
1
2
3
4

何时不用

如果你不想检查并禁止存在多个空格，那么你应该关闭此规则。

Related Rules

• key-spacing
• space-infix-ops
• space-in-brackets
• space-in-parens
• space-after-keywords
• space-unary-ops
• space-return-throw-case

Version

This rule was introduced in ESLint v0.9.0.

Resources

• Rule source
• Tests source