Skip to content

Commit 21d092a

Browse files
committed
Include configs doc
1 parent 376608e commit 21d092a

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,41 @@ TODO: Then configure the rules you want to use under the rules section.
3636
```json
3737
{
3838
"rules": {
39-
"testing-library/rule-name": 2
39+
"testing-library/await-async-query": "warn",
40+
"testing-library/no-await-sync-query": "error"
4041
}
4142
}
4243
```
4344

45+
## Shareable configurations
46+
47+
### Recommended
48+
49+
This plugin exports a recommended configuration that enforces good Testing Library practices.
50+
51+
To enable this configuration use the `extends` property in your `.eslintrc` config file:
52+
53+
```json
54+
{
55+
"extends": ["plugin:testing-library/recommended"]
56+
}
57+
```
58+
59+
### All
60+
61+
If you want to enable all rules instead of only some you can do so by adding the `all` configuration to your `.eslintrc` config file:
62+
63+
```json
64+
{
65+
"extends": ["plugin:testing-library/all"]
66+
}
67+
```
68+
69+
While the `recommended` configuration only change in major versions, the `all` configuration may change in any release and is thus unsuited for installations requiring long-term consistency.
70+
4471
## Supported Rules
4572

46-
* Fill in provided rules here
73+
* TODO
4774

4875

4976

0 commit comments

Comments
 (0)