2 * @fileoverview Rule to check the spacing around the * in yield* expressions.
8 //------------------------------------------------------------------------------
10 //------------------------------------------------------------------------------
17 description: "require or disallow spacing around the `*` in `yield*` expressions",
18 category: "ECMAScript 6",
20 url: "https://eslint.org/docs/rules/yield-star-spacing"
23 fixable: "whitespace",
29 enum: ["before", "after", "both", "neither"]
34 before: { type: "boolean" },
35 after: { type: "boolean" }
37 additionalProperties: false
43 missingBefore: "Missing space before *.",
44 missingAfter: "Missing space after *.",
45 unexpectedBefore: "Unexpected space before *.",
46 unexpectedAfter: "Unexpected space after *."
51 const sourceCode = context.getSourceCode();
53 const mode = (function(option) {
54 if (!option || typeof option === "string") {
56 before: { before: true, after: false },
57 after: { before: false, after: true },
58 both: { before: true, after: true },
59 neither: { before: false, after: false }
63 }(context.options[0]));
66 * Checks the spacing between two tokens before or after the star token.
67 * @param {string} side Either "before" or "after".
68 * @param {Token} leftToken `function` keyword token if side is "before", or
69 * star token if side is "after".
70 * @param {Token} rightToken Star token if side is "before", or identifier
71 * token if side is "after".
74 function checkSpacing(side, leftToken, rightToken) {
75 if (sourceCode.isSpaceBetweenTokens(leftToken, rightToken) !== mode[side]) {
76 const after = leftToken.value === "*";
77 const spaceRequired = mode[side];
78 const node = after ? leftToken : rightToken;
82 messageId = side === "before" ? "missingBefore" : "missingAfter";
84 messageId = side === "before" ? "unexpectedBefore" : "unexpectedAfter";
93 return fixer.insertTextAfter(node, " ");
95 return fixer.insertTextBefore(node, " ");
97 return fixer.removeRange([leftToken.range[1], rightToken.range[0]]);
104 * Enforces the spacing around the star if node is a yield* expression.
105 * @param {ASTNode} node A yield expression node.
108 function checkExpression(node) {
109 if (!node.delegate) {
113 const tokens = sourceCode.getFirstTokens(node, 3);
114 const yieldToken = tokens[0];
115 const starToken = tokens[1];
116 const nextToken = tokens[2];
118 checkSpacing("before", yieldToken, starToken);
119 checkSpacing("after", starToken, nextToken);
123 YieldExpression: checkExpression