prefer-hooks-in-order.js 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. var _utils = require("./utils");
  7. const HooksOrder = ['beforeAll', 'beforeEach', 'afterEach', 'afterAll'];
  8. var _default = (0, _utils.createRule)({
  9. name: __filename,
  10. meta: {
  11. docs: {
  12. category: 'Best Practices',
  13. description: 'Prefer having hooks in a consistent order',
  14. recommended: false
  15. },
  16. messages: {
  17. reorderHooks: `\`{{ currentHook }}\` hooks should be before any \`{{ previousHook }}\` hooks`
  18. },
  19. schema: [],
  20. type: 'suggestion'
  21. },
  22. defaultOptions: [],
  23. create(context) {
  24. let previousHookIndex = -1;
  25. let inHook = false;
  26. return {
  27. CallExpression(node) {
  28. if (inHook) {
  29. // Ignore everything that is passed into a hook
  30. return;
  31. }
  32. const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
  33. if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'hook') {
  34. // Reset the previousHookIndex when encountering something different from a hook
  35. previousHookIndex = -1;
  36. return;
  37. }
  38. inHook = true;
  39. const currentHook = jestFnCall.name;
  40. const currentHookIndex = HooksOrder.indexOf(currentHook);
  41. if (currentHookIndex < previousHookIndex) {
  42. context.report({
  43. messageId: 'reorderHooks',
  44. node,
  45. data: {
  46. previousHook: HooksOrder[previousHookIndex],
  47. currentHook
  48. }
  49. });
  50. return;
  51. }
  52. previousHookIndex = currentHookIndex;
  53. },
  54. 'CallExpression:exit'(node) {
  55. if ((0, _utils.isTypeOfJestFnCall)(node, context, ['hook'])) {
  56. inHook = false;
  57. return;
  58. }
  59. if (inHook) {
  60. return;
  61. } // Reset the previousHookIndex when encountering something different from a hook
  62. previousHookIndex = -1;
  63. }
  64. };
  65. }
  66. });
  67. exports.default = _default;