no-await-sync-events.js
4.9 KB
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
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
const utils_1 = require("@typescript-eslint/utils");
const create_testing_library_rule_1 = require("../create-testing-library-rule");
const node_utils_1 = require("../node-utils");
const USER_EVENT_ASYNC_EXCEPTIONS = ['type', 'keyboard'];
const VALID_EVENT_MODULES = ['fire-event', 'user-event'];
exports.RULE_NAME = 'no-await-sync-events';
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'problem',
docs: {
description: 'Disallow unnecessary `await` for sync events',
recommendedConfig: {
dom: false,
angular: false,
react: false,
vue: false,
marko: false,
},
},
messages: {
noAwaitSyncEvents: '`{{ name }}` is sync and does not need `await` operator',
},
schema: [
{
type: 'object',
properties: {
eventModules: {
type: 'array',
minItems: 1,
items: {
enum: VALID_EVENT_MODULES,
},
},
},
additionalProperties: false,
},
],
},
defaultOptions: [{ eventModules: VALID_EVENT_MODULES }],
create(context, [options], helpers) {
const { eventModules = VALID_EVENT_MODULES } = options;
let hasDelayDeclarationOrAssignmentGTZero;
return {
VariableDeclaration(node) {
hasDelayDeclarationOrAssignmentGTZero = node.declarations.some((property) => utils_1.ASTUtils.isIdentifier(property.id) &&
property.id.name === 'delay' &&
(0, node_utils_1.isLiteral)(property.init) &&
property.init.value &&
property.init.value > 0);
},
AssignmentExpression(node) {
if (utils_1.ASTUtils.isIdentifier(node.left) &&
node.left.name === 'delay' &&
(0, node_utils_1.isLiteral)(node.right) &&
node.right.value !== null) {
hasDelayDeclarationOrAssignmentGTZero = node.right.value > 0;
}
},
'AwaitExpression > CallExpression'(node) {
var _a;
const simulateEventFunctionIdentifier = (0, node_utils_1.getDeepestIdentifierNode)(node);
if (!simulateEventFunctionIdentifier) {
return;
}
const isUserEventMethod = helpers.isUserEventMethod(simulateEventFunctionIdentifier);
const isFireEventMethod = helpers.isFireEventMethod(simulateEventFunctionIdentifier);
const isSimulateEventMethod = isUserEventMethod || isFireEventMethod;
if (!isSimulateEventMethod) {
return;
}
if (isFireEventMethod && !eventModules.includes('fire-event')) {
return;
}
if (isUserEventMethod && !eventModules.includes('user-event')) {
return;
}
const lastArg = node.arguments[node.arguments.length - 1];
const hasDelayProperty = (0, node_utils_1.isObjectExpression)(lastArg) &&
lastArg.properties.some((property) => (0, node_utils_1.isProperty)(property) &&
utils_1.ASTUtils.isIdentifier(property.key) &&
property.key.name === 'delay');
const hasDelayLiteralGTZero = (0, node_utils_1.isObjectExpression)(lastArg) &&
lastArg.properties.some((property) => (0, node_utils_1.isProperty)(property) &&
utils_1.ASTUtils.isIdentifier(property.key) &&
property.key.name === 'delay' &&
(0, node_utils_1.isLiteral)(property.value) &&
!!property.value.value &&
property.value.value > 0);
const simulateEventFunctionName = simulateEventFunctionIdentifier.name;
if (USER_EVENT_ASYNC_EXCEPTIONS.includes(simulateEventFunctionName) &&
hasDelayProperty &&
(hasDelayDeclarationOrAssignmentGTZero || hasDelayLiteralGTZero)) {
return;
}
context.report({
node,
messageId: 'noAwaitSyncEvents',
data: {
name: `${(_a = (0, node_utils_1.getPropertyIdentifierNode)(node)) === null || _a === void 0 ? void 0 : _a.name}.${simulateEventFunctionName}`,
},
});
},
};
},
});