refactor: unify method and property type definitions under TSESTreeMethodOrProperty

Rel1cx · Rel1cx · commit c7dccdd04554 · 2025-01-15T10:20:27.000+08:00
diff --git a/packages/core/docs/README.md b/packages/core/docs/README.md
@@ -62,6 +62,7 @@
 - [isClassComponent](functions/isClassComponent.md)
 - [isCloneElement](functions/isCloneElement.md)
 - [isCloneElementCall](functions/isCloneElementCall.md)
+- [isComponentDidCatch](functions/isComponentDidCatch.md)
 - [isComponentDidMount](functions/isComponentDidMount.md)
 - [isComponentName](functions/isComponentName.md)
 - [isComponentWillUnmount](functions/isComponentWillUnmount.md)
@@ -80,6 +81,8 @@
 - [isFunctionOfRenderMethod](functions/isFunctionOfRenderMethod.md)
 - [isFunctionOfUseEffectCleanup](functions/isFunctionOfUseEffectCleanup.md)
 - [isFunctionOfUseEffectSetup](functions/isFunctionOfUseEffectSetup.md)
+- [isGetDerivedStateFromError](functions/isGetDerivedStateFromError.md)
+- [isGetDerivedStateFromProps](functions/isGetDerivedStateFromProps.md)
 - [isInitializedFromReact](functions/isInitializedFromReact.md)
 - [isInsideCreateElementProps](functions/isInsideCreateElementProps.md)
 - [isInsideReactHook](functions/isInsideReactHook.md)
diff --git a/packages/core/docs/functions/isComponentDidCatch.md b/packages/core/docs/functions/isComponentDidCatch.md
@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isComponentDidCatch
+
+# Function: isComponentDidCatch()
+
+> **isComponentDidCatch**(`node`): `node is TSESTreeMethodOrProperty`
+
+## Parameters
+
+### node
+
+`Node`
+
+## Returns
+
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/functions/isComponentDidMount.md b/packages/core/docs/functions/isComponentDidMount.md
@@ -6,7 +6,7 @@
 
 # Function: isComponentDidMount()
 
-> **isComponentDidMount**(`node`): node is MethodDefinition \| PropertyDefinition
+> **isComponentDidMount**(`node`): `node is TSESTreeMethodOrProperty`
 
 ## Parameters
 
@@ -16,4 +16,4 @@
 
 ## Returns
 
-node is MethodDefinition \| PropertyDefinition
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/functions/isComponentWillUnmount.md b/packages/core/docs/functions/isComponentWillUnmount.md
@@ -6,7 +6,7 @@
 
 # Function: isComponentWillUnmount()
 
-> **isComponentWillUnmount**(`node`): node is MethodDefinition \| PropertyDefinition
+> **isComponentWillUnmount**(`node`): `node is TSESTreeMethodOrProperty`
 
 ## Parameters
 
@@ -16,4 +16,4 @@
 
 ## Returns
 
-node is MethodDefinition \| PropertyDefinition
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/functions/isGetDerivedStateFromError.md b/packages/core/docs/functions/isGetDerivedStateFromError.md
@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isGetDerivedStateFromError
+
+# Function: isGetDerivedStateFromError()
+
+> **isGetDerivedStateFromError**(`node`): `node is TSESTreeMethodOrProperty`
+
+## Parameters
+
+### node
+
+`Node`
+
+## Returns
+
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/functions/isGetDerivedStateFromProps.md b/packages/core/docs/functions/isGetDerivedStateFromProps.md
@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isGetDerivedStateFromProps
+
+# Function: isGetDerivedStateFromProps()
+
+> **isGetDerivedStateFromProps**(`node`): `node is TSESTreeMethodOrProperty`
+
+## Parameters
+
+### node
+
+`Node`
+
+## Returns
+
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/functions/isRenderMethodLike.md b/packages/core/docs/functions/isRenderMethodLike.md
@@ -6,7 +6,7 @@
 
 # Function: isRenderMethodLike()
 
-> **isRenderMethodLike**(`node`): node is MethodDefinition \| PropertyDefinition
+> **isRenderMethodLike**(`node`): `node is TSESTreeMethodOrProperty`
 
 ## Parameters
 
@@ -16,4 +16,4 @@
 
 ## Returns
 
-node is MethodDefinition \| PropertyDefinition
+`node is TSESTreeMethodOrProperty`
diff --git a/packages/core/docs/interfaces/ERClassComponent.md b/packages/core/docs/interfaces/ERClassComponent.md
@@ -70,7 +70,7 @@
 
 ### methods
 
-> **methods**: (`MethodDefinition` \| `PropertyDefinition`)[]
+> **methods**: `TSESTreeMethodOrProperty`[]
 
 ***
 
diff --git a/packages/core/src/component/component-lifecycle.ts b/packages/core/src/component/component-lifecycle.ts
@@ -3,23 +3,41 @@ import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
 import { isClassComponent } from "./is";
+import { isMatching, P } from "ts-pattern";
 
-export function isComponentDidMount(
-  node: TSESTree.Node,
-): node is TSESTree.MethodDefinition | TSESTree.PropertyDefinition {
-  return AST.isOneOf([T.MethodDefinition, T.PropertyDefinition])(node)
+export function isComponentDidMount(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
     && node.key.type === T.Identifier
     && node.key.name === "componentDidMount";
 }
 
-export function isComponentWillUnmount(
-  node: TSESTree.Node,
-): node is TSESTree.MethodDefinition | TSESTree.PropertyDefinition {
-  return AST.isOneOf([T.MethodDefinition, T.PropertyDefinition])(node)
+export function isComponentWillUnmount(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
     && node.key.type === T.Identifier
     && node.key.name === "componentWillUnmount";
 }
 
+export function isComponentDidCatch(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
+    && !node.static
+    && node.key.type === T.Identifier
+    && node.key.name === "componentDidCatch";
+}
+
+export function isGetDerivedStateFromError(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
+    && node.static
+    && node.key.type === T.Identifier
+    && node.key.name === "getDerivedStateFromError";
+}
+
+export function isGetDerivedStateFromProps(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
+    && node.static
+    && node.key.type === T.Identifier
+    && node.key.name === "getDerivedStateFromProps";
+}
+
 export function isFunctionOfComponentDidMount(node: TSESTree.Node) {
   return AST.isFunction(node)
     && isComponentDidMount(node.parent)
@@ -32,11 +50,8 @@ export function isFunctionOfComponentWillUnmount(node: TSESTree.Node) {
     && node.parent.value === node;
 }
 
-export function isRenderMethodLike(node: TSESTree.Node): node is
-  | TSESTree.MethodDefinition
-  | TSESTree.PropertyDefinition
-{
-  return (node.type === T.MethodDefinition || node.type === T.PropertyDefinition)
+export function isRenderMethodLike(node: TSESTree.Node): node is AST.TSESTreeMethodOrProperty {
+  return AST.isMethodOrProperty(node)
     && node.key.type === T.Identifier
     && node.key.name === "render"
     && node.parent.parent.type === T.ClassDeclaration;
diff --git a/packages/core/src/component/component-semantic-node.ts b/packages/core/src/component/component-semantic-node.ts
@@ -33,10 +33,7 @@ export interface ERClassComponent extends ERSemanticNode {
   node: AST.TSESTreeClass;
   flag: ERClassComponentFlag;
   hint: ERComponentHint;
-  methods: Array<
-    | TSESTree.MethodDefinition
-    | TSESTree.PropertyDefinition
-  >;
+  methods: AST.TSESTreeMethodOrProperty[];
   displayName:
     | _
     | TSESTree.Expression;
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
@@ -55,7 +55,7 @@ export default createRule<[], MessageID>({
       isComponent: boolean,
     ][] = [];
     const methodEntries: [
-      node: TSESTree.MethodDefinition | TSESTree.PropertyDefinition,
+      node: AST.TSESTreeMethodOrProperty,
       isStatic: boolean,
     ][] = [];
     const setStateEntries: [
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-class-component.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-class-component.ts
@@ -1,7 +1,5 @@
-import { useComponentCollectorLegacy } from "@eslint-react/core";
+import { isComponentDidCatch, isGetDerivedStateFromError, useComponentCollectorLegacy } from "@eslint-react/core";
 import type { RuleFeature } from "@eslint-react/shared";
-import type { TSESTree } from "@typescript-eslint/types";
-import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { CamelCase } from "string-ts";
 
 import { createRule } from "../utils";
@@ -14,26 +12,6 @@ export const RULE_FEATURES = [
 
 export type MessageID = CamelCase<typeof RULE_NAME>;
 
-export function isComponentDidCatch(node: TSESTree.Node): node is
-  | TSESTree.MethodDefinition
-  | TSESTree.PropertyDefinition
-{
-  return (node.type === T.MethodDefinition || node.type === T.PropertyDefinition)
-    && !node.static
-    && node.key.type === T.Identifier
-    && node.key.name === "componentDidCatch";
-}
-
-function isGetDerivedStateFromError(node: TSESTree.Node): node is
-  | TSESTree.MethodDefinition
-  | TSESTree.PropertyDefinition
-{
-  return (node.type === T.MethodDefinition || node.type === T.PropertyDefinition)
-    && node.static
-    && node.key.type === T.Identifier
-    && node.key.name === "getDerivedStateFromError";
-}
-
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
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
@@ -17,7 +17,7 @@ export const RULE_FEATURES = [
 export type MessageID = CamelCase<typeof RULE_NAME>;
 
 type Property =
-  | (TSESTree.MethodDefinition | TSESTree.PropertyDefinition)["key"]
+  | AST.TSESTreeMethodOrProperty["key"]
   | TSESTree.MemberExpression["property"];
 
 const LIFECYCLE_METHODS = new Set([
@@ -73,7 +73,7 @@ export default createRule<[], MessageID>({
   name: RULE_NAME,
   create(context) {
     const classEntries: AST.TSESTreeClass[] = [];
-    const methodEntries: (TSESTree.MethodDefinition | TSESTree.PropertyDefinition)[] = [];
+    const methodEntries: AST.TSESTreeMethodOrProperty[] = [];
     const propertyDefs = new WeakMap<AST.TSESTreeClass, Set<Property>>();
     const propertyUsages = new WeakMap<AST.TSESTreeClass, Set<string>>();
     function classEnter(node: AST.TSESTreeClass) {
@@ -114,7 +114,7 @@ export default createRule<[], MessageID>({
         });
       }
     }
-    function methodEnter(node: TSESTree.MethodDefinition | TSESTree.PropertyDefinition) {
+    function methodEnter(node: AST.TSESTreeMethodOrProperty) {
       methodEntries.push(node);
       const currentClass = classEntries.at(-1);
       if (currentClass == null || !isClassComponent(currentClass)) {
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,5 +1,5 @@
 import * as AST from "@eslint-react/ast";
-import { isClassComponent } from "@eslint-react/core";
+import { isClassComponent, isGetDerivedStateFromProps } from "@eslint-react/core";
 import { _ } from "@eslint-react/eff";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
@@ -44,16 +44,6 @@ function isAssignmentToThisState(node: TSESTree.AssignmentExpression) {
   );
 }
 
-const isGetDerivedStateFromProps = isMatching({
-  key: {
-    name: "getDerivedStateFromProps",
-  },
-  static: true,
-  value: {
-    params: P.array(),
-  },
-});
-
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
@@ -69,7 +59,7 @@ export default createRule<[], MessageID>({
   name: RULE_NAME,
   create(context) {
     const classEntries: AST.TSESTreeClass[] = [];
-    const methodEntries: (TSESTree.MethodDefinition | TSESTree.PropertyDefinition)[] = [];
+    const methodEntries: AST.TSESTreeMethodOrProperty[] = [];
     const constructorEntries: TSESTree.MethodDefinition[] = [];
     const stateDefs = new WeakMap<AST.TSESTreeClass, { node: TSESTree.Node | _; isUsed: boolean }>();
     function classEnter(node: AST.TSESTreeClass) {
@@ -93,14 +83,14 @@ export default createRule<[], MessageID>({
         },
       });
     }
-    function methodEnter(node: TSESTree.MethodDefinition | TSESTree.PropertyDefinition) {
+    function methodEnter(node: AST.TSESTreeMethodOrProperty) {
       methodEntries.push(node);
       const currentClass = classEntries.at(-1);
       if (currentClass == null || !isClassComponent(currentClass)) {
         return;
       }
       if (node.static) {
-        if (isGetDerivedStateFromProps(node) && node.value.params.length > 1) {
+        if (isGetDerivedStateFromProps(node) && isMatching({ params: [P.nonNullable, ...P.array()] })(node.value)) {
           const defNode = stateDefs.get(currentClass)?.node;
           stateDefs.set(currentClass, { node: defNode, isUsed: true });
         }
diff --git a/packages/utilities/ast/src/is.ts b/packages/utilities/ast/src/is.ts
@@ -28,6 +28,11 @@ export const isFunctionType = isOneOf([
 
 export const isClass = isOneOf([T.ClassDeclaration, T.ClassExpression]);
 
+export const isMethodOrProperty = isOneOf([
+  T.PropertyDefinition,
+  T.MethodDefinition,
+]);
+
 export const isLoop = isOneOf([
   T.DoWhileStatement,
   T.ForInStatement,
diff --git a/packages/utilities/ast/src/types.ts b/packages/utilities/ast/src/types.ts
@@ -16,6 +16,8 @@ export type TSESTreeFunctionType =
 
 export type TSESTreeClass = TSESTree.ClassDeclaration | TSESTree.ClassExpression;
 
+export type TSESTreeMethodOrProperty = TSESTree.PropertyDefinition | TSESTree.MethodDefinition;
+
 export type TSESTreeLoop =
   | TSESTree.DoWhileStatement
   | TSESTree.ForInStatement
