prefer-presence-queries.js
3.03 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
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
var experimental_utils_1 = require("@typescript-eslint/experimental-utils");
var utils_1 = require("../utils");
var node_utils_1 = require("../node-utils");
exports.RULE_NAME = 'prefer-presence-queries';
var QUERIES_REGEXP = new RegExp("^(get|query)(All)?(" + utils_1.ALL_QUERIES_METHODS.join('|') + ")$");
function isThrowingQuery(node) {
return node.name.startsWith('get');
}
exports.default = experimental_utils_1.ESLintUtils.RuleCreator(utils_1.getDocsUrl)({
name: exports.RULE_NAME,
meta: {
docs: {
category: 'Best Practices',
description: 'Ensure appropriate get*/query* queries are used with their respective matchers',
recommended: 'error',
},
messages: {
presenceQuery: 'Use `getBy*` queries rather than `queryBy*` for checking element is present',
absenceQuery: 'Use `queryBy*` queries rather than `getBy*` for checking element is NOT present',
expectQueryBy: 'Use `getBy*` only when checking elements are present, otherwise use `queryBy*`',
},
schema: [],
type: 'suggestion',
fixable: null,
},
defaultOptions: [],
create: function (context) {
var _a;
return _a = {},
_a["CallExpression Identifier[name=" + QUERIES_REGEXP + "]"] = function (node) {
var expectCallNode = node_utils_1.findClosestCallNode(node, 'expect');
if (expectCallNode && node_utils_1.isMemberExpression(expectCallNode.parent)) {
var expectStatement = expectCallNode.parent;
var property = expectStatement.property;
var matcher = property.name;
var isNegatedMatcher = false;
if (matcher === 'not' &&
node_utils_1.isMemberExpression(expectStatement.parent) &&
node_utils_1.isIdentifier(expectStatement.parent.property)) {
isNegatedMatcher = true;
matcher = expectStatement.parent.property.name;
}
var validMatchers = isThrowingQuery(node)
? utils_1.PRESENCE_MATCHERS
: utils_1.ABSENCE_MATCHERS;
var invalidMatchers = isThrowingQuery(node)
? utils_1.ABSENCE_MATCHERS
: utils_1.PRESENCE_MATCHERS;
var messageId = isThrowingQuery(node)
? 'absenceQuery'
: 'presenceQuery';
if ((!isNegatedMatcher && invalidMatchers.includes(matcher)) ||
(isNegatedMatcher && validMatchers.includes(matcher))) {
return context.report({
node: node,
messageId: messageId,
});
}
}
},
_a;
},
});