| 1 | "use strict";
|
|---|
| 2 | Object.defineProperty(exports, "__esModule", { value: true });
|
|---|
| 3 | exports.RULE_NAME = void 0;
|
|---|
| 4 | const create_testing_library_rule_1 = require("../create-testing-library-rule");
|
|---|
| 5 | const node_utils_1 = require("../node-utils");
|
|---|
| 6 | exports.RULE_NAME = 'prefer-query-by-disappearance';
|
|---|
| 7 | exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
|
|---|
| 8 | name: exports.RULE_NAME,
|
|---|
| 9 | meta: {
|
|---|
| 10 | type: 'problem',
|
|---|
| 11 | docs: {
|
|---|
| 12 | description: 'Suggest using `queryBy*` queries when waiting for disappearance',
|
|---|
| 13 | recommendedConfig: {
|
|---|
| 14 | dom: 'error',
|
|---|
| 15 | angular: 'error',
|
|---|
| 16 | react: 'error',
|
|---|
| 17 | vue: 'error',
|
|---|
| 18 | marko: 'error',
|
|---|
| 19 | },
|
|---|
| 20 | },
|
|---|
| 21 | messages: {
|
|---|
| 22 | preferQueryByDisappearance: 'Prefer using queryBy* when waiting for disappearance',
|
|---|
| 23 | },
|
|---|
| 24 | schema: [],
|
|---|
| 25 | },
|
|---|
| 26 | defaultOptions: [],
|
|---|
| 27 | create(context, _, helpers) {
|
|---|
| 28 | function isWaitForElementToBeRemoved(node) {
|
|---|
| 29 | const identifierNode = (0, node_utils_1.getPropertyIdentifierNode)(node);
|
|---|
| 30 | if (!identifierNode) {
|
|---|
| 31 | return false;
|
|---|
| 32 | }
|
|---|
| 33 | return helpers.isAsyncUtil(identifierNode, ['waitForElementToBeRemoved']);
|
|---|
| 34 | }
|
|---|
| 35 | function reportExpression(node) {
|
|---|
| 36 | const argumentProperty = (0, node_utils_1.isMemberExpression)(node)
|
|---|
| 37 | ? (0, node_utils_1.getPropertyIdentifierNode)(node.property)
|
|---|
| 38 | : (0, node_utils_1.getPropertyIdentifierNode)(node);
|
|---|
| 39 | if (!argumentProperty) {
|
|---|
| 40 | return false;
|
|---|
| 41 | }
|
|---|
| 42 | if (helpers.isGetQueryVariant(argumentProperty) ||
|
|---|
| 43 | helpers.isFindQueryVariant(argumentProperty)) {
|
|---|
| 44 | context.report({
|
|---|
| 45 | node: argumentProperty,
|
|---|
| 46 | messageId: 'preferQueryByDisappearance',
|
|---|
| 47 | });
|
|---|
| 48 | return true;
|
|---|
| 49 | }
|
|---|
| 50 | return false;
|
|---|
| 51 | }
|
|---|
| 52 | function checkNonCallbackViolation(node) {
|
|---|
| 53 | if (!(0, node_utils_1.isCallExpression)(node)) {
|
|---|
| 54 | return false;
|
|---|
| 55 | }
|
|---|
| 56 | if (!(0, node_utils_1.isMemberExpression)(node.callee) &&
|
|---|
| 57 | !(0, node_utils_1.getPropertyIdentifierNode)(node.callee)) {
|
|---|
| 58 | return false;
|
|---|
| 59 | }
|
|---|
| 60 | return reportExpression(node.callee);
|
|---|
| 61 | }
|
|---|
| 62 | function isReturnViolation(node) {
|
|---|
| 63 | if (!(0, node_utils_1.isReturnStatement)(node) || !(0, node_utils_1.isCallExpression)(node.argument)) {
|
|---|
| 64 | return false;
|
|---|
| 65 | }
|
|---|
| 66 | return reportExpression(node.argument.callee);
|
|---|
| 67 | }
|
|---|
| 68 | function isNonReturnViolation(node) {
|
|---|
| 69 | if (!(0, node_utils_1.isExpressionStatement)(node) || !(0, node_utils_1.isCallExpression)(node.expression)) {
|
|---|
| 70 | return false;
|
|---|
| 71 | }
|
|---|
| 72 | if (!(0, node_utils_1.isMemberExpression)(node.expression.callee) &&
|
|---|
| 73 | !(0, node_utils_1.getPropertyIdentifierNode)(node.expression.callee)) {
|
|---|
| 74 | return false;
|
|---|
| 75 | }
|
|---|
| 76 | return reportExpression(node.expression.callee);
|
|---|
| 77 | }
|
|---|
| 78 | function isStatementViolation(statement) {
|
|---|
| 79 | return isReturnViolation(statement) || isNonReturnViolation(statement);
|
|---|
| 80 | }
|
|---|
| 81 | function checkFunctionExpressionViolation(node) {
|
|---|
| 82 | if (!(0, node_utils_1.isFunctionExpression)(node)) {
|
|---|
| 83 | return false;
|
|---|
| 84 | }
|
|---|
| 85 | return node.body.body.some((statement) => isStatementViolation(statement));
|
|---|
| 86 | }
|
|---|
| 87 | function isArrowFunctionBodyViolation(node) {
|
|---|
| 88 | if (!(0, node_utils_1.isArrowFunctionExpression)(node) || !(0, node_utils_1.isBlockStatement)(node.body)) {
|
|---|
| 89 | return false;
|
|---|
| 90 | }
|
|---|
| 91 | return node.body.body.some((statement) => isStatementViolation(statement));
|
|---|
| 92 | }
|
|---|
| 93 | function isArrowFunctionImplicitReturnViolation(node) {
|
|---|
| 94 | if (!(0, node_utils_1.isArrowFunctionExpression)(node) || !(0, node_utils_1.isCallExpression)(node.body)) {
|
|---|
| 95 | return false;
|
|---|
| 96 | }
|
|---|
| 97 | if (!(0, node_utils_1.isMemberExpression)(node.body.callee) &&
|
|---|
| 98 | !(0, node_utils_1.getPropertyIdentifierNode)(node.body.callee)) {
|
|---|
| 99 | return false;
|
|---|
| 100 | }
|
|---|
| 101 | return reportExpression(node.body.callee);
|
|---|
| 102 | }
|
|---|
| 103 | function checkArrowFunctionViolation(node) {
|
|---|
| 104 | return (isArrowFunctionBodyViolation(node) ||
|
|---|
| 105 | isArrowFunctionImplicitReturnViolation(node));
|
|---|
| 106 | }
|
|---|
| 107 | function check(node) {
|
|---|
| 108 | if (!isWaitForElementToBeRemoved(node)) {
|
|---|
| 109 | return;
|
|---|
| 110 | }
|
|---|
| 111 | const argumentNode = node.arguments[0];
|
|---|
| 112 | checkNonCallbackViolation(argumentNode);
|
|---|
| 113 | checkArrowFunctionViolation(argumentNode);
|
|---|
| 114 | checkFunctionExpressionViolation(argumentNode);
|
|---|
| 115 | }
|
|---|
| 116 | return {
|
|---|
| 117 | CallExpression: check,
|
|---|
| 118 | };
|
|---|
| 119 | },
|
|---|
| 120 | });
|
|---|