yield-star-spacing.js 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. /**
  2. * @fileoverview Rule to check the spacing around the * in yield* expressions.
  3. * @author Bryan Smith
  4. */
  5. "use strict";
  6. //------------------------------------------------------------------------------
  7. // Rule Definition
  8. //------------------------------------------------------------------------------
  9. module.exports = {
  10. meta: {
  11. docs: {
  12. description: "require or disallow spacing around the `*` in `yield*` expressions",
  13. category: "ECMAScript 6",
  14. recommended: false,
  15. url: "https://eslint.org/docs/rules/yield-star-spacing"
  16. },
  17. fixable: "whitespace",
  18. schema: [
  19. {
  20. oneOf: [
  21. {
  22. enum: ["before", "after", "both", "neither"]
  23. },
  24. {
  25. type: "object",
  26. properties: {
  27. before: { type: "boolean" },
  28. after: { type: "boolean" }
  29. },
  30. additionalProperties: false
  31. }
  32. ]
  33. }
  34. ]
  35. },
  36. create(context) {
  37. const sourceCode = context.getSourceCode();
  38. const mode = (function(option) {
  39. if (!option || typeof option === "string") {
  40. return {
  41. before: { before: true, after: false },
  42. after: { before: false, after: true },
  43. both: { before: true, after: true },
  44. neither: { before: false, after: false }
  45. }[option || "after"];
  46. }
  47. return option;
  48. }(context.options[0]));
  49. /**
  50. * Checks the spacing between two tokens before or after the star token.
  51. * @param {string} side Either "before" or "after".
  52. * @param {Token} leftToken `function` keyword token if side is "before", or
  53. * star token if side is "after".
  54. * @param {Token} rightToken Star token if side is "before", or identifier
  55. * token if side is "after".
  56. * @returns {void}
  57. */
  58. function checkSpacing(side, leftToken, rightToken) {
  59. if (sourceCode.isSpaceBetweenTokens(leftToken, rightToken) !== mode[side]) {
  60. const after = leftToken.value === "*";
  61. const spaceRequired = mode[side];
  62. const node = after ? leftToken : rightToken;
  63. const type = spaceRequired ? "Missing" : "Unexpected";
  64. const message = "{{type}} space {{side}} *.";
  65. context.report({
  66. node,
  67. message,
  68. data: {
  69. type,
  70. side
  71. },
  72. fix(fixer) {
  73. if (spaceRequired) {
  74. if (after) {
  75. return fixer.insertTextAfter(node, " ");
  76. }
  77. return fixer.insertTextBefore(node, " ");
  78. }
  79. return fixer.removeRange([leftToken.range[1], rightToken.range[0]]);
  80. }
  81. });
  82. }
  83. }
  84. /**
  85. * Enforces the spacing around the star if node is a yield* expression.
  86. * @param {ASTNode} node A yield expression node.
  87. * @returns {void}
  88. */
  89. function checkExpression(node) {
  90. if (!node.delegate) {
  91. return;
  92. }
  93. const tokens = sourceCode.getFirstTokens(node, 3);
  94. const yieldToken = tokens[0];
  95. const starToken = tokens[1];
  96. const nextToken = tokens[2];
  97. checkSpacing("before", yieldToken, starToken);
  98. checkSpacing("after", starToken, nextToken);
  99. }
  100. return {
  101. YieldExpression: checkExpression
  102. };
  103. }
  104. };