eslint-plugin-jest/lib/rules/no-standalone-expect.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 getBlockType = (statement, context) => {
  const func = statement.parent;

  // functionDeclaration: function func() {}
  if (func.type === _utils.AST_NODE_TYPES.FunctionDeclaration) {
    return 'function';
  }
  if ((0, _utils2.isFunction)(func)) {
    const expr = func.parent;

    // arrow function or function expr
    if (expr.type === _utils.AST_NODE_TYPES.VariableDeclarator) {
      return 'function';
    }

    // if it's not a variable, it will be callExpr, we only care about describe
    if (expr.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isTypeOfJestFnCall)(expr, context, ['describe'])) {
      return 'describe';
    }
  }
  return null;
};
var _default = exports.default = (0, _utils2.createRule)({
  name: __filename,
  meta: {
    docs: {
      description: 'Disallow using `expect` outside of `it` or `test` blocks'
    },
    messages: {
      unexpectedExpect: 'Expect must be inside of a test block'
    },
    type: 'suggestion',
    schema: [{
      type: 'object',
      properties: {
        additionalTestBlockFunctions: {
          type: 'array',
          items: {
            type: 'string'
          }
        }
      },
      additionalProperties: false
    }]
  },
  defaultOptions: [{
    additionalTestBlockFunctions: []
  }],
  create(context, [{
    additionalTestBlockFunctions = []
  }]) {
    const callStack = [];
    const isCustomTestBlockFunction = node => additionalTestBlockFunctions.includes((0, _utils2.getNodeName)(node) || '');
    return {
      CallExpression(node) {
        const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
        if (jestFnCall?.type === 'expect') {
          if (jestFnCall.head.node.parent.type === _utils.AST_NODE_TYPES.MemberExpression && jestFnCall.members.length === 1 && !['assertions', 'hasAssertions'].includes((0, _utils2.getAccessorValue)(jestFnCall.members[0]))) {
            return;
          }
          const parent = callStack[callStack.length - 1];
          if (!parent || parent === _utils2.DescribeAlias.describe) {
            context.report({
              node,
              messageId: 'unexpectedExpect'
            });
          }
          return;
        }
        if (jestFnCall?.type === 'test' || isCustomTestBlockFunction(node)) {
          callStack.push('test');
        }
        if (node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
          callStack.push('template');
        }
      },
      'CallExpression:exit'(node) {
        const top = callStack[callStack.length - 1];
        if (top === 'test' && ((0, _utils2.isTypeOfJestFnCall)(node, context, ['test']) || isCustomTestBlockFunction(node)) && node.callee.type !== _utils.AST_NODE_TYPES.MemberExpression || top === 'template' && node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
          callStack.pop();
        }
      },
      BlockStatement(statement) {
        const blockType = getBlockType(statement, context);
        if (blockType) {
          callStack.push(blockType);
        }
      },
      'BlockStatement:exit'(statement) {
        if (callStack[callStack.length - 1] === getBlockType(statement, context)) {
          callStack.pop();
        }
      },
      ArrowFunctionExpression(node) {
        if (node.parent.type !== _utils.AST_NODE_TYPES.CallExpression) {
          callStack.push('arrow');
        }
      },
      'ArrowFunctionExpression:exit'() {
        if (callStack[callStack.length - 1] === 'arrow') {
          callStack.pop();
        }
      }
    };
  }
});