forked from jest-community/eslint-plugin-jest
/
require-to-throw-message.ts
50 lines (47 loc) · 1.15 KB
/
require-to-throw-message.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
import {
ModifierName,
createRule,
isExpectCall,
parseExpectCall,
} from './utils';
export default createRule({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Require a message for `toThrow()`',
recommended: false,
},
messages: {
addErrorMessage: 'Add an error message to {{ propertyName }}()',
},
type: 'suggestion',
schema: [],
},
defaultOptions: [],
create(context) {
return {
CallExpression(node) {
if (!isExpectCall(node)) {
return;
}
const { matcher, modifier } = parseExpectCall(node);
if (
matcher &&
matcher.arguments &&
matcher.arguments.length === 0 &&
['toThrow', 'toThrowError'].includes(matcher.name) &&
(!modifier ||
!(modifier.name === ModifierName.not || modifier.negation))
) {
// Look for `toThrow` calls with no arguments.
context.report({
messageId: 'addErrorMessage',
data: { matcherName: matcher.name },
node: matcher.node.property,
});
}
},
};
},
});