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

100 lines
2.4 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _utils = require("./utils");
const messages = {
tooManyDescribes: 'There should not be more than {{ max }} describe{{ s }} at the top level',
unexpectedTestCase: 'All test cases must be wrapped in a describe block.',
unexpectedHook: 'All hooks must be wrapped in a describe block.'
};
var _default = (0, _utils.createRule)({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Require test cases and hooks to be inside a `describe` block',
recommended: false
},
messages,
type: 'suggestion',
schema: [{
type: 'object',
properties: {
maxNumberOfTopLevelDescribes: {
type: 'number',
minimum: 1
}
},
additionalProperties: false
}]
},
defaultOptions: [{}],
create(context) {
var _context$options$;
const {
maxNumberOfTopLevelDescribes = Infinity
} = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
let numberOfTopLevelDescribeBlocks = 0;
let numberOfDescribeBlocks = 0;
return {
CallExpression(node) {
if ((0, _utils.isDescribeCall)(node)) {
numberOfDescribeBlocks++;
if (numberOfDescribeBlocks === 1) {
numberOfTopLevelDescribeBlocks++;
if (numberOfTopLevelDescribeBlocks > maxNumberOfTopLevelDescribes) {
context.report({
node,
messageId: 'tooManyDescribes',
data: {
max: maxNumberOfTopLevelDescribes,
s: maxNumberOfTopLevelDescribes === 1 ? '' : 's'
}
});
}
}
return;
}
if (numberOfDescribeBlocks === 0) {
if ((0, _utils.isTestCaseCall)(node)) {
context.report({
node,
messageId: 'unexpectedTestCase'
});
return;
}
if ((0, _utils.isHook)(node)) {
context.report({
node,
messageId: 'unexpectedHook'
});
return;
}
}
},
'CallExpression:exit'(node) {
if ((0, _utils.isDescribeCall)(node)) {
numberOfDescribeBlocks--;
}
}
};
}
});
exports.default = _default;