Skip to content

Commit 47aad33

Browse files
committed
Update README and presets documentation
1 parent b34660b commit 47aad33

3 files changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,17 @@ export default defineConfig(
150150
- `strict-type-checked`\
151151
Same as the `strict-typescript` preset but enables additional rules that require type information.
152152

153+
### Category Based
154+
155+
<!-- TODO: Add hooks and performance presets later -->
156+
<!-- - `hooks`\ -->
157+
<!-- Enable all rules related to React Hooks. -->
158+
<!-- - `performance`\ -->
159+
<!-- Enable all rules related to React performance optimizations. -->
160+
161+
- `no-deprecated`\
162+
Enable all rules that disallow deprecated React APIs with "error" severity.
163+
153164
### Other
154165

155166
- `disable-dom`\

apps/website/content/docs/presets.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,24 @@ The following presets are available in `@eslint-react/eslint-plugin`:
2525
## TypeScript Specialized
2626

2727
- `recommended-typescript`\
28-
Same as the `recommended` preset but disables rules that can be enforced by TypeScript.
28+
Same as the `recommended` preset but disables rules that TypeScript can enforce.
2929

3030
- `recommended-type-checked`\
3131
Same as the `recommended-typescript` preset but enables additional rules that require type information.
3232

3333
- `strict-typescript`\
34-
Same as the `strict` preset but disables rules that can be enforced by TypeScript.
34+
Same as the `strict` preset but disables rules that TypeScript can enforce.
3535

3636
- `strict-type-checked`\
3737
Same as the `strict-typescript` preset but enables additional rules that require type information.
3838

39-
## Other
39+
### Category Based
4040

4141
- `no-deprecated`\
42-
Enable all non-deprecated rules from the `x` and `dom` presets.
42+
Enable all rules that disallow deprecated React APIs with "error" severity.
43+
44+
## Other
45+
4346
- `disable-dom`\
4447
Disable rules in the `dom` preset.
4548
- `disable-web-api`\

packages/plugins/eslint-plugin/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,17 @@ export default defineConfig(
150150
- `strict-type-checked`\
151151
Same as the `strict-typescript` preset but enables additional rules that require type information.
152152

153+
### Category Based
154+
155+
<!-- TODO: Add hooks and performance presets later -->
156+
<!-- - `hooks`\ -->
157+
<!-- Enable all rules related to React Hooks. -->
158+
<!-- - `performance`\ -->
159+
<!-- Enable all rules related to React performance optimizations. -->
160+
161+
- `no-deprecated`\
162+
Enable all rules that disallow deprecated React APIs with "error" severity.
163+
153164
### Other
154165

155166
- `disable-dom`\

0 commit comments

Comments
 (0)