feat: add rule naming-convention/use-state, closes #205 (#206)

Author: Rel1cx

CHANGELOG.md

@@ -4,12 +4,22 @@
 
 #### Add rule `react/no-direct-mutation-state`
 
+#### Add rule `naming-convention/use-state`
+
+#### Update `recommended` and `recommended-legacy` presets
+
 ---
 
 #### 🏠 Internal
 
 - `@eslint-react/eslint-plugin-react`
   - Add rule `react/no-direct-mutation-state`.
+  - Add rule `naming-convention/use-state`.
+
+#### 📝 Documentation
+
+- `@eslint-react/website`
+  - Improve rules overview page.
 
 #### Authors: 1
 
@@ -80,14 +90,6 @@
 - `@eslint-react/monorepo`
   - Update `eslint-config-with-tsconfig` to `2.9.120`.
 
-#### 📝 Documentation
-
-- `@eslint-react/eslint-plugin`
-  - Improve README.md
-
-- `@eslint-react/monorepo`
-  - Improve README.md
-
 #### Authors: 1
 
 - Eva1ent ([@Rel1cx](https://github.com/Rel1cx))

README.md

@@ -44,7 +44,9 @@ module.exports = {
 ### Linting with type information
 
 > [!NOTE]\
-> Rules that require type information are not enabled by default. To enable them, you need to set the `project` option in `parserOptions` to the path of your `tsconfig.json` file.
+> Rules that require type information are not enabled by default.
+>
+> To enable them, you need to set the `project` option in `parserOptions` to the path of your `tsconfig.json` file.
 >
 > Then replace `plugin:@eslint-react/recommended-legacy` with `plugin:@eslint-react/recommended-type-checked-legacy`.
 

package.json

@@ -89,7 +89,7 @@
     "markdownlint": "0.32.1",
     "pathe": "1.1.1",
     "publint": "0.2.6",
-    "rollup": "4.6.1",
+    "rollup": "4.7.0",
     "rollup-plugin-dts": "6.1.0",
     "rollup-plugin-swc3": "0.11.0",
     "rollup-plugin-visualizer": "5.10.0",

packages/core/docs/README.md

@@ -12,6 +12,7 @@ import { M, MutList, MutRef, O } from "@eslint-react/tools";
 import { type TSESTree } from "@typescript-eslint/types";
 import type { ESLintUtils } from "@typescript-eslint/utils";
 
+import { unsafeIsReactHookCall } from "../hook";
 import type { ExRFunctionComponent } from "./component";
 import { DEFAULT_COMPONENT_COLLECTOR_HINT, ExRComponentCollectorHint } from "./component-collector-hint";
 import { ExRFunctionComponentFlag } from "./component-flag";
@@ -60,9 +61,9 @@ export function componentCollector(
   pragma = getPragmaFromContext(context),
 ) {
   const components = new Map<string, ExRFunctionComponent>();
-  const functionStack = MutList.make<[TSESTreeFunction, boolean]>();
+  const functionStack = MutList.make<[TSESTreeFunction, boolean, TSESTree.CallExpression[]]>();
   const getCurrentFunction = () => O.fromNullable(MutList.tail(functionStack));
-  const onFunctionEnter = (node: TSESTreeFunction) => MutList.append(functionStack, [node, false]);
+  const onFunctionEnter = (node: TSESTreeFunction) => MutList.append(functionStack, [node, false, []]);
   const onFunctionExit = () => MutList.pop(functionStack);
 
   const ctx = {
@@ -88,7 +89,7 @@ export function componentCollector(
         return;
       }
 
-      const [currentFn, isComponent] = maybeCurrentFn.value;
+      const [currentFn, isComponent, hookCalls] = maybeCurrentFn.value;
 
       if (isComponent) {
         return;
@@ -103,7 +104,7 @@ export function componentCollector(
       }
 
       MutList.pop(functionStack);
-      MutList.append(functionStack, [currentFn, true]);
+      MutList.append(functionStack, [currentFn, true, []]);
 
       const id = getFunctionComponentIdentifier(currentFn, context);
       const key = uid.rnd();
@@ -121,29 +122,38 @@ export function componentCollector(
         displayName: O.none(),
         flag: getComponentFlag(initPath, pragma),
         hint,
+        hookCalls,
         initPath,
         node: currentFn,
       });
     },
     // eslint-disable-next-line perfectionist/sort-objects
-    "ArrowFunctionExpression[body.type!='BlockStatement']"(node: TSESTree.ArrowFunctionExpression) {
-      const { body } = node;
+    "ArrowFunctionExpression[body.type!='BlockStatement']"() {
+      const maybeCurrentFn = getCurrentFunction();
+
+      if (O.isNone(maybeCurrentFn)) {
+        return;
+      }
+
+      const [currentFn, _, hookCalls] = maybeCurrentFn.value;
+
+      const { body } = currentFn;
 
       if (
-        !hasNoneOrValidComponentName(node)
+        !hasNoneOrValidComponentName(currentFn)
         || !isJSXValue(body, context, hint)
-        || !hasValidHierarchy(node, context, hint)
+        || !hasValidHierarchy(currentFn, context, hint)
       ) {
         return;
       }
 
-      const id = getFunctionComponentIdentifier(node, context);
+      const id = getFunctionComponentIdentifier(currentFn, context);
       const key = uid.rnd();
       const name = O.flatMapNullable(
         id,
         getComponentNameFromIdentifier,
       );
-      const initPath = getComponentInitPath(node);
+      const initPath = getComponentInitPath(currentFn);
 
       components.set(key, {
         _: key,
@@ -153,10 +163,28 @@ export function componentCollector(
         displayName: O.none(),
         flag: getComponentFlag(initPath, pragma),
         hint,
+        hookCalls,
         initPath,
-        node,
+        node: currentFn,
       });
     },
+    "CallExpression:exit"(node: TSESTree.CallExpression) {
+      if (!unsafeIsReactHookCall(node)) {
+        return;
+      }
+
+      const maybeCurrentFn = getCurrentFunction();
+
+      if (O.isNone(maybeCurrentFn)) {
+        return;
+      }
+
+      const [currentFn, IsComponent, hookCalls] = maybeCurrentFn.value;
+
+      MutList.pop(functionStack);
+      MutList.append(functionStack, [currentFn, IsComponent, [...hookCalls, node]]);
+    },
+    // eslint-disable-next-line perfectionist/sort-objects
     "AssignmentExpression[operator='='][left.type='MemberExpression'][left.property.name='displayName']"(
       node: TSESTree.AssignmentExpression,
     ) {

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

@@ -15,6 +15,7 @@ export type ExRFunctionComponent = {
   flag: ExRFunctionComponentFlag;
   hint: ExRComponentCollectorHint;
   initPath: O.Option<ExRComponentInitPath>;
+  hookCalls: TSESTree.CallExpression[];
   displayName: O.Option<TSESTree.Expression>;
 };