/
valid-describe.ts
112 lines (99 loc) · 2.68 KB
/
valid-describe.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
createRule,
getJestFunctionArguments,
isDescribe,
isDescribeEach,
isFunction,
} from './utils';
const paramsLocation = (
params: TSESTree.Expression[] | TSESTree.Parameter[],
) => {
const [first] = params;
const last = params[params.length - 1];
return {
start: first.loc.start,
end: last.loc.end,
};
};
export default 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) {
if (!isDescribe(node)) {
return;
}
const nodeArguments = getJestFunctionArguments(node);
if (nodeArguments.length < 1) {
return context.report({
messageId: 'nameAndCallback',
loc: node.loc,
});
}
const [, callback] = nodeArguments;
if (!callback) {
context.report({
messageId: 'nameAndCallback',
loc: paramsLocation(nodeArguments),
});
return;
}
if (!isFunction(callback)) {
context.report({
messageId: 'secondArgumentMustBeFunction',
loc: paramsLocation(nodeArguments),
});
return;
}
if (callback.async) {
context.report({
messageId: 'noAsyncDescribeCallback',
node: callback,
});
}
if (!isDescribeEach(node) && callback.params.length) {
context.report({
messageId: 'unexpectedDescribeArgument',
loc: paramsLocation(callback.params),
});
}
if (
callback.body &&
callback.body.type === AST_NODE_TYPES.BlockStatement
) {
callback.body.body.forEach(node => {
if (node.type === AST_NODE_TYPES.ReturnStatement) {
context.report({
messageId: 'unexpectedReturnInDescribe',
node,
});
}
});
}
},
};
},
});