generator-star-spacing

在生成器函数中强制执行 * 运算符周围的一致空格

🔧

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

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

生成器是 ECMAScript 6 中一种新型函数，可以随着时间的推移返回多个值。这些特殊函数以在 function 关键字后放置一个 * 来表示。

这是一个生成器函数的示例

function* generator() {
    yield "44";
    yield "55";
}
1
2
3
4

这也是有效的

function *generator() {
    yield "44";
    yield "55";
}
1
2
3
4

这也是有效的

function * generator() {
    yield "44";
    yield "55";
}
1
2
3
4

为了在使用生成器时保持一致性，此规则强制执行 * 的唯一位置。

规则细节

此规则旨在强制执行生成器函数的 * 周围的空格。

选项

该规则接受一个选项，一个对象，该对象有两个键 "before" 和 "after"，它们具有布尔值 true 或 false。

"before" 强制执行 * 和 function 关键字之间的空格。如果它是 true，则需要空格，否则不允许空格。

在对象文字简写方法中，不会检查 * 之前的空格，因为它们缺少 function 关键字。
"after" 强制执行 * 和函数名（或匿名生成器函数的左括号）之间的空格。如果它是 true，则需要空格，否则不允许空格。

默认为 {"before": true, "after": false}。

一个配置示例

"generator-star-spacing": ["error", {"before": true, "after": false}]
1

并且该选项具有字符串关键字作为简写形式

{"before": true, "after": false} → "before"
{"before": false, "after": true} → "after"
{"before": true, "after": true} → "both"
{"before": false, "after": false} → "neither"

一个简写配置的示例

"generator-star-spacing": ["error", "after"]
1

此外，此规则允许通过每个函数类型的覆盖进行进一步配置。

named 为命名函数提供覆盖
anonymous 为匿名函数提供覆盖
method 为类方法或属性函数简写提供覆盖

一个带有覆盖的配置示例

"generator-star-spacing": ["error", {
    "before": false,
    "after": true,
    "anonymous": "neither",
    "method": {"before": true, "after": true}
}]
1
2
3
4
5
6

在上面的配置示例中，顶级 "before" 和 "after" 选项定义了规则的默认行为，而 "anonymous" 和 "method" 选项覆盖了默认行为。覆盖可以是具有 "before" 和 "after" 的对象，也可以是上面所示的简写字符串。

示例

之前

使用 "before" 选项的此规则的正确代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {"before": true, "after": false}]*/

function *generator() {}

var anonymous = function *() {};

var shorthand = { *generator() {} };
1
2
3
4
5
6
7

之后

使用 "after" 选项的此规则的正确代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {"before": false, "after": true}]*/

function* generator() {}

var anonymous = function* () {};

var shorthand = { * generator() {} };
1
2
3
4
5
6
7

两者

使用 "both" 选项的此规则的正确代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {"before": true, "after": true}]*/

function * generator() {}

var anonymous = function * () {};

var shorthand = { * generator() {} };
1
2
3
4
5
6
7

都不

使用 "neither" 选项的此规则的正确代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {"before": false, "after": false}]*/

function*generator() {}

var anonymous = function*() {};

var shorthand = { *generator() {} };
1
2
3
4
5
6
7

存在覆盖时此规则的错误代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {
    "before": false,
    "after": true,
    "anonymous": "neither",
    "method": {"before": true, "after": true}
}]*/

function * generator() {}

var anonymous = function* () {};

var shorthand = { *generator() {} };

class Class { static* method() {} }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

存在覆盖时此规则的正确代码示例

在游乐场中打开

/*eslint generator-star-spacing: ["error", {
    "before": false,
    "after": true,
    "anonymous": "neither",
    "method": {"before": true, "after": true}
}]*/

function* generator() {}

var anonymous = function*() {};

var shorthand = { * generator() {} };

class Class { static * method() {} }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

何时不使用它

如果您的项目不会使用生成器，或者您不关心空格一致性，则不需要此规则。

版本

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

进一步阅读

阅读理解 ECMAScript 6 | Leanpub
leanpub.com

资源

编辑此页面