forked from jest-community/eslint-plugin-jest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
prefer-importing-jest-globals.ts
69 lines (63 loc) · 1.96 KB
/
prefer-importing-jest-globals.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
import globalsJson from '../globals.json';
import { createRule, parseJestFnCall } from './utils';
export default createRule({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'Prefer importing Jest globals',
recommended: false,
},
messages: {
preferImportingJestGlobal: `Import the following Jest functions from '@jest/globals': {{ jestFunctions }}`,
},
fixable: 'code',
type: 'problem',
schema: [],
},
defaultOptions: [],
create(context) {
const jestGlobalFunctions = Object.keys(globalsJson);
const importedJestFunctions: string[] = [];
const usedJestFunctions = new Set<string>();
return {
CallExpression(node) {
const jestFnCall = parseJestFnCall(node, context);
if (!jestFnCall) {
return;
}
if (
jestFnCall.head.type === 'import' &&
jestGlobalFunctions.includes(jestFnCall.name)
) {
importedJestFunctions.push(jestFnCall.name);
}
/* istanbul ignore else */
if (jestGlobalFunctions.includes(jestFnCall.name)) {
usedJestFunctions.add(jestFnCall.name);
}
},
'Program:exit'() {
const jestFunctionsToImport = Array.from(usedJestFunctions).filter(
jestFunction => !importedJestFunctions.includes(jestFunction),
);
if (jestFunctionsToImport.length > 0) {
const node = context.getSourceCode().ast;
const jestFunctionsToImportFormatted =
jestFunctionsToImport.join(', ');
context.report({
node,
messageId: 'preferImportingJestGlobal',
data: { jestFunctions: jestFunctionsToImportFormatted },
fix(fixer) {
return fixer.insertTextBefore(
node,
`import { ${jestFunctionsToImportFormatted} } from '@jest/globals';\n`,
);
},
});
}
},
};
},
});