Skip to content

Commit 07cd9c9

Browse files
bmishaladdin-add
andauthored
Docs: Move preset list into table in README (#205)
* Docs: Move preset list into table in README * docs: fix duplication Co-authored-by: 唯然 <[email protected]>
1 parent 2e86892 commit 07cd9c9

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,17 @@ Name | ✔️ | 🛠 | 💡 | Description
7575

7676
## Supported Presets
7777

78+
| | Name | Description |
79+
|:--|:-----|:------------|
80+
| ✔️ | `recommended` | enables all recommended rules in this plugin |
81+
| | `rules-recommended` | enables all recommended rules that are aimed at linting ESLint rule files |
82+
| | `tests-recommended` | enables all recommended rules that are aimed at linting ESLint test files |
83+
| | `all` | enables all rules in this plugin |
84+
| | `rules` | enables all rules that are aimed at linting ESLint rule files |
85+
| | `tests` | enables all rules that are aimed at linting ESLint test files |
86+
87+
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.
88+
7889
Presets are enabled by adding a line to the `extends` list in your config file. For example, to enable the `recommended` preset, use:
7990

8091
```json
@@ -101,13 +112,3 @@ Or to apply linting only to the appropriate rule or test files:
101112
]
102113
}
103114
```
104-
105-
* `recommended` enables all recommended rules from this plugin.
106-
* `rules-recommended` enables all recommended rules that are aimed at linting ESLint rule files.
107-
* `tests-recommended` enables all recommended rules that are aimed at linting ESLint test files.
108-
109-
* `all` enables all rules in this plugin.
110-
* `rules` enables all rules that are aimed at linting ESLint rule files.
111-
* `tests` enables all rules that are aimed at linting ESLint test files.
112-
113-
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)