PromoCursed/node_modules/eslint-plugin-jest/lib/rules/require-hook.js
2024-08-20 23:25:37 +04:00

121 lines
2.9 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _experimentalUtils = require("@typescript-eslint/experimental-utils");
var _utils = require("./utils");
const isJestFnCall = node => {
var _getNodeName;
if ((0, _utils.isDescribeCall)(node) || (0, _utils.isTestCaseCall)(node) || (0, _utils.isHook)(node)) {
return true;
}
return !!((_getNodeName = (0, _utils.getNodeName)(node)) !== null && _getNodeName !== void 0 && _getNodeName.startsWith('jest.'));
};
const isNullOrUndefined = node => {
return node.type === _experimentalUtils.AST_NODE_TYPES.Literal && node.value === null || (0, _utils.isIdentifier)(node, 'undefined');
};
const shouldBeInHook = (node, allowedFunctionCalls = []) => {
switch (node.type) {
case _experimentalUtils.AST_NODE_TYPES.ExpressionStatement:
return shouldBeInHook(node.expression, allowedFunctionCalls);
case _experimentalUtils.AST_NODE_TYPES.CallExpression:
return !(isJestFnCall(node) || allowedFunctionCalls.includes((0, _utils.getNodeName)(node)));
case _experimentalUtils.AST_NODE_TYPES.VariableDeclaration:
{
if (node.kind === 'const') {
return false;
}
return node.declarations.some(({
init
}) => init !== null && !isNullOrUndefined(init));
}
default:
return false;
}
};
var _default = (0, _utils.createRule)({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Require setup and teardown code to be within a hook',
recommended: false
},
messages: {
useHook: 'This should be done within a hook'
},
type: 'suggestion',
schema: [{
type: 'object',
properties: {
allowedFunctionCalls: {
type: 'array',
items: {
type: 'string'
}
}
},
additionalProperties: false
}]
},
defaultOptions: [{
allowedFunctionCalls: []
}],
create(context) {
var _context$options$;
const {
allowedFunctionCalls
} = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
const checkBlockBody = body => {
for (const statement of body) {
if (shouldBeInHook(statement, allowedFunctionCalls)) {
context.report({
node: statement,
messageId: 'useHook'
});
}
}
};
return {
Program(program) {
checkBlockBody(program.body);
},
CallExpression(node) {
if (!(0, _utils.isDescribeCall)(node) || node.arguments.length < 2) {
return;
}
const [, testFn] = node.arguments;
if (!(0, _utils.isFunction)(testFn) || testFn.body.type !== _experimentalUtils.AST_NODE_TYPES.BlockStatement) {
return;
}
checkBlockBody(testFn.body.body);
}
};
}
});
exports.default = _default;