版本

generator-star-spacing

强制生成器函数中 * 运算符周围的统一间距

🔧 可修复

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

重要提示

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

了解更多

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

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

function* generator() {
    yield "44";
    yield "55";
}

这也是有效的

function *generator() {
    yield "44";
    yield "55";
}

这同样有效

function * generator() {
    yield "44";
    yield "55";
}

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

规则详情

此规则旨在强制生成器函数的 * 周围的间距。

选项

该规则接受一个选项,一个对象,它有两个键 "before""after",它们的值为布尔值 truefalse

  • "before" 强制 *function 关键字之间的间距。如果为 true,则需要空格,否则不允许空格。

    在对象字面量简写方法中,不检查 * 之前的间距,因为它们缺少 function 关键字。

  • "after" 强制 * 和函数名(或匿名生成器函数的左括号)之间的间距。如果为 true,则需要空格,否则不允许空格。

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

一个示例配置

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

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

  • {"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"]

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

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

一个带有覆盖的配置示例

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

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

示例

之前

使用 "before" 选项时,正确 代码示例

在 Playground 中打开
/*eslint generator-star-spacing: ["error", {"before": true, "after": false}]*/

function *generator() {}

var anonymous = function *() {};

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

之后

使用 "after" 选项时,正确 代码示例

在 Playground 中打开
/*eslint generator-star-spacing: ["error", {"before": false, "after": true}]*/

function* generator() {}

var anonymous = function* () {};

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

两者

使用 "both" 选项时,正确 代码示例

在 Playground 中打开
/*eslint generator-star-spacing: ["error", {"before": true, "after": true}]*/

function * generator() {}

var anonymous = function * () {};

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

两者都不

使用 "neither" 选项时,正确 代码示例

在 Playground 中打开
/*eslint generator-star-spacing: ["error", {"before": false, "after": false}]*/

function*generator() {}

var anonymous = function*() {};

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

存在覆盖时,不正确 代码示例

在 Playground 中打开
/*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() {} }

存在覆盖时,正确 代码示例

在 Playground 中打开
/*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() {} }

何时不使用

如果您的项目不使用生成器,或者您不关心间距一致性,则不需要此规则。

版本

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

延伸阅读

资源

更改语言