Versions

yield-star-spacing

Require or disallow spacing around the * in yield* expressions

πŸ”§ Fixable

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

Rule Details

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

Options

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}]

The option also has a string shorthand:

  • {"before": false, "after": true} β†’ "after"
  • {"before": true, "after": false} β†’ "before"
  • {"before": true, "after": true} β†’ "both"
  • {"before": false, "after": false} β†’ "neither"
"yield-star-spacing": ["error", "after"]

Examples

after

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

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

function* generator() {
yield* other();
}

before

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

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

function *generator() {
yield *other();
}

both

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

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

function * generator() {
yield * other();
}

neither

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

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

function*generator() {
yield*other();
}

When Not To Use It

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

Version

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

Further Reading

Resources