no-deprecated-functions.js 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. var _utils = require("@typescript-eslint/utils");
  7. var _utils2 = require("./utils");
  8. const parseJestVersion = rawVersion => {
  9. if (typeof rawVersion === 'number') {
  10. return rawVersion;
  11. }
  12. const [majorVersion] = rawVersion.split('.');
  13. return parseInt(majorVersion, 10);
  14. };
  15. var _default = (0, _utils2.createRule)({
  16. name: __filename,
  17. meta: {
  18. docs: {
  19. category: 'Best Practices',
  20. description: 'Disallow use of deprecated functions',
  21. recommended: 'error'
  22. },
  23. messages: {
  24. deprecatedFunction: '`{{ deprecation }}` has been deprecated in favor of `{{ replacement }}`'
  25. },
  26. type: 'suggestion',
  27. schema: [],
  28. fixable: 'code'
  29. },
  30. defaultOptions: [],
  31. create(context) {
  32. var _context$settings, _context$settings$jes;
  33. const jestVersion = parseJestVersion(((_context$settings = context.settings) === null || _context$settings === void 0 ? void 0 : (_context$settings$jes = _context$settings.jest) === null || _context$settings$jes === void 0 ? void 0 : _context$settings$jes.version) || (0, _utils2.detectJestVersion)());
  34. const deprecations = { ...(jestVersion >= 15 && {
  35. 'jest.resetModuleRegistry': 'jest.resetModules'
  36. }),
  37. ...(jestVersion >= 17 && {
  38. 'jest.addMatchers': 'expect.extend'
  39. }),
  40. ...(jestVersion >= 21 && {
  41. 'require.requireMock': 'jest.requireMock',
  42. 'require.requireActual': 'jest.requireActual'
  43. }),
  44. ...(jestVersion >= 22 && {
  45. 'jest.runTimersToTime': 'jest.advanceTimersByTime'
  46. }),
  47. ...(jestVersion >= 26 && {
  48. 'jest.genMockFromModule': 'jest.createMockFromModule'
  49. })
  50. };
  51. return {
  52. CallExpression(node) {
  53. if (node.callee.type !== _utils.AST_NODE_TYPES.MemberExpression) {
  54. return;
  55. }
  56. const deprecation = (0, _utils2.getNodeName)(node);
  57. if (!deprecation || !(deprecation in deprecations)) {
  58. return;
  59. }
  60. const replacement = deprecations[deprecation];
  61. const {
  62. callee
  63. } = node;
  64. context.report({
  65. messageId: 'deprecatedFunction',
  66. data: {
  67. deprecation,
  68. replacement
  69. },
  70. node,
  71. fix(fixer) {
  72. let [name, func] = replacement.split('.');
  73. if (callee.property.type === _utils.AST_NODE_TYPES.Literal) {
  74. func = `'${func}'`;
  75. }
  76. return [fixer.replaceText(callee.object, name), fixer.replaceText(callee.property, func)];
  77. }
  78. });
  79. }
  80. };
  81. }
  82. });
  83. exports.default = _default;