refactor: improve docs and tests, include also findBy

Author: emmenko

README.md

@@ -135,7 +135,7 @@ To enable this configuration use the `extends` property in your
 | [no-await-sync-query](docs/rules/no-await-sync-query.md)       | Disallow unnecessary `await` for sync queries  | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] |                    |
 | [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][] |
-| [prefer-expect-query-by](docs/rules/prefer-expect-query-by.md) | Disallow the use of `expect(getBy*)`           | ![angular-badge][] ![react-badge][] ![vue-badge][]                        | ![fixable-badge][] |
+| [prefer-expect-query-by](docs/rules/prefer-expect-query-by.md) | Disallow the use of `expect(getBy*)`           | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | ![fixable-badge][] |
 
 [build-badge]: https://img.shields.io/travis/Belco90/eslint-plugin-testing-library?style=flat-square
 [build-url]: https://travis-ci.org/belco90/eslint-plugin-testing-library

docs/rules/prefer-expect-query-by.md

@@ -1,29 +1,57 @@
 # Disallow the use of `expect(getBy*)` (prefer-expect-query-by)
 
-The (DOM) Testing Library support two types of queries: `getBy*` and `queryBy*`. Using `getBy*` throws an error in case the element is not found. This is useful when using method like `waitForElement`, which are `async` functions that will wait for the element to be found until a certain timeout, after that the test will fail.
-However, when trying to assert if an element is not in the document, we can't use `getBy*` as the test will fail immediately. Instead it is recommended to use `queryBy*`, which does not throw and therefore we can assert that `expect(queryByText("Foo")).not.toBeInTheDocument()`.
+The (DOM) Testing Library support three types of queries: `getBy*`, `findBy*` and `queryBy*`. Using `getBy*` or `findBy*` throws an error in case the element is not found. This is useful when using method like `waitForElement`, which are `async` functions that will wait for the element to be found until a certain timeout, after that the test will fail.
+However, when trying to assert if an element is not in the document, we can't use `getBy*` or `findBy*` as the test will fail immediately. Instead it is recommended to use `queryBy*`, which does not throw and therefore we can assert that e.g. `expect(queryByText("Foo")).not.toBeInTheDocument()`.
+
+> The same applies for the `getAll*`, `findAll*` and `queryAll*` queries.
 
 ## Rule details
 
-This rule gives a notification whenever `expect(getBy*)` is used.
+This rule gives a notification whenever `expect` is used with one of the query functions that throw an error if the element is not found.
 
 This rule is enabled by default.
 
-### Default configuration
-
-The following patterns is considered erroneous:
+Examples of **incorrect** code for this rule:
 
 ```js
 test('some test', () => {
+  const { getByText, getAllByText } = render(<App />);
+  expect(getByText('Foo')).toBeInTheDocument();
+  expect(getAllByText('Foo')[0]).toBeInTheDocument();
   expect(getByText('Foo')).not.toBeInTheDocument();
+  expect(getAllByText('Foo')[0]).not.toBeInTheDocument();
+});
+```
+
+```js
+test('some test', () => {
+  const rendered = render(<App />);
+  expect(rendered.getByText('Foo')).toBeInTheDocument();
+  expect(rendered.getAllByText('Foo')[0]).toBeInTheDocument();
+  expect(rendered.getByText('Foo')).not.toBeInTheDocument();
+  expect(rendered.getAllByText('Foo')[0]).not.toBeInTheDocument();
 });
 ```
 
-The following pattern is considered non erroneous:
+Examples of **correct** code for this rule:
 
 ```js
-test('some test', async () => {
+test('some test', () => {
+  const { queryByText, queryAllByText } = render(<App />);
+  expect(queryByText('Foo')).toBeInTheDocument();
+  expect(queryAllByText('Foo')[0]).toBeInTheDocument();
   expect(queryByText('Foo')).not.toBeInTheDocument();
+  expect(queryAllByText('Foo')[0]).not.toBeInTheDocument();
+});
+```
+
+```js
+test('some test', () => {
+  const rendered = render(<App />);
+  expect(rendered.queryByText('Foo')).toBeInTheDocument();
+  expect(rendered.queryAllByText('Foo')[0]).toBeInTheDocument();
+  expect(rendered.queryByText('Foo')).not.toBeInTheDocument();
+  expect(rendered.queryAllByText('Foo')[0]).not.toBeInTheDocument();
 });
 ```
 

lib/rules/prefer-expect-query-by.js

@@ -16,7 +16,12 @@ function isMemberExpression(node) {
 }
 
 function isUsingWrongQueries(node) {
-  return node.name.startsWith('getBy') || node.name.startsWith('getAllBy');
+  return (
+    node.name.startsWith('getBy') ||
+    node.name.startsWith('getAllBy') ||
+    node.name.startsWith('findBy') ||
+    node.name.startsWith('findAllBy')
+  );
 }
 
 function isNotNullOrUndefined(input) {
@@ -89,7 +94,10 @@ module.exports = {
           fix(fixer) {
             return fixer.replaceText(
               nodesGetBy[0],
-              nodesGetBy[0].name.replace(/^(get(All)?(.*))$/, 'query$2$3')
+              nodesGetBy[0].name.replace(
+                /^((get|find)(All)?(.*))$/,
+                'query$3$4'
+              )
             );
           },
         });

tests/lib/rules/prefer-expect-query-by.js

@@ -15,23 +15,74 @@ ruleTester.run('prefer-expect-query-by', rule, {
     {
       code: "expect(rendered.queryAllByText('Hello')).not.toBeInTheDocument()",
     },
+    { code: "expect(queryByText('Hello')).toBeInTheDocument()" },
+    { code: "expect(rendered.queryByText('Hello')).toBeInTheDocument()" },
+    { code: "expect(queryAllByText('Hello')).toBeInTheDocument()" },
+    {
+      code: "expect(rendered.queryAllByText('Hello')).toBeInTheDocument()",
+    },
   ],
   invalid: [
     {
       code: "expect(getByText('Hello')).not.toBeInTheDocument()",
       errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryByText('Hello')).not.toBeInTheDocument()",
     },
     {
       code: "expect(rendered.getByText('Hello')).not.toBeInTheDocument()",
       errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(rendered.queryByText('Hello')).not.toBeInTheDocument()",
     },
     {
       code: "expect(getAllByText('Hello')).not.toBeInTheDocument()",
       errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryAllByText('Hello')).not.toBeInTheDocument()",
     },
     {
       code: "expect(rendered.getAllByText('Hello')).not.toBeInTheDocument()",
       errors: [{ messageId: 'expectQueryBy' }],
+      output:
+        "expect(rendered.queryAllByText('Hello')).not.toBeInTheDocument()",
+    },
+    {
+      code: "expect(getByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(rendered.getByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(rendered.queryByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(getAllByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryAllByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(rendered.getAllByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(rendered.queryAllByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(findByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(rendered.findByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(rendered.queryByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(findAllByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(queryAllByText('Hello')).toBeInTheDocument()",
+    },
+    {
+      code: "expect(rendered.findAllByText('Hello')).toBeInTheDocument()",
+      errors: [{ messageId: 'expectQueryBy' }],
+      output: "expect(rendered.queryAllByText('Hello')).toBeInTheDocument()",
     },
   ],
 });