forked from jest-community/eslint-plugin-jest
/
require-hook.ts
126 lines (114 loc) · 2.79 KB
/
require-hook.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
createRule,
getNodeName,
isDescribeCall,
isFunction,
isHook,
isIdentifier,
isTestCaseCall,
} from './utils';
const isJestFnCall = (node: TSESTree.CallExpression): boolean => {
if (isDescribeCall(node) || isTestCaseCall(node) || isHook(node)) {
return true;
}
return !!getNodeName(node)?.startsWith('jest.');
};
const isNullOrUndefined = (node: TSESTree.Expression): boolean => {
return (
(node.type === AST_NODE_TYPES.Literal && node.value === null) ||
isIdentifier(node, 'undefined')
);
};
const shouldBeInHook = (
node: TSESTree.Node,
allowedFunctionCalls: readonly string[] = [],
): boolean => {
switch (node.type) {
case AST_NODE_TYPES.ExpressionStatement:
return shouldBeInHook(node.expression, allowedFunctionCalls);
case AST_NODE_TYPES.CallExpression:
return !(
isJestFnCall(node) ||
allowedFunctionCalls.includes(getNodeName(node) as string)
);
case AST_NODE_TYPES.VariableDeclaration: {
if (node.kind === 'const') {
return false;
}
return node.declarations.some(
({ init }) => init !== null && !isNullOrUndefined(init),
);
}
default:
return false;
}
};
export default createRule<
[{ allowedFunctionCalls?: readonly string[] }],
'useHook'
>({
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) {
const { allowedFunctionCalls } = context.options[0] ?? {};
const checkBlockBody = (body: TSESTree.BlockStatement['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 (!isDescribeCall(node) || node.arguments.length < 2) {
return;
}
const [, testFn] = node.arguments;
if (
!isFunction(testFn) ||
testFn.body.type !== AST_NODE_TYPES.BlockStatement
) {
return;
}
checkBlockBody(testFn.body.body);
},
};
},
});