forked from jest-community/eslint-plugin-jest
/
no-standalone-expect.ts
122 lines (117 loc) · 3.19 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
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
TestCaseName,
createRule,
isDescribe,
isExpectCall,
isFunction,
isTestCase,
} from './tsUtils';
const getBlockType = (
stmt: TSESTree.BlockStatement,
): 'function' | 'describe' | null => {
const func = stmt.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;
// arrowfunction 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 && isDescribe(expr)) {
return 'describe';
}
}
return null;
};
const isEach = (node: TSESTree.CallExpression): boolean => {
if (
node &&
node.callee &&
node.callee.callee &&
node.callee.callee.property &&
node.callee.callee.property.name === 'each' &&
node.callee.callee.object &&
TestCaseName.hasOwnProperty(node.callee.callee.object.name)
) {
return true;
}
return false;
};
export default createRule({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Prevents expects that are outside of an it or test block.',
recommended: false,
},
messages: {
unexpectedExpect: 'Expect must be inside of a test block.',
},
type: 'suggestion',
schema: [],
},
defaultOptions: [],
create(context) {
const callStack: Array<'test' | 'function' | 'describe' | 'arrowFunc'> = [];
return {
CallExpression(node) {
if (isExpectCall(node)) {
const parent = callStack[callStack.length - 1];
if (!parent || parent === 'describe') {
context.report({ node, messageId: 'unexpectedExpect' });
}
return;
}
if (isTestCase(node)) {
callStack.push('test');
}
},
'CallExpression:exit'(node: TSESTree.CallExpression) {
if (
(isTestCase(node) &&
node.callee.type !== AST_NODE_TYPES.MemberExpression) ||
isEach(node)
) {
callStack.pop();
}
},
BlockStatement(stmt) {
const blockType = getBlockType(stmt);
if (blockType) {
callStack.push(blockType);
}
},
'BlockStatement:exit'(stmt: TSESTree.BlockStatement) {
const blockType = getBlockType(stmt);
if (blockType && blockType === callStack[callStack.length - 1]) {
callStack.pop();
}
},
ArrowFunctionExpression(node) {
if (node.parent && node.parent.type !== AST_NODE_TYPES.CallExpression) {
callStack.push('arrowFunc');
}
},
'ArrowFunctionExpression:exit'() {
if (callStack[callStack.length - 1] === 'arrowFunc') {
callStack.pop();
}
},
};
},
});