eslint-plugin-react-hooks 5.2.0 → 6.0.0-canary-e5dd82a7-20250401

package/README.md

@@ -18,25 +18,14 @@ npm install eslint-plugin-react-hooks --save-dev
 yarn add eslint-plugin-react-hooks --dev
 ```
 
-### Legacy Config (.eslintrc)
-
-If you are still using ESLint below 9.0.0, please continue to use `recommended-legacy`. To avoid breaking changes, we still support `recommended` as well, but note that this will be changed to alias the flat recommended config in v6.
-
-```js
-{
-  "extends": [
-    // ...
-    "plugin:react-hooks/recommended-legacy"
-  ]
-}
-```
+### Flat Config (eslint.config.js|ts)
 
-### Flat Config (eslint.config.js)
+#### 5.2.0
 
-For [ESLint 9.0.0 and above](https://eslint.org/blog/2024/04/eslint-v9.0.0-released/) users, add the `recommended-latest` config.
+For users of 5.2.0 (the first version with flat config support), add the `recommended-latest` config.
 
 ```js
-import reactHooks from 'eslint-plugin-react-hooks';
+import * as reactHooks from 'eslint-plugin-react-hooks';
 
 export default [
   // ...
@@ -44,30 +33,42 @@ export default [
 ];
 ```
 
-### Custom Configuration
+### Legacy Config (.eslintrc)
 
-If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:
+#### >= 5.2.0
 
-#### Legacy Config (.eslintrc)
+If you are still using ESLint below 9.0.0, you can use `recommended-legacy` for accessing a legacy version of the recommended config.
 
 ```js
 {
-  "plugins": [
+  "extends": [
     // ...
-    "react-hooks"
-  ],
-  "rules": {
+    "plugin:react-hooks/recommended-legacy"
+  ]
+}
+```
+
+#### < 5.2.0
+
+If you're using a version earlier than 5.2.0, the legacy config was simply `recommended`.
+
+```js
+{
+  "extends": [
     // ...
-    "react-hooks/rules-of-hooks": "error",
-    "react-hooks/exhaustive-deps": "warn"
-  }
+    "plugin:react-hooks/recommended"
+  ]
 }
 ```
 
-#### Flat Config (eslint.config.js)
+### Custom Configuration
+
+If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:
+
+#### Flat Config (eslint.config.js|ts)
 
 ```js
-import reactHooks from 'eslint-plugin-react-hooks';
+import * as reactHooks from 'eslint-plugin-react-hooks';
 
 export default [
   {
@@ -82,6 +83,21 @@ export default [
 ];
 ```
 
+#### Legacy Config (.eslintrc)
+```js
+{
+  "plugins": [
+    // ...
+    "react-hooks"
+  ],
+  "rules": {
+    // ...
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn"
+  }
+}
+```
+
 ## Advanced Configuration
 
 `exhaustive-deps` can be configured to validate dependencies of custom Hooks with the `additionalHooks` option.
@@ -89,10 +105,10 @@ This option accepts a regex to match the names of custom Hooks that have depende
 
 ```js
 {
-  "rules": {
+  rules: {
     // ...
     "react-hooks/exhaustive-deps": ["warn", {
-      "additionalHooks": "(useMyCustomHook|useMyOtherCustomHook)"
+      additionalHooks: "(useMyCustomHook|useMyOtherCustomHook)"
     }]
   }
 }

package/cjs/eslint-plugin-react-hooks.d.ts

@@ -2,27 +2,6 @@ import * as estree from 'estree';
 import { Rule, ESLint } from 'eslint';
 
 declare const rules: {
-    'rules-of-hooks': {
-        meta: {
-            type: "problem";
-            docs: {
-                description: string;
-                recommended: true;
-                url: string;
-            };
-        };
-        create(context: Rule.RuleContext): {
-            onCodePathSegmentStart: (segment: Rule.CodePathSegment) => number;
-            onCodePathSegmentEnd: () => Rule.CodePathSegment | undefined;
-            onCodePathStart: () => number;
-            onCodePathEnd(codePath: Rule.CodePath, codePathNode: Rule.Node): void;
-            CallExpression(node: estree.CallExpression & Rule.NodeParentExtension): void;
-            Identifier(node: estree.Identifier & Rule.NodeParentExtension): void;
-            'CallExpression:exit'(node: estree.CallExpression & Rule.NodeParentExtension): void;
-            FunctionDeclaration(node: estree.FunctionDeclaration & Rule.NodeParentExtension): void;
-            ArrowFunctionExpression(node: estree.ArrowFunctionExpression & Rule.NodeParentExtension): void;
-        };
-    };
     'exhaustive-deps': {
         meta: {
             type: "suggestion";
@@ -51,9 +30,30 @@ declare const rules: {
             CallExpression: (node: estree.CallExpression) => void;
         };
     };
+    'react-compiler': Rule.RuleModule;
+    'rules-of-hooks': {
+        meta: {
+            type: "problem";
+            docs: {
+                description: string;
+                recommended: true;
+                url: string;
+            };
+        };
+        create(context: Rule.RuleContext): {
+            onCodePathSegmentStart: (segment: Rule.CodePathSegment) => number;
+            onCodePathSegmentEnd: () => Rule.CodePathSegment | undefined;
+            onCodePathStart: () => number;
+            onCodePathEnd(codePath: Rule.CodePath, codePathNode: Rule.Node): void;
+            CallExpression(node: estree.CallExpression & Rule.NodeParentExtension): void;
+            Identifier(node: estree.Identifier & Rule.NodeParentExtension): void;
+            'CallExpression:exit'(node: estree.CallExpression & Rule.NodeParentExtension): void;
+            FunctionDeclaration(node: estree.FunctionDeclaration & Rule.NodeParentExtension): void;
+            ArrowFunctionExpression(node: estree.ArrowFunctionExpression & Rule.NodeParentExtension): void;
+        };
+    };
 };
 declare const configs: {
-    /** Legacy recommended config, to be used with rc-based configurations */
     'recommended-legacy': {
         plugins: string[];
         rules: {
@@ -61,18 +61,16 @@ declare const configs: {
             'react-hooks/exhaustive-deps': "warn";
         };
     };
-    /**
-     * 'recommended' is currently aliased to the legacy / rc recommended config) to maintain backwards compatibility.
-     * This is deprecated and in v6, it will switch to alias the flat recommended config.
-     */
     recommended: {
-        plugins: string[];
+        name: string;
+        plugins: {
+            readonly 'react-hooks': ESLint.Plugin;
+        };
         rules: {
             'react-hooks/rules-of-hooks': "error";
             'react-hooks/exhaustive-deps': "warn";
         };
     };
-    /** Latest recommended config, to be used with flat configurations */
     'recommended-latest': {
         name: string;
         plugins: {