/
no-standalone-expect.ts
149 lines (129 loc) · 3.82 KB
/
no-standalone-expect.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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
DescribeAlias,
createRule,
getNodeName,
isDescribeCall,
isExpectCall,
isFunction,
isTestCaseCall,
} from './utils';
const getBlockType = (
statement: TSESTree.BlockStatement,
): 'function' | 'describe' | null => {
const func = statement.parent;
/* istanbul ignore if */
if (!func) {
throw new Error(
`Unexpected BlockStatement. No parent defined. - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`,
);
}
// functionDeclaration: function func() {}
if (func.type === AST_NODE_TYPES.FunctionDeclaration) {
return 'function';
}
if (isFunction(func) && func.parent) {
const expr = func.parent;
// arrow function or function expr
if (expr.type === AST_NODE_TYPES.VariableDeclarator) {
return 'function';
}
// if it's not a variable, it will be callExpr, we only care about describe
if (expr.type === AST_NODE_TYPES.CallExpression && isDescribeCall(expr)) {
return 'describe';
}
}
return null;
};
type BlockType = 'test' | 'function' | 'describe' | 'arrow' | 'template';
export default createRule<
[{ additionalTestBlockFunctions?: string[] }],
'unexpectedExpect'
>({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Disallow using `expect` outside of `it` or `test` blocks',
recommended: 'error',
},
messages: {
unexpectedExpect: 'Expect must be inside of a test block.',
},
type: 'suggestion',
schema: [
{
properties: {
additionalTestBlockFunctions: {
type: 'array',
items: { type: 'string' },
},
},
additionalProperties: false,
},
],
},
defaultOptions: [{ additionalTestBlockFunctions: [] }],
create(context, [{ additionalTestBlockFunctions = [] }]) {
const callStack: BlockType[] = [];
const isCustomTestBlockFunction = (
node: TSESTree.CallExpression,
): boolean =>
additionalTestBlockFunctions.includes(getNodeName(node) || '');
const isTestBlock = (node: TSESTree.CallExpression): boolean =>
isTestCaseCall(node) || isCustomTestBlockFunction(node);
return {
CallExpression(node) {
if (isExpectCall(node)) {
const parent = callStack[callStack.length - 1];
if (!parent || parent === DescribeAlias.describe) {
context.report({ node, messageId: 'unexpectedExpect' });
}
return;
}
if (isTestBlock(node)) {
callStack.push('test');
}
if (node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression) {
callStack.push('template');
}
},
'CallExpression:exit'(node: TSESTree.CallExpression) {
const top = callStack[callStack.length - 1];
if (
(top === 'test' &&
isTestBlock(node) &&
node.callee.type !== AST_NODE_TYPES.MemberExpression) ||
(top === 'template' &&
node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression)
) {
callStack.pop();
}
},
BlockStatement(statement) {
const blockType = getBlockType(statement);
if (blockType) {
callStack.push(blockType);
}
},
'BlockStatement:exit'(statement: TSESTree.BlockStatement) {
if (callStack[callStack.length - 1] === getBlockType(statement)) {
callStack.pop();
}
},
ArrowFunctionExpression(node) {
if (node.parent?.type !== AST_NODE_TYPES.CallExpression) {
callStack.push('arrow');
}
},
'ArrowFunctionExpression:exit'() {
if (callStack[callStack.length - 1] === 'arrow') {
callStack.pop();
}
},
};
},
});