prefer-screen-queries.js
5.6 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
"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");
exports.RULE_NAME = 'prefer-screen-queries';
const ALLOWED_RENDER_PROPERTIES_FOR_DESTRUCTURING = [
'container',
'baseElement',
];
function usesContainerOrBaseElement(node) {
const secondArgument = node.arguments[1];
return ((0, node_utils_1.isObjectExpression)(secondArgument) &&
secondArgument.properties.some((property) => (0, node_utils_1.isProperty)(property) &&
utils_1.ASTUtils.isIdentifier(property.key) &&
ALLOWED_RENDER_PROPERTIES_FOR_DESTRUCTURING.includes(property.key.name)));
}
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'suggestion',
docs: {
description: 'Suggest using `screen` while querying',
recommendedConfig: {
dom: 'error',
angular: 'error',
react: 'error',
vue: 'error',
marko: 'error',
},
},
messages: {
preferScreenQueries: 'Avoid destructuring queries from `render` result, use `screen.{{ name }}` instead',
},
schema: [],
},
defaultOptions: [],
create(context, _, helpers) {
const renderWrapperNames = [];
function detectRenderWrapper(node) {
const innerFunction = (0, node_utils_1.getInnermostReturningFunction)(context, node);
if (innerFunction) {
renderWrapperNames.push((0, node_utils_1.getFunctionName)(innerFunction));
}
}
function isReportableRender(node) {
return (helpers.isRenderUtil(node) || renderWrapperNames.includes(node.name));
}
function reportInvalidUsage(node) {
context.report({
node,
messageId: 'preferScreenQueries',
data: {
name: node.name,
},
});
}
function saveSafeDestructuredQueries(node) {
if ((0, node_utils_1.isObjectPattern)(node.id)) {
for (const property of node.id.properties) {
if ((0, node_utils_1.isProperty)(property) &&
utils_1.ASTUtils.isIdentifier(property.key) &&
helpers.isBuiltInQuery(property.key)) {
safeDestructuredQueries.push(property.key.name);
}
}
}
}
function isIdentifierAllowed(name) {
return ['screen', ...withinDeclaredVariables].includes(name);
}
const safeDestructuredQueries = [];
const withinDeclaredVariables = [];
return {
VariableDeclarator(node) {
if (!(0, node_utils_1.isCallExpression)(node.init) ||
!utils_1.ASTUtils.isIdentifier(node.init.callee)) {
return;
}
const isComingFromValidRender = isReportableRender(node.init.callee);
if (!isComingFromValidRender) {
saveSafeDestructuredQueries(node);
}
const isWithinFunction = node.init.callee.name === 'within';
const usesRenderOptions = isComingFromValidRender && usesContainerOrBaseElement(node.init);
if (!isWithinFunction && !usesRenderOptions) {
return;
}
if ((0, node_utils_1.isObjectPattern)(node.id)) {
saveSafeDestructuredQueries(node);
}
else if (utils_1.ASTUtils.isIdentifier(node.id)) {
withinDeclaredVariables.push(node.id.name);
}
},
CallExpression(node) {
const identifierNode = (0, node_utils_1.getDeepestIdentifierNode)(node);
if (!identifierNode) {
return;
}
if (helpers.isRenderUtil(identifierNode)) {
detectRenderWrapper(identifierNode);
}
if (!helpers.isBuiltInQuery(identifierNode)) {
return;
}
if (!(0, node_utils_1.isMemberExpression)(identifierNode.parent)) {
const isSafeDestructuredQuery = safeDestructuredQueries.some((queryName) => queryName === identifierNode.name);
if (isSafeDestructuredQuery) {
return;
}
reportInvalidUsage(identifierNode);
return;
}
const memberExpressionNode = identifierNode.parent;
if ((0, node_utils_1.isCallExpression)(memberExpressionNode.object) &&
utils_1.ASTUtils.isIdentifier(memberExpressionNode.object.callee) &&
memberExpressionNode.object.callee.name !== 'within' &&
isReportableRender(memberExpressionNode.object.callee) &&
!usesContainerOrBaseElement(memberExpressionNode.object)) {
reportInvalidUsage(identifierNode);
return;
}
if (utils_1.ASTUtils.isIdentifier(memberExpressionNode.object) &&
!isIdentifierAllowed(memberExpressionNode.object.name)) {
reportInvalidUsage(identifierNode);
}
},
};
},
});