github-pages-deploy-action/node_modules/eslint-plugin-jest/lib/rules/valid-describe.js

106 lines
2.7 KiB
JavaScript
Raw Normal View History

2020-03-07 11:45:40 +08:00
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _experimentalUtils = require("@typescript-eslint/experimental-utils");
var _utils = require("./utils");
const paramsLocation = params => {
2020-03-31 20:40:00 +08:00
const [first] = params;
2020-03-07 11:45:40 +08:00
const last = params[params.length - 1];
return {
start: first.loc.start,
end: last.loc.end
};
};
var _default = (0, _utils.createRule)({
name: __filename,
meta: {
type: 'problem',
docs: {
category: 'Possible Errors',
description: 'Using an improper `describe()` callback function can lead to unexpected test errors.',
recommended: 'warn'
},
messages: {
nameAndCallback: 'Describe requires name and callback arguments',
secondArgumentMustBeFunction: 'Second argument must be function',
noAsyncDescribeCallback: 'No async describe callback',
unexpectedDescribeArgument: 'Unexpected argument(s) in describe callback',
unexpectedReturnInDescribe: 'Unexpected return statement in describe callback'
},
schema: []
},
defaultOptions: [],
create(context) {
return {
CallExpression(node) {
2020-03-31 20:40:00 +08:00
if (!(0, _utils.isDescribe)(node)) {
2020-03-07 11:45:40 +08:00
return;
}
2020-03-31 20:40:00 +08:00
const nodeArguments = (0, _utils.getJestFunctionArguments)(node);
if (nodeArguments.length < 1) {
2020-03-07 11:45:40 +08:00
return context.report({
messageId: 'nameAndCallback',
loc: node.loc
});
}
2020-03-31 20:40:00 +08:00
const [, callback] = nodeArguments;
2020-03-07 11:45:40 +08:00
if (!callback) {
context.report({
messageId: 'nameAndCallback',
2020-03-31 20:40:00 +08:00
loc: paramsLocation(nodeArguments)
2020-03-07 11:45:40 +08:00
});
return;
}
if (!(0, _utils.isFunction)(callback)) {
context.report({
messageId: 'secondArgumentMustBeFunction',
2020-03-31 20:40:00 +08:00
loc: paramsLocation(nodeArguments)
2020-03-07 11:45:40 +08:00
});
return;
}
if (callback.async) {
context.report({
messageId: 'noAsyncDescribeCallback',
node: callback
});
}
2020-03-31 20:40:00 +08:00
if (!(0, _utils.isDescribeEach)(node) && callback.params.length) {
2020-03-07 11:45:40 +08:00
context.report({
messageId: 'unexpectedDescribeArgument',
loc: paramsLocation(callback.params)
});
}
if (callback.body && callback.body.type === _experimentalUtils.AST_NODE_TYPES.BlockStatement) {
callback.body.body.forEach(node => {
if (node.type === _experimentalUtils.AST_NODE_TYPES.ReturnStatement) {
context.report({
messageId: 'unexpectedReturnInDescribe',
node
});
}
});
}
}
};
}
});
exports.default = _default;