refactor: improve React Hooks related utils

Author: Rel1cx

CHANGELOG.md

@@ -1,3 +1,18 @@
+## v0.10.1-beta.0 (Draft)
+
+### Release Notes
+
+#### 🏠 Internal
+
+- `@eslint-react/core`
+  - Improve React Hooks related utils.
+
+#### Authors: 1
+
+- Eva1ent ([@Rel1cx](https://github.com/Rel1cx))
+
+---
+
 ## v0.10.0 (Thu Dec 21 2023)
 
 ### Release Notes

README.md

@@ -114,7 +114,7 @@ module.exports = {
 
 ### JSX rules
 
-- [ ] `jsx/max-depth`
+- [x] `jsx/max-depth`
 
 ### Naming convention rules
 

packages/core/docs/README.md

@@ -66,12 +66,13 @@
 - [isForwardRefCall](README.md#isforwardrefcall)
 - [isFunctionOfRenderMethod](README.md#isfunctionofrendermethod)
 - [isInsideReactHook](README.md#isinsidereacthook)
+- [isInsideReactHookCall](README.md#isinsidereacthookcall)
 - [isInsideRenderMethod](README.md#isinsiderendermethod)
 - [isMemo](README.md#ismemo)
 - [isMemoCall](README.md#ismemocall)
 - [isPureComponent](README.md#ispurecomponent)
-- [isReactAPI](README.md#isreactapi)
-- [isReactAPICall](README.md#isreactapicall)
+- [isReactAPICallWithName](README.md#isreactapicallwithname)
+- [isReactAPIWithName](README.md#isreactapiwithname)
 - [isReactHook](README.md#isreacthook)
 - [isReactHookCall](README.md#isreacthookcall)
 - [isReactHookCallWithName](README.md#isreacthookcallwithname)
@@ -95,8 +96,6 @@
 - [isValidReactHookName](README.md#isvalidreacthookname)
 - [unsafeIsDeclaredInRenderProp](README.md#unsafeisdeclaredinrenderprop)
 - [unsafeIsDirectValueOfRenderProperty](README.md#unsafeisdirectvalueofrenderproperty)
-- [unsafeIsInsideReactHookCall](README.md#unsafeisinsidereacthookcall)
-- [unsafeIsReactHookCall](README.md#unsafeisreacthookcall)
 - [unsafeIsRenderFunction](README.md#unsafeisrenderfunction)
 - [unsafeIsRenderProp](README.md#unsafeisrenderprop)
 
@@ -871,6 +870,22 @@ ___
 
 ___
 
+### isInsideReactHookCall
+
+▸ **isInsideReactHookCall**(`node`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `node` | `Node` |
+
+#### Returns
+
+`boolean`
+
+___
+
 ### isInsideRenderMethod
 
 ▸ **isInsideRenderMethod**(`node`, `context`): `boolean`
@@ -959,9 +974,9 @@ Check if a node is a React PureComponent
 
 ___
 
-### isReactAPI
+### isReactAPICallWithName
 
-▸ **isReactAPI**(`name`): `ReturnType`\<typeof `isFromPragma`\>
+▸ **isReactAPICallWithName**(`name`): `ReturnType`\<typeof `isCallFromPragma`\>
 
 #### Parameters
 
@@ -971,9 +986,9 @@ ___
 
 #### Returns
 
-`ReturnType`\<typeof `isFromPragma`\>
+`ReturnType`\<typeof `isCallFromPragma`\>
 
-▸ **isReactAPI**(`name`, `member`): `ReturnType`\<typeof `isFromPragmaMember`\>
+▸ **isReactAPICallWithName**(`name`, `member`): `ReturnType`\<typeof `isCallFromPragmaMember`\>
 
 #### Parameters
 
@@ -984,13 +999,13 @@ ___
 
 #### Returns
 
-`ReturnType`\<typeof `isFromPragmaMember`\>
+`ReturnType`\<typeof `isCallFromPragmaMember`\>
 
 ___
 
-### isReactAPICall
+### isReactAPIWithName
 
-▸ **isReactAPICall**(`name`): `ReturnType`\<typeof `isCallFromPragma`\>
+▸ **isReactAPIWithName**(`name`): `ReturnType`\<typeof `isFromPragma`\>
 
 #### Parameters
 
@@ -1000,9 +1015,9 @@ ___
 
 #### Returns
 
-`ReturnType`\<typeof `isCallFromPragma`\>
+`ReturnType`\<typeof `isFromPragma`\>
 
-▸ **isReactAPICall**(`name`, `member`): `ReturnType`\<typeof `isCallFromPragmaMember`\>
+▸ **isReactAPIWithName**(`name`, `member`): `ReturnType`\<typeof `isFromPragmaMember`\>
 
 #### Parameters
 
@@ -1013,7 +1028,7 @@ ___
 
 #### Returns
 
-`ReturnType`\<typeof `isCallFromPragmaMember`\>
+`ReturnType`\<typeof `isFromPragmaMember`\>
 
 ___
 
@@ -1035,10 +1050,9 @@ ___
 
 ### isReactHookCall
 
-▸ **isReactHookCall**(`node`): `void`
+▸ **isReactHookCall**(`node`): `boolean`
 
-TODO: Implement this function.
-Check if the given node is a React Hook call by its name and its hierarchy.
+Check if the given node is a React Hook call by its name.
 
 #### Parameters
 
@@ -1048,7 +1062,9 @@ Check if the given node is a React Hook call by its name and its hierarchy.
 
 #### Returns
 
-`void`
+`boolean`
+
+`true` if the node is a React Hook call, `false` otherwise.
 
 ___
 
@@ -1455,42 +1471,6 @@ _ = <Component rows={ [{ render: () => <div /> }] } />
 
 ___
 
-### unsafeIsInsideReactHookCall
-
-▸ **unsafeIsInsideReactHookCall**(`node`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | `Node` |
-
-#### Returns
-
-`boolean`
-
-___
-
-### unsafeIsReactHookCall
-
-▸ **unsafeIsReactHookCall**(`node`): `boolean`
-
-Check if the given node is a React Hook call by its name.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `node` | `CallExpression` | The node to check. |
-
-#### Returns
-
-`boolean`
-
-`true` if the node is a React hook call, `false` otherwise.
-
-___
-
 ### unsafeIsRenderFunction
 
 ▸ **unsafeIsRenderFunction**(`node`, `context`): `boolean`

packages/core/src/component/component-collector.ts

@@ -17,7 +17,7 @@ import type { ESLintUtils } from "@typescript-eslint/utils";
 import ShortUniqueId from "short-unique-id";
 import { match } from "ts-pattern";
 
-import { unsafeIsReactHookCall } from "../hook";
+import { isReactHookCall } from "../hook";
 import type { ERFunctionComponent } from "./component";
 import { DEFAULT_COMPONENT_COLLECTOR_HINT, ERComponentCollectorHint } from "./component-collector-hint";
 import { ERFunctionComponentFlag } from "./component-flag";
@@ -192,7 +192,7 @@ export function componentCollector(
       });
     },
     "CallExpression:exit"(node: TSESTree.CallExpression) {
-      if (!unsafeIsReactHookCall(node)) {
+      if (!isReactHookCall(node)) {
         return;
       }
 

packages/core/src/hook/hierarchy.ts

@@ -1,9 +1,13 @@
-import { isFunction, traverseUpGuard } from "@eslint-react/ast";
+import { is, isFunction, NodeType, traverseUp, traverseUpGuard } from "@eslint-react/ast";
 import { O } from "@eslint-react/tools";
 import type { TSESTree } from "@typescript-eslint/types";
 
-import { isReactHook } from "./is";
+import { isReactHook, isReactHookCall } from "./is";
 
 export function isInsideReactHook(node: TSESTree.Node) {
   return O.exists(traverseUpGuard(node, isFunction), isReactHook);
 }
+
+export function isInsideReactHookCall(node: TSESTree.Node): boolean {
+  return O.isSome(traverseUp(node, n => is(NodeType.CallExpression)(n) && isReactHookCall(n)));
+}

packages/core/src/hook/hook-call.ts

@@ -4,8 +4,8 @@ import type { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
 import ShortUniqueId from "short-unique-id";
 
 import type { ERHook } from "./hook";
-import { unsafeIsReactHookCall } from "./hook-call";
 import { isValidReactHookName } from "./hook-name";
+import { isReactHookCall } from "./is";
 
 const uid = new ShortUniqueId({ length: 10 });
 
@@ -69,7 +69,7 @@ export function hookCollector(): {
       // In the realm of React, hooks are like colored functions, and defining a custom hook that doesn't call other hooks is like defining a generator function that doesn't yield or an async function that doesn't await.
       // "Custom Hooks may call other Hooks (that’s their whole purpose)." from https://react.dev/warnings/invalid-hook-call-warning
       // Further Reading: https://react.dev/learn/reusing-logic-with-custom-hooks#should-all-functions-called-during-rendering-start-with-the-use-prefix
-      if (unsafeIsReactHookCall(node)) {
+      if (isReactHookCall(node)) {
         const hook = Array
           .from(hooks.values())
           .find((hook) => hook.node === currentFn);

packages/core/src/hook/hook-collector.ts

@@ -1,6 +1,5 @@
 export * from "./hierarchy";
 export * from "./hook";
-export * from "./hook-call";
 export * from "./hook-collector";
 export * from "./hook-name";
 export * from "./is";