/
no-test-return-statement.ts
73 lines (62 loc) · 1.74 KB
/
no-test-return-statement.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
import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
import {
createRule,
getTestCallExpressionsFromDeclaredVariables,
isFunction,
isTypeOfJestFnCall,
} from './utils';
const getBody = (args: TSESTree.CallExpressionArgument[]) => {
const [, secondArg] = args;
if (
secondArg &&
isFunction(secondArg) &&
secondArg.body.type === AST_NODE_TYPES.BlockStatement
) {
return secondArg.body.body;
}
return [];
};
export default createRule({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Disallow explicitly returning from tests',
recommended: false,
},
messages: {
noReturnValue: 'Jest tests should not return a value.',
},
schema: [],
type: 'suggestion',
},
defaultOptions: [],
create(context) {
return {
CallExpression(node) {
if (!isTypeOfJestFnCall(node, context, ['test'])) {
return;
}
const body = getBody(node.arguments);
const returnStmt = body.find(
t => t.type === AST_NODE_TYPES.ReturnStatement,
);
if (!returnStmt) return;
context.report({ messageId: 'noReturnValue', node: returnStmt });
},
FunctionDeclaration(node) {
const declaredVariables = context.getDeclaredVariables(node);
const testCallExpressions = getTestCallExpressionsFromDeclaredVariables(
declaredVariables,
context,
);
if (testCallExpressions.length === 0) return;
const returnStmt = node.body.body.find(
t => t.type === AST_NODE_TYPES.ReturnStatement,
);
if (!returnStmt) return;
context.report({ messageId: 'noReturnValue', node: returnStmt });
},
};
},
});