refactor: remove duplicate code

Rel1cx · Rel1cx · commit ac38c0c1c951 · 2025-03-05T23:35:21.000+08:00
diff --git a/packages/core/docs/README.md b/packages/core/docs/README.md
@@ -50,6 +50,7 @@
 - [getComponentNameFromIdentifier](functions/getComponentNameFromIdentifier.md)
 - [getFunctionComponentIdentifier](functions/getFunctionComponentIdentifier.md)
 - [hasNoneOrValidComponentName](functions/hasNoneOrValidComponentName.md)
+- [isAssignmentToThisState](functions/isAssignmentToThisState.md)
 - [isChildrenCount](functions/isChildrenCount.md)
 - [isChildrenCountCall](functions/isChildrenCountCall.md)
 - [isChildrenForEach](functions/isChildrenForEach.md)
diff --git a/packages/core/docs/functions/isAssignmentToThisState.md b/packages/core/docs/functions/isAssignmentToThisState.md
@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isAssignmentToThisState
+
+# Function: isAssignmentToThisState()
+
+> **isAssignmentToThisState**(`node`): `boolean`
+
+## Parameters
+
+### node
+
+[`AssignmentExpression`](../-internal-/interfaces/AssignmentExpression.md)
+
+## Returns
+
+`boolean`
diff --git a/packages/core/src/component/component-state.ts b/packages/core/src/component/component-state.ts
@@ -13,3 +13,10 @@ export function isThisSetState(node: TSESTree.CallExpression) {
     && callee.property.name === "setState"
   );
 }
+
+export function isAssignmentToThisState(node: TSESTree.AssignmentExpression) {
+  const { left } = node;
+  return left.type === T.MemberExpression
+    && AST.isThisExpression(left.object)
+    && AST.getPropertyName(left.property) === "state";
+}
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-access-state-in-setstate.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-access-state-in-setstate.ts
@@ -1,6 +1,6 @@
 import * as AST from "@eslint-react/ast";
 import { isClassComponent, isThisSetState } from "@eslint-react/core";
-import { _, constFalse, constTrue } from "@eslint-react/eff";
+import { constFalse, constTrue } from "@eslint-react/eff";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -32,23 +32,6 @@ function isKeyLiteral(
     .otherwise(constFalse);
 }
 
-function getName(node: TSESTree.Expression | TSESTree.PrivateIdentifier): string | _ {
-  if (AST.isTypeExpression(node)) {
-    return getName(node.expression);
-  }
-  if (node.type === T.Identifier || node.type === T.PrivateIdentifier) {
-    return node.name;
-  }
-  if (node.type === T.Literal) {
-    return String(node.value);
-  }
-  if (node.type === T.TemplateLiteral && node.expressions.length === 0) {
-    return node.quasis[0]?.value.raw;
-  }
-
-  return _;
-}
-
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
@@ -119,7 +102,7 @@ export default createRule<[], MessageID>({
         if (setState == null || hasThisState) {
           return;
         }
-        if (getName(node.property) !== "state") {
+        if (AST.getPropertyName(node.property) !== "state") {
           return;
         }
         context.report({ messageId: "noAccessStateInSetstate", node });
@@ -159,7 +142,7 @@ export default createRule<[], MessageID>({
           .some((prop) =>
             prop.type === T.Property
             && isKeyLiteral(prop, prop.key)
-            && getName(prop.key) === "state"
+            && AST.getPropertyName(prop.key) === "state"
           );
         if (!hasState) {
           return;
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-direct-mutation-state.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-direct-mutation-state.ts
@@ -1,6 +1,5 @@
 import * as AST from "@eslint-react/ast";
-import { isClassComponent } from "@eslint-react/core";
-import { _ } from "@eslint-react/eff";
+import { isAssignmentToThisState, isClassComponent } from "@eslint-react/core";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -16,33 +15,6 @@ export const RULE_FEATURES = [
 
 export type MessageID = CamelCase<typeof RULE_NAME>;
 
-function getName(node: TSESTree.Expression | TSESTree.PrivateIdentifier): string | _ {
-  if (AST.isTypeExpression(node)) {
-    return getName(node.expression);
-  }
-  if (node.type === T.Identifier || node.type === T.PrivateIdentifier) {
-    return node.name;
-  }
-  if (node.type === T.Literal) {
-    return node.value?.toString();
-  }
-  if (node.type === T.TemplateLiteral && node.expressions.length === 0) {
-    return node.quasis[0]?.value.raw;
-  }
-
-  return _;
-}
-
-function isAssignmentToThisState(node: TSESTree.AssignmentExpression) {
-  const { left } = node;
-
-  return (
-    left.type === T.MemberExpression
-    && AST.isThisExpression(left.object)
-    && getName(left.property) === "state"
-  );
-}
-
 function isConstructorFunction(
   node: TSESTree.Node,
 ): node is TSESTree.FunctionDeclaration | TSESTree.FunctionExpression {
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-unused-class-component-members.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-unused-class-component-members.ts
@@ -1,6 +1,6 @@
 import * as AST from "@eslint-react/ast";
 import { isClassComponent } from "@eslint-react/core";
-import { _, constFalse, constTrue } from "@eslint-react/eff";
+import { constFalse, constTrue } from "@eslint-react/eff";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -54,26 +54,6 @@ function isKeyLiteral(
     .otherwise(constFalse);
 }
 
-// Return the name of an identifier or the string value of a literal. Useful
-// anywhere that a literal may be used as a key (e.g., member expressions,
-// method definitions, ObjectExpression property keys).
-function getName(node: TSESTree.Expression | TSESTree.PrivateIdentifier): string | _ {
-  if (AST.isTypeExpression(node)) {
-    return getName(node.expression);
-  }
-  if (node.type === T.Identifier || node.type === T.PrivateIdentifier) {
-    return node.name;
-  }
-  if (node.type === T.Literal) {
-    return node.value?.toString();
-  }
-  if (node.type === T.TemplateLiteral && node.expressions.length === 0) {
-    return node.quasis[0]?.value.raw;
-  }
-
-  return _;
-}
-
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
@@ -112,7 +92,7 @@ export default createRule<[], MessageID>({
         return;
       }
       for (const def of defs) {
-        const methodName = getName(def);
+        const methodName = AST.getPropertyName(def);
         if (methodName == null) {
           continue;
         }
@@ -170,7 +150,7 @@ export default createRule<[], MessageID>({
           return;
         }
         // detect `this.property()`, `x = this.property`, etc.
-        const propertyName = getName(node.property);
+        const propertyName = AST.getPropertyName(node.property);
         if (propertyName != null) {
           propertyUsages.get(currentClass)?.add(propertyName);
         }
@@ -192,7 +172,7 @@ export default createRule<[], MessageID>({
         if (node.init != null && AST.isThisExpression(node.init) && node.id.type === T.ObjectPattern) {
           for (const prop of node.id.properties) {
             if (prop.type === T.Property && isKeyLiteral(prop, prop.key)) {
-              const keyName = getName(prop.key);
+              const keyName = AST.getPropertyName(prop.key);
               if (keyName != null) {
                 propertyUsages.get(currentClass)?.add(keyName);
               }
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-unused-state.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-unused-state.ts
@@ -1,6 +1,7 @@
 import * as AST from "@eslint-react/ast";
-import { isClassComponent, isGetDerivedStateFromProps } from "@eslint-react/core";
-import { _, constFalse, constTrue } from "@eslint-react/eff";
+import { isAssignmentToThisState, isClassComponent, isGetDerivedStateFromProps } from "@eslint-react/core";
+import type { _ } from "@eslint-react/eff";
+import { constFalse, constTrue } from "@eslint-react/eff";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -32,31 +33,6 @@ function isKeyLiteral(
     .otherwise(constFalse);
 }
 
-function getName(node: TSESTree.Expression | TSESTree.PrivateIdentifier): string | _ {
-  if (AST.isTypeExpression(node)) {
-    return getName(node.expression);
-  }
-  if (node.type === T.Identifier || node.type === T.PrivateIdentifier) {
-    return node.name;
-  }
-  if (node.type === T.Literal) {
-    return String(node.value);
-  }
-  if (node.type === T.TemplateLiteral && node.expressions.length === 0) {
-    return node.quasis[0]?.value.raw;
-  }
-
-  return _;
-}
-
-function isAssignmentToThisState(node: TSESTree.AssignmentExpression) {
-  const { left } = node;
-
-  return left.type === T.MemberExpression
-    && AST.isThisExpression(left.object)
-    && getName(left.property) === "state";
-}
-
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
@@ -109,7 +85,7 @@ export default createRule<[], MessageID>({
         }
         return;
       }
-      if (getName(node.key) === "state") {
+      if (AST.getPropertyName(node.key) === "state") {
         stateDefs.set(currentClass, { node: node.key, isUsed: false });
       }
     }
@@ -148,7 +124,7 @@ export default createRule<[], MessageID>({
           return;
         }
         // detect `this.state`
-        if (getName(node.property) !== "state") {
+        if (AST.getPropertyName(node.property) !== "state") {
           return;
         }
         const currentClass = classEntries.at(-1);
@@ -195,7 +171,7 @@ export default createRule<[], MessageID>({
         }
         const hasState = node.id.properties.some((prop) => {
           if (prop.type === T.Property && isKeyLiteral(prop, prop.key)) {
-            return getName(prop.key) === "state";
+            return AST.getPropertyName(prop.key) === "state";
           }
           return false;
         });
diff --git a/packages/utilities/ast/src/get-property-name.ts b/packages/utilities/ast/src/get-property-name.ts
@@ -0,0 +1,21 @@
+import { _ } from "@eslint-react/eff";
+import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
+
+import { getEcmaExpression } from "./get-ecma-expression";
+import { isTypeExpression } from "./is";
+
+export function getPropertyName(node: TSESTree.Node): string | _ {
+  if (isTypeExpression(node)) {
+    return getPropertyName(getEcmaExpression(node));
+  }
+  if (node.type === T.Identifier || node.type === T.PrivateIdentifier) {
+    return node.name;
+  }
+  if (node.type === T.Literal) {
+    return String(node.value);
+  }
+  if (node.type === T.TemplateLiteral && node.expressions.length === 0) {
+    return node.quasis[0]?.value.raw;
+  }
+  return _;
+}
diff --git a/packages/utilities/ast/src/index.ts b/packages/utilities/ast/src/index.ts
@@ -7,6 +7,7 @@ export * from "./get-literal-value-type";
 export * from "./get-nested-expressions";
 export * from "./get-nested-identifiers";
 export * from "./get-nested-return-statements";
+export * from "./get-property-name";
 export * from "./get-top-level-identifier";
 export * from "./is";
 export * from "./is-empty-function";
diff --git a/packages/utilities/ast/src/to-readable-node-name.ts b/packages/utilities/ast/src/to-readable-node-name.ts
@@ -12,6 +12,7 @@ export function toReadableNodeName(node: TSESTree.Node, getText: (node: TSESTree
     case T.CallExpression:
       return toReadableNodeName(node.callee, getText);
     case T.Identifier:
+    case T.PrivateIdentifier:
       return node.name;
     case T.JSXIdentifier:
       return `<${node.name}>`;
