no-case-declarations.js 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. /**
  2. * @fileoverview Rule to flag use of an lexical declarations inside a case clause
  3. * @author Erik Arvidsson
  4. */
  5. "use strict";
  6. //------------------------------------------------------------------------------
  7. // Rule Definition
  8. //------------------------------------------------------------------------------
  9. /** @type {import('../shared/types').Rule} */
  10. module.exports = {
  11. meta: {
  12. type: "suggestion",
  13. docs: {
  14. description: "Disallow lexical declarations in case clauses",
  15. recommended: true,
  16. url: "https://eslint.org/docs/latest/rules/no-case-declarations"
  17. },
  18. hasSuggestions: true,
  19. schema: [],
  20. messages: {
  21. addBrackets: "Add {} brackets around the case block.",
  22. unexpected: "Unexpected lexical declaration in case block."
  23. }
  24. },
  25. create(context) {
  26. /**
  27. * Checks whether or not a node is a lexical declaration.
  28. * @param {ASTNode} node A direct child statement of a switch case.
  29. * @returns {boolean} Whether or not the node is a lexical declaration.
  30. */
  31. function isLexicalDeclaration(node) {
  32. switch (node.type) {
  33. case "FunctionDeclaration":
  34. case "ClassDeclaration":
  35. return true;
  36. case "VariableDeclaration":
  37. return node.kind !== "var";
  38. default:
  39. return false;
  40. }
  41. }
  42. return {
  43. SwitchCase(node) {
  44. for (let i = 0; i < node.consequent.length; i++) {
  45. const statement = node.consequent[i];
  46. if (isLexicalDeclaration(statement)) {
  47. context.report({
  48. node: statement,
  49. messageId: "unexpected",
  50. suggest: [
  51. {
  52. messageId: "addBrackets",
  53. fix: fixer => [
  54. fixer.insertTextBefore(node.consequent[0], "{ "),
  55. fixer.insertTextAfter(node.consequent.at(-1), " }")
  56. ]
  57. }
  58. ]
  59. });
  60. }
  61. }
  62. }
  63. };
  64. }
  65. };