/
prefer-to-be.ts
167 lines (140 loc) · 4.28 KB
/
prefer-to-be.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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
import { AST_NODE_TYPES, TSESLint, TSESTree } from '@typescript-eslint/utils';
import {
AccessorNode,
EqualityMatcher,
ParsedExpectFnCall,
createRule,
getAccessorValue,
getFirstMatcherArg,
isIdentifier,
parseJestFnCall,
replaceAccessorFixer,
} from './utils';
const isNullLiteral = (node: TSESTree.Node): node is TSESTree.NullLiteral =>
node.type === AST_NODE_TYPES.Literal && node.value === null;
/**
* Checks if the given `ParsedEqualityMatcherCall` is a call to one of the equality matchers,
* with a `null` literal as the sole argument.
*/
const isNullEqualityMatcher = (expectFnCall: ParsedExpectFnCall) =>
isNullLiteral(getFirstMatcherArg(expectFnCall));
const isFirstArgumentIdentifier = (
expectFnCall: ParsedExpectFnCall,
name: string,
) => isIdentifier(getFirstMatcherArg(expectFnCall), name);
const shouldUseToBe = (expectFnCall: ParsedExpectFnCall): boolean => {
let firstArg = getFirstMatcherArg(expectFnCall);
if (
firstArg.type === AST_NODE_TYPES.UnaryExpression &&
firstArg.operator === '-'
) {
firstArg = firstArg.argument;
}
if (firstArg.type === AST_NODE_TYPES.Literal) {
// regex literals are classed as literals, but they're actually objects
// which means "toBe" will give different results than other matchers
return !('regex' in firstArg);
}
return firstArg.type === AST_NODE_TYPES.TemplateLiteral;
};
type MessageId =
| 'useToBe'
| 'useToBeUndefined'
| 'useToBeDefined'
| 'useToBeNull'
| 'useToBeNaN';
type ToBeWhat = MessageId extends `useToBe${infer M}` ? M : never;
const reportPreferToBe = (
context: TSESLint.RuleContext<MessageId, unknown[]>,
whatToBe: ToBeWhat,
expectFnCall: ParsedExpectFnCall,
modifierNode?: AccessorNode,
) => {
context.report({
messageId: `useToBe${whatToBe}`,
fix(fixer) {
const fixes = [
replaceAccessorFixer(fixer, expectFnCall.matcher, `toBe${whatToBe}`),
];
if (expectFnCall.args?.length && whatToBe !== '') {
fixes.push(fixer.remove(expectFnCall.args[0]));
}
if (modifierNode) {
fixes.push(
fixer.removeRange([modifierNode.range[0] - 1, modifierNode.range[1]]),
);
}
return fixes;
},
node: expectFnCall.matcher,
});
};
export default createRule({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Suggest using `toBe()` for primitive literals',
recommended: false,
},
messages: {
useToBe: 'Use `toBe` when expecting primitive literals',
useToBeUndefined: 'Use `toBeUndefined` instead',
useToBeDefined: 'Use `toBeDefined` instead',
useToBeNull: 'Use `toBeNull` instead',
useToBeNaN: 'Use `toBeNaN` instead',
},
fixable: 'code',
type: 'suggestion',
schema: [],
},
defaultOptions: [],
create(context) {
return {
CallExpression(node) {
const jestFnCall = parseJestFnCall(node, context);
if (jestFnCall?.type !== 'expect') {
return;
}
const matcherName = getAccessorValue(jestFnCall.matcher);
const notModifier = jestFnCall.modifiers.find(
nod => getAccessorValue(nod) === 'not',
);
if (
notModifier &&
['toBeUndefined', 'toBeDefined'].includes(matcherName)
) {
reportPreferToBe(
context,
matcherName === 'toBeDefined' ? 'Undefined' : 'Defined',
jestFnCall,
notModifier,
);
return;
}
if (
!EqualityMatcher.hasOwnProperty(matcherName) ||
jestFnCall.args.length === 0
) {
return;
}
if (isNullEqualityMatcher(jestFnCall)) {
reportPreferToBe(context, 'Null', jestFnCall);
return;
}
if (isFirstArgumentIdentifier(jestFnCall, 'undefined')) {
const name = notModifier ? 'Defined' : 'Undefined';
reportPreferToBe(context, name, jestFnCall, notModifier);
return;
}
if (isFirstArgumentIdentifier(jestFnCall, 'NaN')) {
reportPreferToBe(context, 'NaN', jestFnCall);
return;
}
if (shouldUseToBe(jestFnCall) && matcherName !== EqualityMatcher.toBe) {
reportPreferToBe(context, '', jestFnCall);
}
},
};
},
});