keyword-spacing

强制关键字前后保持一致的空格

🔧

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

重要

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

了解更多

关键字是 JavaScript 的语法元素，例如 try 和 if。这些关键字对语言具有特殊意义，因此在代码编辑器中通常以不同的颜色显示。作为语言的重要组成部分，风格指南通常会提及关键字周围应使用的空格。例如，您的风格指南可能规定关键字应始终用空格包围，这意味着 if-else 语句必须如下所示：

if (foo) {
    // ...
} else {
    // ...
}
1
2
3
4
5

当然，您的风格指南也可能不允许关键字周围有空格。

然而，如果您想强制执行 function 关键字和随后的左括号之间的空格风格，请参考 space-before-function-paren。

规则详情

此规则强制关键字和类似关键字的标记周围保持一致的空格：as（在模块声明中）、async（异步函数的）、await（await 表达式的）、break、case、catch、class、const、continue、debugger、default、delete、do、else、export、extends、finally、for、from（在模块声明中）、function、get（getter 的）、if、import、in（在 for-in 语句中）、let、new、of（在 for-of 语句中）、return、set（setter 的）、static、super、switch、this、throw、try、typeof、var、void、while、with 和 yield。此规则经过精心设计，不会与其他空格规则冲突：它不适用于其他规则报告问题的空格。

选项

此规则有一个对象选项

"before": true（默认）要求关键字前至少有一个空格
"before": false 不允许关键字前有空格
"after": true（默认）要求关键字后至少有一个空格
"after": false 不允许关键字后有空格
"overrides" 允许覆盖指定关键字的空格风格

before

使用默认 { "before": true } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "before": true }]*/

if (foo) {
    //...
}else if (bar) {
    //...
}else {
    //...
}
1
2
3
4
5
6
7
8
9

使用默认 { "before": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "before": true }]*/

if (foo) {
    //...
} else if (bar) {
    //...
} else {
    //...
}

// Avoid conflict with `array-bracket-spacing`
let a = [this];
let b = [function() {}];

// Avoid conflict with `arrow-spacing`
let c = ()=> this.foo;

// Avoid conflict with `block-spacing`
{function foo() {}}

// Avoid conflict with `comma-spacing`
let d = [100,this.foo, this.bar];

// Avoid conflict with `computed-property-spacing`
obj[this.foo] = 0;

// Avoid conflict with `generator-star-spacing`
function *bar() {}

// Avoid conflict with `key-spacing`
let obj1 = {
    foo:function() {}
};

// Avoid conflict with `object-curly-spacing`
let obj2 = {foo: this};

// Avoid conflict with `semi-spacing`
let e = this;function foo() {}

// Avoid conflict with `space-in-parens`
(function () {})();

// Avoid conflict with `space-infix-ops`
if ("foo"in {foo: 0}) {}
if (10+this.foo<= this.bar) {}

// Avoid conflict with `jsx-curly-spacing`
let f = <A foo={this.foo} bar={function(){}} />
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

使用 { "before": false } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "before": false }]*/

if (foo) {
    //...
} else if (bar) {
    //...
} else {
    //...
}
1
2
3
4
5
6
7
8
9

使用 { "before": false } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "before": false }]*/

if (foo) {
    //...
}else if (bar) {
    //...
}else {
    //...
}
1
2
3
4
5
6
7
8
9

after

使用默认 { "after": true } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "after": true }]*/

if(foo) {
    //...
} else if(bar) {
    //...
} else{
    //...
}
1
2
3
4
5
6
7
8
9

使用默认 { "after": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "after": true }]*/

if (foo) {
    //...
} else if (bar) {
    //...
} else {
    //...
}

// Avoid conflict with `array-bracket-spacing`
let a = [this];

// Avoid conflict with `arrow-spacing`
let b = ()=> this.foo;

// Avoid conflict with `comma-spacing`
let c = [100, this.foo, this.bar];

// Avoid conflict with `computed-property-spacing`
obj[this.foo] = 0;

// Avoid conflict with `generator-star-spacing`
function* foo() {}

// Avoid conflict with `key-spacing`
let obj1 = {
    foo:function() {}
};

// Avoid conflict with `func-call-spacing`
class A extends B {
    constructor() {
        super();
    }
}

// Avoid conflict with `object-curly-spacing`
let obj2 = {foo: this};

// Avoid conflict with `semi-spacing`
let d = this;function bar() {}

// Avoid conflict with `space-before-function-paren`
(function() {})();

// Avoid conflict with `space-infix-ops`
if ("foo"in{foo: 0}) {}
if (10+this.foo<= this.bar) {}

// Avoid conflict with `space-unary-ops`
function* baz(a) {
    return yield+a;
}

// Avoid conflict with `yield-star-spacing`
function* qux(a) {
    return yield* a;
}

// Avoid conflict with `jsx-curly-spacing`
let e = <A foo={this.foo} bar={function(){}} />
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

使用 { "after": false } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "after": false }]*/

if (foo) {
    //...
} else if (bar) {
    //...
} else {
    //...
}
1
2
3
4
5
6
7
8
9

使用 { "after": false } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "after": false }]*/

if(foo) {
    //...
} else if(bar) {
    //...
} else{
    //...
}
1
2
3
4
5
6
7
8
9

overrides

使用 { "overrides": { "if": { "after": false }, "for": { "after": false }, "while": { "after": false }, "static": { "after": false }, "as": { "after": false } } } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint keyword-spacing: ["error", { "overrides": {
  "if": { "after": false },
  "for": { "after": false },
  "while": { "after": false },
  "static": { "after": false },
  "as": { "after": false }
} }]*/

if(foo) {
    //...
} else if(bar) {
    //...
} else {
    //...
}

for(;;);

while(true) {
    //...
}

class C {
    static{
        //...
    }
}

export { C as"my class" };
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

何时不使用

如果您不想强制关键字空格的一致性，那么禁用此规则是安全的。

版本

此规则在 ESLint v2.0.0-beta.1 中引入。

资源

编辑此页