/
expect-expect.ts
89 lines (82 loc) · 2.27 KB
/
expect-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
/*
* This implementation is adapted from eslint-plugin-jasmine.
* MIT license, Remco Haszing.
*/
import {
AST_NODE_TYPES,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
TestCaseName,
createRule,
getNodeName,
getTestCallExpressionsFromDeclaredVariables,
} from './utils';
export default createRule<
[Partial<{ assertFunctionNames: readonly string[] }>],
'noAssertions'
>({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Enforce assertion to be made in a test body',
recommended: false,
},
messages: {
noAssertions: 'Test has no assertions',
},
schema: [
{
type: 'object',
properties: {
assertFunctionNames: {
type: 'array',
items: [{ type: 'string' }],
},
},
additionalProperties: false,
},
],
type: 'suggestion',
},
defaultOptions: [{ assertFunctionNames: ['expect'] }],
create(context, [{ assertFunctionNames = ['expect'] }]) {
const unchecked: TSESTree.CallExpression[] = [];
function checkCallExpressionUsed(nodes: TSESTree.Node[]) {
for (const node of nodes) {
const index =
node.type === AST_NODE_TYPES.CallExpression
? unchecked.indexOf(node)
: -1;
if (node.type === AST_NODE_TYPES.FunctionDeclaration) {
const declaredVariables = context.getDeclaredVariables(node);
const testCallExpressions = getTestCallExpressionsFromDeclaredVariables(
declaredVariables,
);
checkCallExpressionUsed(testCallExpressions);
}
if (index !== -1) {
unchecked.splice(index, 1);
break;
}
}
}
return {
CallExpression(node) {
const name = getNodeName(node.callee);
if (name === TestCaseName.it || name === TestCaseName.test) {
unchecked.push(node);
} else if (name && assertFunctionNames.includes(name)) {
// Return early in case of nested `it` statements.
checkCallExpressionUsed(context.getAncestors());
}
},
'Program:exit'() {
unchecked.forEach(node =>
context.report({ messageId: 'noAssertions', node }),
);
},
};
},
});