yield-star-spacing

Require or disallow spacing around the * in yield* expressions

🔧

Some problems reported by this rule are automatically fixable by the --fix command line option

This rule was deprecated in ESLint v8.53.0. Please use the corresponding rule in @stylistic/eslint-plugin-js.

Rule Details

This rule enforces spacing around the * in yield* expressions.

The rule takes one option, an object, which has two keys before and after having boolean values true or false.

before enforces spacing between the yield and the *. If true, a space is required, otherwise spaces are disallowed.
after enforces spacing between the * and the argument. If it is true, a space is required, otherwise spaces are disallowed.

The default is {"before": false, "after": true}.

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

The option also has a string shorthand:

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

Examples of correct code for this rule with the default "after" option:

/*eslint yield-star-spacing: ["error", "after"]*/

function* generator() {
  yield* other();
}
1
2
3
4
5

Examples of correct code for this rule with the "before" option:

/*eslint yield-star-spacing: ["error", "before"]*/

function *generator() {
  yield *other();
}
1
2
3
4
5

Examples of correct code for this rule with the "both" option:

/*eslint yield-star-spacing: ["error", "both"]*/

function * generator() {
  yield * other();
}
1
2
3
4
5

Examples of correct code for this rule with the "neither" option:

/*eslint yield-star-spacing: ["error", "neither"]*/

function*generator() {
  yield*other();
}
1
2
3
4
5

If your project will not be using generators or you are not concerned with spacing consistency, you do not need this rule.

This rule was introduced in ESLint v2.0.0-alpha-1.

Edit this page