版本

no-multi-spaces

禁止使用多个空格

🔧 可修复

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

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

行中未使用于缩进的多个空格通常是错误。例如


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

何时不使用它

如果您不想检查和禁止使用多个空格,那么您应该关闭此规则。

版本

此规则是在 ESLint v0.9.0 中引入的。

资源

更改语言