Update doc for rules

Author: Belco90

docs/rules/await-async-query.md

@@ -1,31 +1,60 @@
 # Enforce async queries to have proper `await` (await-async-query)
 
-TODO: Please describe the origin of the rule here.
+Ensure that promises returned by async queries are handled properly.
 
 ## Rule Details
 
-This rule aims to...
+Some of the queries variants that Testing Library provides are
+asynchronous as they return a promise which resolves when elements are
+found. Those queries variants are:
+
+- `findBy*`
+- `findByAll*`
+
+This rule aims to prevent users from forgetting to await the returned
+promise from those async queries to be fulfilled, which could lead to
+errors in the tests. The promises can be handled by using either `await`
+operator or `then` method.
 
 Examples of **incorrect** code for this rule:
 
 ```js
-// TODO: fill me in
+const foo = () => {
+  // ...
+  const rows = findAllByRole('row');
+  // ...
+};
+
+const bar = () => {
+  // ...
+  findByText('submit');
+  // ...
+};
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
-// TODO: fill me in
+// `await` operator is correct
+const foo = async () => {
+  // ...
+  const rows = await findAllByRole('row');
+  // ...
+};
+
+// `then` method is correct
+const bar = () => {
+  // ...
+  findByText('submit').then(() => {
+    // ...
+  });
+};
+
+// return the promise within a function is correct too!
+const findMyButton = () => findByText('my button');
 ```
 
-### Options
-
-TODO: If there are any options, describe them here. Otherwise, delete this section.
-
-## When Not To Use It
-
-TODO: Give a short description of when it would be appropriate to turn off this rule.
-
 ## Further Reading
 
+- [Async queries variants](https://testing-library.com/docs/dom-testing-library/api-queries#findby)
 - [Testing Library queries cheatsheet](https://testing-library.com/docs/dom-testing-library/cheatsheet#queries)

docs/rules/no-await-sync-query.md

@@ -1,31 +1,53 @@
 # Disallow unnecessary `await` for sync queries (no-await-sync-query)
 
-TODO: Please describe the origin of the rule here.
+Ensure sync queries
 
 ## Rule Details
 
-This rule aims to...
+Usual queries variants that Testing Library provides are synchronous and
+don't need to wait for any element. Those queries are:
+
+- `getBy*`
+- `getByAll*`
+- `queryBy*`
+- `queryAllBy*`
+
+This rule aims to prevent users from waiting for synchronous queries.
 
 Examples of **incorrect** code for this rule:
 
 ```js
-// TODO: fill me in
+const foo = async () => {
+  // ...
+  const rows = await queryAllByRole('row');
+  // ...
+};
+
+const bar = () => {
+  // ...
+  getByText('submit').then(() => {
+    // ...
+  });
+};
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
-// TODO: fill me in
+const foo = () => {
+  // ...
+  const rows = queryAllByRole('row');
+  // ...
+};
+
+const bar = () => {
+  // ...
+  const button = getByText('submit');
+  // ...
+};
 ```
 
-### Options
-
-TODO: If there are any options, describe them here. Otherwise, delete this section.
-
-## When Not To Use It
-
-TODO: Give a short description of when it would be appropriate to turn off this rule.
-
 ## Further Reading
 
+- [Sync queries variants](https://testing-library.com/docs/dom-testing-library/api-queries#variants)
 - [Testing Library queries cheatsheet](https://testing-library.com/docs/dom-testing-library/cheatsheet#queries)

lib/rules/await-async-query.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { getDocsUrl } = require('../utils');
+
 const VALID_PARENTS = [
   'AwaitExpression',
   'ArrowFunctionExpression',
@@ -15,7 +17,7 @@ module.exports = {
       description: 'Enforce async queries to have proper `await`',
       category: 'Best Practices',
       recommended: true,
-      url: 'TODO',
+      url: getDocsUrl('await-async-query'),
     },
     messages: {
       awaitAsyncQuery: '`{{ name }}` must have `await` operator',

lib/rules/no-await-sync-query.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { getDocsUrl } = require('../utils');
+
 const SYNC_QUERIES_REGEXP = /^(get|query)(All)?By(LabelText|PlaceholderText|Text|AltText|Title|DisplayValue|Role|TestId)$/;
 
 module.exports = {
@@ -9,7 +11,7 @@ module.exports = {
       description: 'Disallow unnecessary `await` for sync queries',
       category: 'Best Practices',
       recommended: true,
-      url: 'TODO',
+      url: getDocsUrl('no-await-sync-query'),
     },
     messages: {
       noAwaitSyncQuery: '`{{ name }}` does not need `await` operator',

lib/utils.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const getDocsUrl = ruleName =>
+  `https://github.com/Belco90/eslint-plugin-testing-library/tree/master/docs/rules/${ruleName}.md`;
+
+module.exports = {
+  getDocsUrl,
+};