Skip to content

Commit 8452abe

Browse files
committed
Update main doc
1 parent 087fe92 commit 8452abe

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Add `testing-library` to the plugins section of your `.eslintrc` configuration f
2828
}
2929
```
3030

31-
TODO: Then configure the rules you want to use under the rules section.
31+
Then configure the rules you want to use under the rules section.
3232

3333
```json
3434
{
@@ -67,4 +67,9 @@ While the `recommended` configuration only change in major versions, the `all` c
6767

6868
## Supported Rules
6969

70-
- TODO
70+
| Rule | Description | Recommended |
71+
| -------------------------------------------------------- | --------------------------------------------- | ---------------- |
72+
| [await-async-query](docs/rules/await-async-query.md) | Enforce async queries to have proper `await` | ![recommended][] |
73+
| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended][] |
74+
75+
[recommended]: https://img.shields.io/badge/recommended-lightgrey?style=flat-square

docs/rules/await-async-query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enforce async queries (`findBy*`, `findAllBy*`) to have proper `await` (await-async-query)
1+
# Enforce async queries to have proper `await` (await-async-query)
22

33
TODO: Please describe the origin of the rule here.
44

lib/rules/await-async-query.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ module.exports = {
1212
meta: {
1313
type: 'problem',
1414
docs: {
15-
description:
16-
'Enforce async queries (`findBy*`, `findAllBy*`) to have proper `await`',
15+
description: 'Enforce async queries to have proper `await`',
1716
category: 'Best Practices',
1817
recommended: true,
1918
url: 'TODO',

0 commit comments

Comments
 (0)