Skip to content

Commit b24cb35

Browse files
Rel1cxRel1cx
committed
docs: update changelog and overview for rule renaming and deprecations
1 parent 27054a2 commit b24cb35

File tree

3 files changed

+17
-27
lines changed

3 files changed

+17
-27
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,12 +352,12 @@ function useAuth() {
352352

353353
### 🐞 Fixes
354354

355-
- `hooks-extra/no-useless-custom-hooks` should allow custom Hooks with empty body
355+
- `hooks-extra/no-redundant-custom-hook` should allow custom Hooks with empty body
356356

357357
### 🪄 Improvements
358358

359359
- Rename `debug/react-hooks` to `debug/hook`
360-
- Rename `hooks-extra/ensure-custom-using-hooks` to `hooks-extra/no-useless-custom-hooks`
360+
- Rename `hooks-extra/ensure-custom-using-hooks` to `hooks-extra/no-redundant-custom-hook`
361361
- Rename `hooks-extra/ensure-use-memo-has-non-empty-deps` to `hooks-extra/no-unnecessary-use-memo`
362362
- Rename `hooks-extra/ensure-use-callback-has-non-empty-deps` to `hooks-extra/no-unnecessary-use-callback`
363363
- Upgrade `@typescript-eslint`'s packages to `^8.4.0`

‎apps/website/content/docs/changelog.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -356,12 +356,12 @@ function useAuth() {
356356

357357
### 🐞 Fixes
358358

359-
- `hooks-extra/no-useless-custom-hooks` should allow custom Hooks with empty body
359+
- `hooks-extra/no-redundant-custom-hook` should allow custom Hooks with empty body
360360

361361
### 🪄 Improvements
362362

363363
- Rename `debug/react-hooks` to `debug/hook`
364-
- Rename `hooks-extra/ensure-custom-using-hooks` to `hooks-extra/no-useless-custom-hooks`
364+
- Rename `hooks-extra/ensure-custom-using-hooks` to `hooks-extra/no-redundant-custom-hook`
365365
- Rename `hooks-extra/ensure-use-memo-has-non-empty-deps` to `hooks-extra/no-unnecessary-use-memo`
366366
- Rename `hooks-extra/ensure-use-callback-has-non-empty-deps` to `hooks-extra/no-unnecessary-use-callback`
367367
- Upgrade `@typescript-eslint`'s packages to `^8.4.0`

‎apps/website/content/docs/rules/overview.md‎

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,6 @@ full: true
7171
| [`prefer-shorthand-fragment`](./prefer-shorthand-fragment) | 0️⃣ | `🔍` `🔧` | Enforces using shorthand syntax for fragments. | |
7272
| [`use-jsx-vars`](./use-jsx-vars) | 1️⃣ | | Marks variables used in JSX as used. | |
7373

74-
### Deprecated
75-
76-
| Rule | Replaced by |
77-
| :----------------------------------------------------------------------------- | :----------------------------------------------------------------------- |
78-
| [`jsx-uses-vars`](jsx-uses-vars) | [`use-jsx-vars`](./use-jsx-vars) |
79-
| [`jsx-no-duplicate-props`](jsx-no-duplicate-props) | [`no-duplicate-jsx-props`](./no-duplicate-jsx-props) |
80-
| [`no-complicated-conditional-rendering`](no-complicated-conditional-rendering) | [`no-complex-conditional-rendering`](./no-complex-conditional-rendering) |
81-
8274
## DOM Rules
8375

8476
| Rule | ✅ | Features | Description |
@@ -96,12 +88,6 @@ full: true
9688
| [`no-unsafe-iframe-sandbox`](./dom-no-unsafe-iframe-sandbox) | 1️⃣ | `🔍` | Enforces `sandbox` attribute for `iframe` elements is not set to unsafe combinations. |
9789
| [`no-unsafe-target-blank`](./dom-no-unsafe-target-blank) | 1️⃣ | `🔍` | Prevents using `target="_blank"` without `rel="noreferrer noopener"`. |
9890

99-
### Deprecated
100-
101-
| Rule | Replaced by |
102-
| :----------------------------------------------------------------------------- | :----------------------------------------------------------------------- |
103-
| [`dom-no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements) | [`no-void-elements-with-children`](./dom-no-void-elements-with-children) |
104-
10591
## Web API Rules
10692

10793
| Rule | ✅ | Features | Description |
@@ -122,15 +108,6 @@ full: true
122108
| [`no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks) | 1️⃣ | `🔍` | Enforces custom Hooks to use at least one other Hook inside. |
123109
| [`prefer-use-state-lazy-initialization`](./hooks-extra-prefer-use-state-lazy-initialization) | 1️⃣ | `🔍` | Enforces function calls made inside `useState` to be wrapped in an `initializer function`. |
124110

125-
### Deprecated
126-
127-
| Rule | Replaced by |
128-
| :--------------------------------------------------------------------------------- | :------------------------------------------------------------------------- |
129-
| [`no-redundant-custom-hook`](hooks-extra-no-useless-custom-hooks) | [`no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks) |
130-
| [`ensure-custom-hooks-using-other-hooks`](hooks-extra-no-useless-custom-hooks) | [`no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks) |
131-
| [`ensure-use-memo-has-non-empty-deps`](ensure-use-memo-has-non-empty-deps) | [`no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo) |
132-
| [`ensure-use-callback-has-non-empty-deps`](ensure-use-callback-has-non-empty-deps) | [`no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) |
133-
134111
## Naming Convention Rules
135112

136113
| Rule | ✅ | Features | Description |
@@ -148,3 +125,16 @@ full: true
148125
| [`function-component`](./debug-function-component) | 0️⃣ | `🐞` | Reports all function components. |
149126
| [`hook`](./debug-hook) | 0️⃣ | `🐞` | Reports all react hooks. |
150127
| [`is-from-react`](./debug-is-from-react) | 0️⃣ | `🐞` | Reports all identifiers that are initialized from React. |
128+
129+
## Deprecated Rules
130+
131+
| Rule | Replaced by | Deprecated at |
132+
| :--------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------------- |
133+
| [`jsx-uses-vars`](jsx-uses-vars) | [`use-jsx-vars`](./use-jsx-vars) | v1.22.0 (2024-12-22) |
134+
| [`jsx-no-duplicate-props`](jsx-no-duplicate-props) | [`no-duplicate-jsx-props`](./no-duplicate-jsx-props) | v1.22.0 (2024-12-22) |
135+
| [`no-complicated-conditional-rendering`](no-complicated-conditional-rendering) | [`no-complex-conditional-rendering`](./no-complex-conditional-rendering) | v1.6.0 (2024-07-27) |
136+
| [`dom/no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements) | [`dom/no-void-elements-with-children`](./dom-no-void-elements-with-children) | v1.22.0 (2024-12-22) |
137+
| [`hooks-extra/no-redundant-custom-hook`](hooks-extra-no-useless-custom-hooks) | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks) | v1.21.0 (2024-12-20) |
138+
| [`hooks-extra/ensure-custom-hooks-using-other-hooks`](hooks-extra-no-useless-custom-hooks) | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks) | v1.13.0 (2024-09-04) |
139+
| [`hooks-extra/ensure-use-memo-has-non-empty-deps`](ensure-use-memo-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo) | v1.13.0 (2024-09-04) |
140+
| [`hooks-extra/ensure-use-callback-has-non-empty-deps`](ensure-use-callback-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | v1.13.0 (2024-09-04) |

0 commit comments

Comments
 (0)