Skip to content

Commit 684885c

Browse files
committed
Docs: Move preset list into table in README
1 parent b58b35a commit 684885c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,13 @@ Presets are enabled by adding a line to the `extends` list in your config file.
8585
}
8686
```
8787

88-
* `recommended` enables all recommended rules from this plugin.
89-
* `rules-recommended` enables all recommended rules that are aimed at linting ESLint rule files.
90-
* `tests-recommended` enables all recommended rules that are aimed at linting ESLint test files.
91-
92-
* `all` enables all rules in this plugin.
93-
* `rules` enables all rules that are aimed at linting ESLint rule files.
94-
* `tests` enables all rules that are aimed at linting ESLint test files.
88+
| | Name | Description |
89+
|:--|:-----|:------------|
90+
| ✔️ | `recommended` | enables all recommended rules in this plugin |
91+
| | `rules-recommended` | enables all recommended rules that are aimed at linting ESLint rule files |
92+
| | `tests-recommended` | enables all recommended rules that are aimed at linting ESLint test files |
93+
| | `all` | enables all rules in this plugin |
94+
| | `rules` | enables all rules that are aimed at linting ESLint rule files |
95+
| | `tests` | enables all rules that are aimed at linting ESLint test files |
9596

9697
The list of recommended rules will only change in a major release of this plugin. However, new non-recommended rules might be added in a minor release of this plugin. Therefore, the using the `all`, `rules`, and `tests` presets is **not recommended for production use**, because the addition of new rules in a minor release could break your build.

0 commit comments

Comments
 (0)