refactor(no-wait-for-multiple-assertions): migrate to v4 (#301)

* test: improve errors location asserts

* refactor: use new rule creator

* refactor: improve error reported location

* refactor: use new helpers for detection

* test: add more cases

* feat: detect properly if fireEvent and userEvent should be reported

* test: add cases for increasing coverage up to 100%

* refactor: rename rule for consistency

* docs: remove duplicated no-wait-for-snapshot row

* refactor: rename rule

* test: improve errors location asserts

* refactor: use new rule creator

* refactor: use new helpers for detection

* refactor: improve error reported location

* test: add more cases

Author: Belco90

README.md

@@ -137,11 +137,11 @@ To enable this configuration use the `extends` property in your
 | [no-debug](docs/rules/no-debug.md)                                               | Disallow the use of `debug`                                                              | ![angular-badge][] ![react-badge][] ![vue-badge][]                |                    |
 | [no-dom-import](docs/rules/no-dom-import.md)                                     | Disallow importing from DOM Testing Library                                              | ![angular-badge][] ![react-badge][] ![vue-badge][]                | ![fixable-badge][] |
 | [no-manual-cleanup](docs/rules/no-manual-cleanup.md)                             | Disallow the use of `cleanup`                                                            |                                                                   |                    |
-| [no-multiple-assertions-wait-for](docs/rules/no-multiple-assertions-wait-for.md) | Disallow the use of multiple expect inside `waitFor`                                     |                                                                   |                    |
 | [no-node-access](docs/rules/no-node-access.md)                                   | Disallow direct Node access                                                              | ![angular-badge][] ![react-badge][] ![vue-badge][]                |                    |
 | [no-promise-in-fire-event](docs/rules/no-promise-in-fire-event.md)               | Disallow the use of promises passed to a `fireEvent` method                              |                                                                   |                    |
 | [no-render-in-setup](docs/rules/no-render-in-setup.md)                           | Disallow the use of `render` in setup functions                                          |                                                                   |                    |
 | [no-wait-for-empty-callback](docs/rules/no-wait-for-empty-callback.md)           | Disallow empty callbacks for `waitFor` and `waitForElementToBeRemoved`                   | ![dom-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] |                    |
+| [no-wait-for-multiple-assertions](docs/rules/no-wait-for-multiple-assertions.md) | Disallow the use of multiple expect inside `waitFor`                                     |                                                                   |                    |
 | [no-wait-for-side-effects](docs/rules/no-wait-for-side-effects.md)               | Disallow the use of side effects inside `waitFor`                                        |                                                                   |                    |
 | [no-wait-for-snapshot](docs/rules/no-wait-for-snapshot.md)                       | Ensures no snapshot is generated inside of a `waitFor` call                              |                                                                   |                    |
 | [prefer-explicit-assert](docs/rules/prefer-explicit-assert.md)                   | Suggest using explicit assertions rather than just `getBy*` queries                      |                                                                   |                    |

docs/rules/no-multiple-assertions-wait-for.md renamed to docs/rules/no-wait-for-multiple-assertions.md

@@ -1,4 +1,4 @@
-# Multiple assertions inside `waitFor` are not preferred (no-multiple-assertions-wait-for)
+# Multiple assertions inside `waitFor` are not preferred (no-wait-for-multiple-assertions)
 
 ## Rule Details
 

lib/index.ts

@@ -18,7 +18,7 @@ import preferPresenceQueries from './rules/prefer-presence-queries';
 import preferScreenQueries from './rules/prefer-screen-queries';
 import preferUserEvent from './rules/prefer-user-event';
 import preferWaitFor from './rules/prefer-wait-for';
-import noMultipleAssertionsWaitFor from './rules/no-multiple-assertions-wait-for';
+import noWaitForMultipleAssertions from './rules/no-wait-for-multiple-assertions';
 import preferFindBy from './rules/prefer-find-by';
 import noWaitForSideEffects from './rules/no-wait-for-side-effects';
 import renderResultNamingConvention from './rules/render-result-naming-convention';
@@ -34,11 +34,11 @@ const rules = {
   'no-debug': noDebug,
   'no-dom-import': noDomImport,
   'no-manual-cleanup': noManualCleanup,
-  'no-multiple-assertions-wait-for': noMultipleAssertionsWaitFor,
   'no-node-access': noNodeAccess,
   'no-promise-in-fire-event': noPromiseInFireEvent,
   'no-render-in-setup': noRenderInSetup,
   'no-wait-for-empty-callback': noWaitForEmptyCallback,
+  'no-wait-for-multiple-assertions': noWaitForMultipleAssertions,
   'no-wait-for-side-effects': noWaitForSideEffects,
   'no-wait-for-snapshot': noWaitForSnapshot,
   'prefer-explicit-assert': preferExplicitAssert,

lib/rules/no-multiple-assertions-wait-for.ts

@@ -0,0 +1,64 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
+import { getPropertyIdentifierNode } from '../node-utils';
+import { createTestingLibraryRule } from '../create-testing-library-rule';
+
+export const RULE_NAME = 'no-wait-for-multiple-assertions';
+export type MessageIds = 'noWaitForMultipleAssertion';
+type Options = [];
+
+export default createTestingLibraryRule<Options, MessageIds>({
+  name: RULE_NAME,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: "It's preferred to avoid multiple assertions in `waitFor`",
+      category: 'Best Practices',
+      recommended: false,
+    },
+    messages: {
+      noWaitForMultipleAssertion:
+        'Avoid using multiple assertions within `waitFor` callback',
+    },
+    fixable: null,
+    schema: [],
+  },
+  defaultOptions: [],
+  create: function (context, _, helpers) {
+    function totalExpect(body: Array<TSESTree.Node>): Array<TSESTree.Node> {
+      return body.filter((node: TSESTree.ExpressionStatement) => {
+        const expressionIdentifier = getPropertyIdentifierNode(node);
+
+        if (!expressionIdentifier) {
+          return false;
+        }
+
+        return expressionIdentifier.name === 'expect';
+      });
+    }
+
+    function reportMultipleAssertion(node: TSESTree.BlockStatement) {
+      const callExpressionNode = node.parent.parent as TSESTree.CallExpression;
+      const callExpressionIdentifier = getPropertyIdentifierNode(
+        callExpressionNode
+      );
+
+      if (!helpers.isAsyncUtil(callExpressionIdentifier, ['waitFor'])) {
+        return;
+      }
+
+      if (totalExpect(node.body).length <= 1) {
+        return;
+      }
+
+      context.report({
+        node: callExpressionNode,
+        messageId: 'noWaitForMultipleAssertion',
+      });
+    }
+
+    return {
+      'CallExpression > ArrowFunctionExpression > BlockStatement': reportMultipleAssertion,
+      'CallExpression > FunctionExpression > BlockStatement': reportMultipleAssertion,
+    };
+  },
+});