/
expect-expect.ts
140 lines (129 loc) · 3.44 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
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
/*
* This implementation is adapted from eslint-plugin-jasmine.
* MIT license, Remco Haszing.
*/
import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
import {
createRule,
getNodeName,
getTestCallExpressionsFromDeclaredVariables,
isSupportedAccessor,
isTypeOfJestFnCall,
} from './utils';
/**
* Checks if node names returned by getNodeName matches any of the given star patterns
* Pattern examples:
* request.*.expect
* request.**.expect
* request.**.expect*
*/
function matchesAssertFunctionName(
nodeName: string,
patterns: readonly string[],
): boolean {
return patterns.some(p =>
new RegExp(
`^${p
.split('.')
.map(x => {
if (x === '**') return '[a-z\\d\\.]*';
return x.replace(/\*/gu, '[a-z\\d]*');
})
.join('\\.')}(\\.|$)`,
'ui',
).test(nodeName),
);
}
export default createRule<
[
Partial<{
assertFunctionNames: readonly string[];
additionalTestBlockFunctions: readonly string[];
}>,
],
'noAssertions'
>({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Enforce assertion to be made in a test body',
recommended: 'warn',
},
messages: {
noAssertions: 'Test has no assertions',
},
schema: [
{
type: 'object',
properties: {
assertFunctionNames: {
type: 'array',
items: [{ type: 'string' }],
},
additionalTestBlockFunctions: {
type: 'array',
items: { type: 'string' },
},
},
additionalProperties: false,
},
],
type: 'suggestion',
},
defaultOptions: [
{ assertFunctionNames: ['expect'], additionalTestBlockFunctions: [] },
],
create(
context,
[{ assertFunctionNames = ['expect'], additionalTestBlockFunctions = [] }],
) {
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,
context.getScope(),
);
checkCallExpressionUsed(testCallExpressions);
}
if (index !== -1) {
unchecked.splice(index, 1);
break;
}
}
}
return {
CallExpression(node) {
const name = getNodeName(node.callee) ?? '';
if (
isTypeOfJestFnCall(node, context.getScope(), ['test']) ||
additionalTestBlockFunctions.includes(name)
) {
if (
node.callee.type === AST_NODE_TYPES.MemberExpression &&
isSupportedAccessor(node.callee.property, 'todo')
) {
return;
}
unchecked.push(node);
} else if (matchesAssertFunctionName(name, assertFunctionNames)) {
// Return early in case of nested `it` statements.
checkCallExpressionUsed(context.getAncestors());
}
},
'Program:exit'() {
unchecked.forEach(node =>
context.report({ messageId: 'noAssertions', node }),
);
},
};
},
});