eslint-plugin-jest/lib/rules/no-done-callback.js

ESLint rules for Jest

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _utils = require("@typescript-eslint/utils");
var _utils2 = require("./utils");
const findCallbackArg = (node, isJestEach, context) => {
  if (isJestEach) {
    return node.arguments[1];
  }
  const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
  if (jestFnCall?.type === 'hook' && node.arguments.length >= 1) {
    return node.arguments[0];
  }
  if (jestFnCall?.type === 'test' && node.arguments.length >= 2) {
    return node.arguments[1];
  }
  return null;
};
var _default = exports.default = (0, _utils2.createRule)({
  name: __filename,
  meta: {
    docs: {
      description: 'Disallow using a callback in asynchronous tests and hooks'
    },
    messages: {
      noDoneCallback: 'Return a Promise instead of relying on callback parameter',
      suggestWrappingInPromise: 'Wrap in `new Promise({{ callback }} => ...`',
      useAwaitInsteadOfCallback: 'Use await instead of callback in async functions'
    },
    schema: [],
    type: 'suggestion',
    hasSuggestions: true
  },
  defaultOptions: [],
  create(context) {
    return {
      CallExpression(node) {
        // done is the second argument for it.each, not the first
        const isJestEach = (0, _utils2.getNodeName)(node.callee)?.endsWith('.each') ?? false;
        if (isJestEach && node.callee.type !== _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
          // isJestEach but not a TaggedTemplateExpression, so this must be
          // the `jest.each([])()` syntax which this rule doesn't support due
          // to its complexity (see jest-community/eslint-plugin-jest#710)
          return;
        }
        const callback = findCallbackArg(node, isJestEach, context);
        const callbackArgIndex = Number(isJestEach);
        if (!callback || !(0, _utils2.isFunction)(callback) || callback.params.length !== 1 + callbackArgIndex) {
          return;
        }
        const argument = callback.params[callbackArgIndex];
        if (argument.type !== _utils.AST_NODE_TYPES.Identifier) {
          context.report({
            node: argument,
            messageId: 'noDoneCallback'
          });
          return;
        }
        if (callback.async) {
          context.report({
            node: argument,
            messageId: 'useAwaitInsteadOfCallback'
          });
          return;
        }
        context.report({
          node: argument,
          messageId: 'noDoneCallback',
          suggest: [{
            messageId: 'suggestWrappingInPromise',
            data: {
              callback: argument.name
            },
            fix(fixer) {
              const {
                body,
                params
              } = callback;
              const {
                sourceCode
              } = context;
              const firstBodyToken = sourceCode.getFirstToken(body);
              const lastBodyToken = sourceCode.getLastToken(body);
              const [firstParam] = params;
              const lastParam = params[params.length - 1];
              const tokenBeforeFirstParam = sourceCode.getTokenBefore(firstParam);
              let tokenAfterLastParam = sourceCode.getTokenAfter(lastParam);
              if (tokenAfterLastParam?.value === ',') {
                tokenAfterLastParam = sourceCode.getTokenAfter(tokenAfterLastParam);
              }

              /* istanbul ignore if */
              if (!firstBodyToken || !lastBodyToken || !tokenBeforeFirstParam || !tokenAfterLastParam) {
                throw new Error(`Unexpected null when attempting to fix ${context.filename} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
              }
              let argumentFix = fixer.replaceText(firstParam, '()');
              if (tokenBeforeFirstParam.value === '(' && tokenAfterLastParam.value === ')') {
                argumentFix = fixer.removeRange([tokenBeforeFirstParam.range[1], tokenAfterLastParam.range[0]]);
              }
              const newCallback = argument.name;
              let beforeReplacement = `new Promise(${newCallback} => `;
              let afterReplacement = ')';
              let replaceBefore = true;
              if (body.type === _utils.AST_NODE_TYPES.BlockStatement) {
                const keyword = 'return';
                beforeReplacement = `${keyword} ${beforeReplacement}{`;
                afterReplacement += '}';
                replaceBefore = false;
              }
              return [argumentFix, replaceBefore ? fixer.insertTextBefore(firstBodyToken, beforeReplacement) : fixer.insertTextAfter(firstBodyToken, beforeReplacement), fixer.insertTextAfter(lastBodyToken, afterReplacement)];
            }
          }]
        });
      }
    };
  }
});