Fix naming-convention/use-state and website build script, closes #1352, #1353 (#1354)

Rel1cx · web-flow · commit 2ff2ffb6ae02 · 2025-12-24T02:09:20.000+08:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -57,10 +57,6 @@ pnpm run format:write
 # Run all checks
 pnpm run lint
 
-# Verify rules overview table
-pnpm run verify:rules
-```
-
 ## Development Workflow
 
 ### Testing
@@ -87,3 +83,4 @@ pnpm run verify:rules
 ## Reference
 
 - [Monorepo Structure](https://eslint-react.xyz/docs/contributing#monorepo-structure)
+```
diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
   "author": "Rel1cx<rel1cx@proton.me>",
   "type": "module",
   "scripts": {
-    "build": "pnpm run update:version && pnpm run build:pkgs && pnpm run build:packages && pnpm run build:docs",
+    "build": "pnpm run update:all && pnpm run build:pkgs && pnpm run build:packages && pnpm run build:docs",
     "build:docs": "pnpm -r --stream --filter \"./packages/**\" run build:docs",
     "build:packages": "pnpm -r --stream --filter \"./packages/**\" run build",
     "build:pkgs": "pnpm -r --stream --filter \"./.pkgs/*\" run build",
@@ -47,14 +47,12 @@
     "update:all": "pnpm run update:version && pnpm run update:readme && pnpm run update:website",
     "update:readme": "tsx ./scripts/update-readme.ts",
     "update:version": "tsx ./scripts/update-version.ts",
-    "update:website": "tsx ./scripts/update-website.ts",
-    "verify:rules": "tsx ./scripts/verify-rules-overview.ts"
+    "update:website": "tsx ./scripts/update-website.ts"
   },
   "devDependencies": {
     "@effect/language-service": "^0.62.5",
     "@effect/platform": "^0.94.0",
     "@effect/platform-node": "^0.104.0",
-    "@eslint-react/eslint-plugin": "workspace:*",
     "@eslint/compat": "^2.0.0",
     "@local/configs": "workspace:*",
     "@local/function-rules": "workspace:*",
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.spec.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.spec.ts
@@ -135,6 +135,9 @@ ruleTester.run(RULE_NAME, rule, {
 
       const [value] = useState(() => expensiveSetup());
     `,
+    tsx`
+      const [memoisedValue] = React.useState(() => calculateValue());
+    `,
     tsx`
       import { useState } from "react";
 
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.ts
@@ -106,6 +106,7 @@ export function create(context: RuleContext<MessageID, Options>): RuleListener {
         });
         return;
       }
+      // https://github.com/Rel1cx/eslint-react/issues/1352
       if (setter == null || !enforceSetterName) {
         return;
       }
diff --git a/packages/plugins/eslint-plugin/README.md b/packages/plugins/eslint-plugin/README.md
@@ -191,8 +191,8 @@ This project is and will continue to maintain that 90% of the code is written by
 
 Contributions are welcome!
 
-Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/main/.github/CONTRIBUTING.md).
+Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/fix-website-build-script/.github/CONTRIBUTING.md).
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/main/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/fix-website-build-script/LICENSE) file for details.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/README.md b/scripts/README.md
@@ -31,25 +31,3 @@ pnpm run update:website
 ### `verify-lockfile.ts`
 
 Verifies the integrity of the pnpm lockfile.
-
-### `verify-rules-overview.ts`
-
-Verifies that the rules tables in `apps/website/content/docs/rules/overview.mdx` are accurate and up-to-date.
-
-This script:
-
-1. Checks that all rules from each plugin are present in the overview table
-2. Verifies that rule metadata (fixable, codemod, experimental, etc.) matches between the rule implementation and the overview table
-3. Reports any discrepancies found
-
-```bash
-pnpm run verify:rules
-```
-
-Run this script:
-
-- After adding a new rule to ensure it's included in the overview
-- After modifying rule metadata to ensure the overview is updated
-- As part of the CI/CD pipeline to catch inconsistencies
-
-The script will exit with code 0 if all checks pass, or code 1 if any issues are found.
diff --git a/scripts/update-website.ts b/scripts/update-website.ts
@@ -2,7 +2,6 @@ import * as NodeContext from "@effect/platform-node/NodeContext";
 import * as NodeRuntime from "@effect/platform-node/NodeRuntime";
 import * as FileSystem from "@effect/platform/FileSystem";
 import * as Path from "@effect/platform/Path";
-import pluginMod from "@eslint-react/eslint-plugin";
 import ansis from "ansis";
 import { identity } from "effect";
 import * as Effect from "effect/Effect";
@@ -103,72 +102,73 @@ function generateRuleMetaJson(metas: RuleMeta[]) {
   });
 }
 
+// TODO: Not implemented yet
 // Process the rules overview file
-const processRulesOverview = Effect.gen(function*() {
-  const fs = yield* FileSystem.FileSystem;
-  const path = yield* Path.Path;
-  const targetPath = path.join("apps", "website", "content", "docs", "rules", "overview.mdx");
-  const markdownTables = [[""], [""], [""], [""], [""], [""]];
-  for (const doc of glob(DOCS_GLOB)) {
-    const catename = /^packages\/plugins\/eslint-plugin-react-([^/]+)/u.exec(doc)?.[1] ?? "";
-    const basename = path.parse(path.basename(doc)).name;
-    const filename = path.resolve(doc).replace(/\.mdx$/u, ".ts");
-    const rulename = `${catename}/${basename}`;
-    const tableIndex = orderedCategories.findIndex((c) => c.key === catename);
-    const tableLines = markdownTables[tableIndex] ?? [];
-    const { default: ruleModule, RULE_FEATURES, RULE_NAME } = yield* Effect.tryPromise(() => import(filename));
-    const description = match(ruleModule)
-      .with({ meta: { docs: { description: P.select(P.string) } } }, identity)
-      .otherwise(() => "No description available.");
-    const isPluginX = catename === "x";
-    const entryInRecommended = pluginMod
-      .configs
-      .recommended
-      .rules
-      ?.[isPluginX ? `@eslint-react/${RULE_NAME}` : `@eslint-react/${catename}/${RULE_NAME}`];
-    const entryInStrict = pluginMod
-      .configs
-      .strict
-      .rules
-      ?.[isPluginX ? `@eslint-react/${RULE_NAME}` : `@eslint-react/${catename}/${RULE_NAME}`];
-    const getSeverity = (entry: unknown): number =>
-      match(entry)
-        .with("off", () => 0)
-        .with("warn", () => 1)
-        .with("error", () => 2)
-        .with(P.number, (n) => n)
-        .with(P.array(), ([s]) => getSeverity(s))
-        .otherwise(() => 0);
-    const getSeverityIcon = (severity: number) => {
-      return match(severity)
-        .with(0, () => "0️⃣")
-        .with(1, () => "1️⃣")
-        .with(2, () => "2️⃣")
-        .otherwise(() => "0️⃣");
-    };
-    const getFeatureIcon = (feature: unknown) => {
-      return match(feature)
-        .with("CFG", () => "⚙️")
-        .with("DBG", () => "🐞")
-        .with("FIX", () => "🔧")
-        .with("MOD", () => "🔄")
-        .with("TSC", () => "💭")
-        .with("EXP", () => "🧪")
-        .otherwise(() => "");
-    };
-    const severityInRecommended = getSeverity(entryInRecommended);
-    const severityInStrict = getSeverity(entryInStrict);
-    tableLines.push(
-      [
-        `[${basename}](${catename === "x" ? "" : catename + "-"}${basename})`,
-        `${getSeverity(entryInRecommended)} ${getSeverity(entryInStrict)}`,
-        `${RULE_FEATURES.map((f: string) => "`" + getFeatureIcon(f) + "`").join(" ")}`,
-      ].join(" | "),
-    );
-    // yield* Effect.log(markdownTables);
-    // TODO: Not implemented yet.
-  }
-});
+// const processRulesOverview = Effect.gen(function*() {
+//   const fs = yield* FileSystem.FileSystem;
+//   const path = yield* Path.Path;
+//   const targetPath = path.join("apps", "website", "content", "docs", "rules", "overview.mdx");
+//   const markdownTables = [[""], [""], [""], [""], [""], [""]];
+//   for (const doc of glob(DOCS_GLOB)) {
+//     const catename = /^packages\/plugins\/eslint-plugin-react-([^/]+)/u.exec(doc)?.[1] ?? "";
+//     const basename = path.parse(path.basename(doc)).name;
+//     const filename = path.resolve(doc).replace(/\.mdx$/u, ".ts");
+//     const rulename = `${catename}/${basename}`;
+//     const tableIndex = orderedCategories.findIndex((c) => c.key === catename);
+//     const tableLines = markdownTables[tableIndex] ?? [];
+//     // TODO: Read rule module directly from pluginMod instead of dynamic import
+//     const { default: ruleModule, RULE_FEATURES, RULE_NAME } = yield* Effect.tryPromise(() => import(filename));
+//     const description = match(ruleModule)
+//       .with({ meta: { docs: { description: P.select(P.string) } } }, identity)
+//       .otherwise(() => "No description available.");
+//     const isPluginX = catename === "x";
+//     const entryInRecommended = pluginMod
+//       .configs
+//       .recommended
+//       .rules
+//       ?.[isPluginX ? `@eslint-react/${RULE_NAME}` : `@eslint-react/${catename}/${RULE_NAME}`];
+//     const entryInStrict = pluginMod
+//       .configs
+//       .strict
+//       .rules
+//       ?.[isPluginX ? `@eslint-react/${RULE_NAME}` : `@eslint-react/${catename}/${RULE_NAME}`];
+//     const getSeverity = (entry: unknown): number =>
+//       match(entry)
+//         .with("off", () => 0)
+//         .with("warn", () => 1)
+//         .with("error", () => 2)
+//         .with(P.number, (n) => n)
+//         .with(P.array(), ([s]) => getSeverity(s))
+//         .otherwise(() => 0);
+//     const getSeverityIcon = (severity: number) => {
+//       return match(severity)
+//         .with(0, () => "0️⃣")
+//         .with(1, () => "1️⃣")
+//         .with(2, () => "2️⃣")
+//         .otherwise(() => "0️⃣");
+//     };
+//     const getFeatureIcon = (feature: unknown) => {
+//       return match(feature)
+//         .with("CFG", () => "⚙️")
+//         .with("DBG", () => "🐞")
+//         .with("FIX", () => "🔧")
+//         .with("MOD", () => "🔄")
+//         .with("TSC", () => "💭")
+//         .with("EXP", () => "🧪")
+//         .otherwise(() => "");
+//     };
+//     const severityInRecommended = getSeverity(entryInRecommended);
+//     const severityInStrict = getSeverity(entryInStrict);
+//     tableLines.push(
+//       [
+//         `[${basename}](${catename === "x" ? "" : catename + "-"}${basename})`,
+//         `${getSeverity(entryInRecommended)} ${getSeverity(entryInStrict)}`,
+//         `${RULE_FEATURES.map((f: string) => "`" + getFeatureIcon(f) + "`").join(" ")}`,
+//       ].join(" | "),
+//     );
+//     // yield* Effect.log(markdownTables);
+//   }
+// });
 
 const processChangelog = Effect.gen(function*() {
   const fs = yield* FileSystem.FileSystem;
@@ -206,8 +206,6 @@ const program = Effect.gen(function*() {
 
   yield* generateRuleMetaJson(metas);
 
-  yield* processRulesOverview;
-
   yield* processChangelog;
 
   yield* Effect.log(ansis.bold.green("Documentation processing completed."));
diff --git a/scripts/verify-rules-overview.ts b/scripts/verify-rules-overview.ts

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,7 @@ export function create(context: RuleContext<MessageID, Options>): RuleListener {`
`106`	`106`	`});`
`107`	`107`	`return;`
`108`	`108`	`}`
	`109`	`+ // https://github.com/Rel1cx/eslint-react/issues/1352`
`109`	`110`	`if (setter == null \|\| !enforceSetterName) {`
`110`	`111`	`return;`
`111`	`112`	`}`