Skip to content

Commit 05030a7

Browse files
committed
docs: update preset formatting and add disable presets in readme
1 parent 591e9d2 commit 05030a7

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,27 +82,38 @@ export default tseslint.config({
8282

8383
### Bare Bones
8484

85-
- **x** (`x`)\
85+
- `x`\
8686
Enable rules for `"react"`.
87-
- **DOM** (`dom`)\
87+
- `dom`\
8888
Enable rules for `"react-dom"`.
89-
- **Web API** (`web-api`)\
89+
- `web-api`\
9090
Enable rules for interacting with Web APIs.
9191

9292
### General Purpose
9393

94-
- **Recommended** (`recommended`)\
94+
- `recommended`\
9595
Enforce rules that are recommended by ESLint React for general purpose React + React DOM projects.\
9696
_This preset includes the `x`, `dom`, and `web-api` presets._
9797

9898
### TypeScript Specialized
9999

100-
- **Recommended TypeScript** (`recommended-typescript`)\
100+
- `recommended-typescript`\
101101
Same as the `recommended` preset but disables rules that can be enforced by TypeScript.
102102

103-
- **Recommended Type-Checked** (`recommended-type-checked`)\
103+
- `recommended-type-checked`\
104104
Same as the `recommended-typescript` preset but enables additional rules that require type information.
105105

106+
### Other
107+
108+
- `disable-dom`\
109+
Disable rules in the `dom` preset.
110+
- `disable-web-api`\
111+
Disable rules in the `web-api` preset.
112+
- `disable-type-checked`\
113+
Disable rules that require type information.
114+
- `off`\
115+
Disable all rules in this plugin except for debug rules.
116+
106117
[Full Presets List ↗](https://eslint-react.xyz/docs/presets)
107118

108119
## Rules

packages/plugins/eslint-plugin/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,27 +82,38 @@ export default tseslint.config({
8282

8383
### Bare Bones
8484

85-
- **x** (`x`)\
85+
- `x`\
8686
Enable rules for `"react"`.
87-
- **DOM** (`dom`)\
87+
- `dom`\
8888
Enable rules for `"react-dom"`.
89-
- **Web API** (`web-api`)\
89+
- `web-api`\
9090
Enable rules for interacting with Web APIs.
9191

9292
### General Purpose
9393

94-
- **Recommended** (`recommended`)\
94+
- `recommended`\
9595
Enforce rules that are recommended by ESLint React for general purpose React + React DOM projects.\
9696
_This preset includes the `x`, `dom`, and `web-api` presets._
9797

9898
### TypeScript Specialized
9999

100-
- **Recommended TypeScript** (`recommended-typescript`)\
100+
- `recommended-typescript`\
101101
Same as the `recommended` preset but disables rules that can be enforced by TypeScript.
102102

103-
- **Recommended Type-Checked** (`recommended-type-checked`)\
103+
- `recommended-type-checked`\
104104
Same as the `recommended-typescript` preset but enables additional rules that require type information.
105105

106+
### Other
107+
108+
- `disable-dom`\
109+
Disable rules in the `dom` preset.
110+
- `disable-web-api`\
111+
Disable rules in the `web-api` preset.
112+
- `disable-type-checked`\
113+
Disable rules that require type information.
114+
- `off`\
115+
Disable all rules in this plugin except for debug rules.
116+
106117
[Full Presets List ↗](https://eslint-react.xyz/docs/presets)
107118

108119
## Rules

0 commit comments

Comments
 (0)