no-multi-spaces

禁止多个空格

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

一行中的多个不用于缩进的空格通常是错误的。例如：

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

很难说，但是 foo 和 === 之间有两个空格。像这样的多个空格通常不赞成单个空格：

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

规则详情

该规则旨在禁止在逻辑表达式、条件表达式、声明、数组元素、对象属性、序列和函数参数周围出现多个空格。

此规则的错误代码示例：

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

var a =  1;

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

a <<  b

var arr = [1,  2];

a ?  b: c

此规则的正确代码示例：

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

var a = 1;

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

a << b

var arr = [1, 2];

a ? b: c

选项

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

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

带有 { "ignoreEOLComments": false }（默认）选项的此规则的正确代码示例：

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

var x = 5; // comment
var x = 5; /* multiline
 * comment
 */

此规则使用 { "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
 */

exceptions

为避免与其他需要多个空格的规则发生冲突，此规则有一个 exceptions 选项来忽略某些节点。

此选项是一个对象，它期望属性名称是 ESTree 定义的 AST 节点类型。确定 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"
};

"exceptions": { "Property": false } 选项的错误代码示例：

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

var obj = {
    first:  "first",
    second: "second"
};

"exceptions": { "BinaryExpression": true } 选项的正确代码示例：

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

var a = 1  *  2;

"exceptions": { "VariableDeclarator": true } 选项的正确代码示例：

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

var someVar      = 'foo';
var someOtherVar = 'barBaz';

"exceptions": { "ImportDeclaration": true } 选项的正确代码示例：

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

import mod          from 'mod';
import someOtherMod from 'some-other-mod';

何时不使用

如果您不想检查并禁止多个空格，则应关闭此规则。