Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pkgs/configs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@stylistic/eslint-plugin": "^5.3.1",
"eslint-plugin-de-morgan": "^1.3.1",
"eslint-plugin-function": "^0.0.25",
"eslint-plugin-jsdoc": "^54.4.0",
"eslint-plugin-jsdoc": "^54.5.0",
"eslint-plugin-perfectionist": "^4.15.0",
"eslint-plugin-regexp": "^2.10.0",
"eslint-plugin-unicorn": "^61.0.1",
Expand Down
2 changes: 1 addition & 1 deletion .pkgs/eslint-plugin-local/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"@typescript-eslint/types": "^8.42.0",
"@typescript-eslint/utils": "^8.42.0",
"eslint-plugin-de-morgan": "^1.3.1",
"eslint-plugin-jsdoc": "^54.4.0",
"eslint-plugin-jsdoc": "^54.5.0",
"eslint-plugin-perfectionist": "^4.15.0",
"eslint-plugin-regexp": "^2.10.0",
"eslint-plugin-unicorn": "^61.0.1",
Expand Down
26 changes: 0 additions & 26 deletions apps/website/content/docs/configuration/configure-analyzer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,26 +56,6 @@ Example with `polymorphicPropName` set to `as`:
// Evaluated as an h3 element
```

### `additionalHooks` (Experimental)

<Callout type="warn">
Intended for edge cases. We suggest to use this option **very sparingly, if at
all**. Generally saying, we recommend most custom Hooks do not vary the
built-in React Hooks, and instead provide a higher-level API that is more
focused around a specific use case.
</Callout>

Alias variants to built-in React Hooks for rule compatibility:

```js
additionalHooks: {
useEffect: ["useIsomorphicLayoutEffect"],
useLayoutEffect: ["useIsomorphicLayoutEffect"]
}
```

Treats `useIsomorphicLayoutEffect` as both `useEffect` and `useLayoutEffect` in rule checks.

## Complete Configuration Example

```ts title="eslint.config.js"
Expand All @@ -89,12 +69,6 @@ export default [
version: "19.1.0", // Specify the React version for semantic analysis (can be "detect" for auto-detection)
importSource: "react", // Customize the import source for the React module (defaults to "react")
polymorphicPropName: "as", // Define the prop name used for polymorphic components (e.g., <Component as="div">)

// (Experimental) Alias custom Hooks to built-in React Hooks for rule compatibility
additionalHooks: {
useEffect: ["useIsomorphicLayoutEffect"],
useLayoutEffect: ["useIsomorphicLayoutEffect"],
},
},
},
},
Expand Down
34 changes: 0 additions & 34 deletions apps/website/content/docs/configuration/configure-analyzer.tsx
Original file line number Diff line number Diff line change
@@ -1,43 +1,9 @@
/* eslint-disable perfectionist/sort-objects */
import { CodeBlock } from "#/components/ui/CodeBlock";
import dedent from "dedent";
import { TypeTable } from "fumadocs-ui/components/type-table";

import { Link } from "next-view-transitions";

const properties = {
additionalHooks: {
type: "Record<ReactBuiltInHookName, string[]>",
description: <Link href="#additionalhooks">An object of aliases for React built-in Hooks ⤵</Link>,
default: "{}",
typeDescription: (
<CodeBlock
code={dedent`
type ReactBuiltInHookName =
| "use"
| "useActionState"
| "useCallback"
| "useContext"
| "useDebugValue"
| "useDeferredValue"
| "useEffect"
| "useFormStatus"
| "useId"
| "useImperativeHandle"
| "useInsertionEffect"
| "useLayoutEffect"
| "useMemo"
| "useOptimistic"
| "useReducer"
| "useRef"
| "useState"
| "useSyncExternalStore"
| "useTransition";
`}
lang="ts"
/>
),
},
polymorphicPropName: {
type: "string",
description: <Link href="#polymorphicpropname">The prop your code uses to create polymorphic components ⤵</Link>,
Expand Down
27 changes: 14 additions & 13 deletions apps/website/content/docs/deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@ full: true

## Rules

| Rule | Replaced by | Deprecated in |
| :--------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :------------ |
| [`ensure-custom-hooks-using-other-hooks`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.13.0 |
| [`ensure-forward-ref-using-ref`](/docs/rules/ensure-forward-ref-using-ref) | [`no-useless-forward-ref`](/docs/rules/no-useless-forward-ref) | 1.33.0 |
| [`ensure-use-callback-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-callback-has-non-empty-deps) | [`no-unnecessary-use-callback`](/docs/rules/hooks-extra-no-unnecessary-use-callback) | 1.13.0 |
| [`ensure-use-memo-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-memo-has-non-empty-deps) | [`no-unnecessary-use-memo`](/docs/rules/hooks-extra-no-unnecessary-use-memo) | 1.13.0 |
| [`no-children-in-void-dom-elements`](/docs/rules/dom-no-children-in-void-dom-elements) | [`no-void-elements-with-children`](/docs/rules/dom-no-void-elements-with-children) | 1.22.0 |
| [`no-complicated-conditional-rendering`](/docs/rules/no-complicated-conditional-rendering) | [`no-complex-conditional-rendering`](/docs/rules/no-complex-conditional-rendering) | 1.6.0 |
| [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props) | [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props) | 1.22.0 |
| [`no-nested-components`](/docs/rules/no-nested-components) | [`no-nested-component-definitions`](/docs/rules/no-nested-component-definitions) | 1.34.0 |
| [`no-redundant-custom-hook`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.21.0 |
| [`no-useless-custom-hooks`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.21.0 |
| [`use-jsx-vars`](/docs/rules/use-jsx-vars) | [`jsx-uses-vars`](/docs/rules/jsx-uses-vars) | 1.22.0 |
| Rule | Replaced by | Deprecated in |
| :------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- | :------------ |
| [`ensure-forward-ref-using-ref`](/docs/rules/ensure-forward-ref-using-ref) | [`no-useless-forward-ref`](/docs/rules/no-useless-forward-ref) | 1.33.0 |
| [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props) | [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props) | 1.22.0 |
| [`no-complicated-conditional-rendering`](/docs/rules/no-complicated-conditional-rendering) | [`no-complex-conditional-rendering`](/docs/rules/no-complex-conditional-rendering) | 1.6.0 |
| [`no-nested-components`](/docs/rules/no-nested-components) | [`no-nested-component-definitions`](/docs/rules/no-nested-component-definitions) | 1.34.0 |
| [`use-jsx-vars`](/docs/rules/use-jsx-vars) | [`jsx-uses-vars`](/docs/rules/jsx-uses-vars) | 1.22.0 |
| [`dom/no-children-in-void-dom-elements`](/docs/rules/dom-no-children-in-void-dom-elements) | [`dom/no-void-elements-with-children`](/docs/rules/dom-no-void-elements-with-children) | 1.22.0 |
| [`hooks-extra/ensure-custom-hooks-using-other-hooks`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`hooks-extra/no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.13.0 |
| [`hooks-extra/ensure-use-callback-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-callback-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-callback`](/docs/rules/hooks-extra-no-unnecessary-use-callback) | 1.13.0 |
| [`hooks-extra/ensure-use-memo-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-memo-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-memo`](/docs/rules/hooks-extra-no-unnecessary-use-memo) | 1.13.0 |
| [`hooks-extra/no-direct-set-state-in-use-layout-effect`](/docs/rules/hooks-extra-no-direct-set-state-in-use-layout-effect) | [`hooks-extra/no-direct-set-state-in-use-effect`](/docs/rules/hooks-extra-no-direct-set-state-in-use-effect) | 2.0.0 |
| [`hooks-extra/no-redundant-custom-hook`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`hooks-extra/no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.21.0 |
| [`hooks-extra/no-useless-custom-hooks`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | [`hooks-extra/no-unnecessary-use-prefix`](/docs/rules/hooks-extra-no-unnecessary-use-prefix) | 1.21.0 |

## Presets

Expand Down
1 change: 0 additions & 1 deletion apps/website/content/docs/rules/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@
"web-api-no-leaked-timeout",
"---Hooks Extra Rules---",
"hooks-extra-no-direct-set-state-in-use-effect",
"hooks-extra-no-direct-set-state-in-use-layout-effect",
"---Naming Convention Rules---",
"naming-convention-component-name",
"naming-convention-context-name",
Expand Down
7 changes: 3 additions & 4 deletions apps/website/content/docs/rules/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,9 @@ full: true
This section contains rules that are not part of the official `eslint-plugin-react-hooks` plugin but are useful for specific use cases or patterns.
</Callout>

| Rule | ✅ | 🌟 | Description |
| :--------------------------------------------------------------------------------------------------- | :-- | :--: | :----------------------------------------------------------------------------- |
| [`no-direct-set-state-in-use-effect`](./hooks-extra-no-direct-set-state-in-use-effect) | 1️⃣ | `🧪` | Disallow direct calls to the `set` function of `useState` in `useEffect` |
| [`no-direct-set-state-in-use-layout-effect`](./hooks-extra-no-direct-set-state-in-use-layout-effect) | 0️⃣ | `🧪` | Disallow direct calls to the `set` function of `useState` in `useLayoutEffect` |
| Rule | ✅ | 🌟 | Description |
| :------------------------------------------------------------------------------------- | :-- | :--: | :----------------------------------------------------------------------- |
| [`no-direct-set-state-in-use-effect`](./hooks-extra-no-direct-set-state-in-use-effect) | 1️⃣ | `🧪` | Disallow direct calls to the `set` function of `useState` in `useEffect` |

## Naming Convention Rules

Expand Down
2 changes: 1 addition & 1 deletion examples/react-dom-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"eslint-plugin-react-hooks": "^5.2.0",
"eslint-plugin-react-refresh": "^0.4.20",
"globals": "^16.3.0",
"vite": "^7.1.4"
"vite": "^7.1.5"
},
"engines": {
"node": ">=20.19.0"
Expand Down
22 changes: 0 additions & 22 deletions examples/react-dom-v1/.gitignore

This file was deleted.

5 changes: 0 additions & 5 deletions examples/react-dom-v1/.vscode/extensions.json

This file was deleted.

5 changes: 0 additions & 5 deletions examples/react-dom-v1/.vscode/settings.json

This file was deleted.

1 change: 0 additions & 1 deletion examples/react-dom-v1/eslint.config.d.ts

This file was deleted.

159 changes: 0 additions & 159 deletions examples/react-dom-v1/eslint.config.js

This file was deleted.

13 changes: 0 additions & 13 deletions examples/react-dom-v1/index.html

This file was deleted.

Loading