Clean up the code structure of the AST utils and fix an issue where

Rel1cx · Rel1cx · commit 4018a0a59b11 · 2025-12-06T23:54:01.000+08:00
isNodeEqual did not handle TypeScript expressions correctly, closes #1340
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-event-listener.spec.ts b/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-event-listener.spec.ts
@@ -689,6 +689,39 @@ ruleTester.run(RULE_NAME, rule, {
         }, []);
       }
     `,
+    tsx`
+      function Example() {
+        useEffect(() => {
+          const handleResize = () => {};
+          window.addEventListener("resize", handleResize as EventListener);
+          return () => {
+            window.removeEventListener("resize", handleResize as EventListener);
+          };
+        }, []);
+      }
+    `,
+    tsx`
+      function Example() {
+        useEffect(() => {
+          const handleResize = () => {};
+          window.addEventListener("resize", handleResize as EventListener);
+          return () => {
+            window.removeEventListener("resize", handleResize);
+          };
+        }, []);
+      }
+    `,
+    tsx`
+      function Example() {
+        useEffect(() => {
+          const handleResize = () => {};
+          window.addEventListener("resize", handleResize);
+          return () => {
+            window.removeEventListener("resize", handleResize as EventListener);
+          };
+        }, []);
+      }
+    `,
     tsx`
       function Example() {
         useEffect(() => {
diff --git a/packages/utilities/ast/src/__tests__/class.test.ts b/packages/utilities/ast/src/__tests__/class.test.ts
@@ -7,7 +7,7 @@ import { describe, expect, it } from "vitest";
 import { getFixturesRootDir } from "../../../../../test";
 
 import { getClassId } from "../class-id";
-import type { TSESTreeClass } from "../node";
+import type { TSESTreeClass } from "../node-types";
 
 function parse(code: string) {
   return parseForESLint(code, {
diff --git a/packages/utilities/ast/src/__tests__/expression.test.ts b/packages/utilities/ast/src/__tests__/expression.test.ts
@@ -7,8 +7,10 @@ import path from "node:path";
 import { describe, expect, it } from "vitest";
 
 import { getFixturesRootDir } from "../../../../../test";
-import { getNestedReturnStatements } from "../expression";
-import { type TSESTreeFunction, isFunction } from "../node";
+
+import { getNestedReturnStatements } from "../expression-nested";
+import { isFunction } from "../node-is";
+import type { TSESTreeFunction } from "../node-types";
 
 function parse(code: string) {
   return parseForESLint(code, {
diff --git a/packages/utilities/ast/src/__tests__/function.test.ts b/packages/utilities/ast/src/__tests__/function.test.ts
@@ -7,7 +7,8 @@ import { describe, expect, it } from "vitest";
 import { getFixturesRootDir } from "../../../../../test";
 
 import { getFunctionId } from "../function-id";
-import { type TSESTreeFunction, isFunction } from "../node";
+import { isFunction } from "../node-is";
+import type { TSESTreeFunction } from "../node-types";
 
 function parse(code: string) {
   return parseForESLint(code, {
diff --git a/packages/utilities/ast/src/array.ts b/packages/utilities/ast/src/array.ts
diff --git a/packages/utilities/ast/src/class-id.ts b/packages/utilities/ast/src/class-id.ts
@@ -1,9 +1,9 @@
 import { unit } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
-import type { TSESTreeClass } from "./node";
-
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
+import type { TSESTreeClass } from "./node-types";
+
 export function getClassId(node: TSESTreeClass): TSESTree.Identifier | unit {
   if (node.id != null) return node.id;
   if (node.parent.type === T.VariableDeclarator && node.parent.id.type === T.Identifier) {
diff --git a/packages/utilities/ast/src/expression-base.ts b/packages/utilities/ast/src/expression-base.ts
@@ -1,5 +1,7 @@
 import type { TSESTree } from "@typescript-eslint/types";
-import { type TSESTreeTypeExpression, isTypeExpression } from "./node";
+
+import { isTypeExpression } from "./node-is";
+import type { TSESTreeTypeExpression } from "./node-types";
 
 /**
  * Unwraps any type expressions to get the underlying JavaScript expression node.
diff --git a/packages/utilities/ast/src/expression-is.ts b/packages/utilities/ast/src/expression-is.ts
@@ -1,6 +1,6 @@
 import type { TSESTree } from "@typescript-eslint/types";
-
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
+
 import { getUnderlyingExpression } from "./expression-base";
 
 /**
diff --git a/packages/utilities/ast/src/expression-nested.ts b/packages/utilities/ast/src/expression-nested.ts
@@ -1,7 +1,8 @@
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import { simpleTraverse } from "@typescript-eslint/typescript-estree";
-import { is, isFunction } from "./node";
+
+import { is, isFunction } from "./node-is";
 import { findParentNode } from "./traverse";
 
 /**
diff --git a/packages/utilities/ast/src/expression.ts b/packages/utilities/ast/src/expression.ts
diff --git a/packages/utilities/ast/src/function-id.ts b/packages/utilities/ast/src/function-id.ts
@@ -3,8 +3,8 @@ import { unit } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
-import type { TSESTreeFunction } from "./node";
-import { isMethodOrProperty, isTypeAssertionExpression } from "./node";
+import { isMethodOrProperty, isTypeAssertionExpression } from "./node-is";
+import type { TSESTreeFunction } from "./node-types";
 
 // Ported from https://github.com/eps1lon/react/blob/8b8d265bd9a4cab7bbd04a9a13950fdc946ea51c/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js#L642
 /**
diff --git a/packages/utilities/ast/src/function-init-path.ts b/packages/utilities/ast/src/function-init-path.ts
@@ -2,7 +2,7 @@ import { unit } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
-import type { TSESTreeFunction } from "./node";
+import type { TSESTreeFunction } from "./node-types";
 
 /**
  * Represents various AST paths for React component function declarations.
diff --git a/packages/utilities/ast/src/function-is.ts b/packages/utilities/ast/src/function-is.ts
@@ -1,6 +1,6 @@
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
-import type { TSESTreeFunction } from "./node";
+import type { TSESTreeFunction } from "./node-types";
 
 export function isFunctionEmpty(node: TSESTreeFunction) {
   return node.body.type === T.BlockStatement
diff --git a/packages/utilities/ast/src/function.ts b/packages/utilities/ast/src/function.ts
diff --git a/packages/utilities/ast/src/index.ts b/packages/utilities/ast/src/index.ts
@@ -1,18 +1,14 @@
-export * from "./array";
 export * from "./array-index";
 export * from "./array-method";
 export * from "./class-id";
-export * from "./expression";
 export * from "./expression-base";
 export * from "./expression-is";
 export * from "./expression-nested";
-export * from "./function";
 export * from "./function-id";
 export * from "./function-init-path";
 export * from "./function-is";
 export * from "./literal";
 export * from "./misc";
-export * from "./node";
 export * from "./node-equal";
 export * from "./node-format";
 export * from "./node-is";
@@ -22,6 +18,4 @@ export * from "./process-env-node-env";
 export * from "./promise-then";
 export * from "./property-name";
 export * from "./traverse";
-export type * from "./traverse-down";
-export * from "./traverse-up";
 export * from "./vitest-mock";
diff --git a/packages/utilities/ast/src/misc.ts b/packages/utilities/ast/src/misc.ts
@@ -1,7 +1,7 @@
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
-import { isOneOf } from "./node";
+import { isOneOf } from "./node-is";
 
 /**
  * Check if a node is multiline
diff --git a/packages/utilities/ast/src/node-equal.ts b/packages/utilities/ast/src/node-equal.ts
@@ -2,6 +2,9 @@ import { dual } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
+import { getUnderlyingExpression } from "./expression-base";
+import { isTypeExpression } from "./node-is";
+
 /**
  * Determines whether node equals to another node
  * @param a node to compare
@@ -13,6 +16,8 @@ export const isNodeEqual: {
   (a: TSESTree.Node): (b: TSESTree.Node) => boolean;
   (a: TSESTree.Node, b: TSESTree.Node): boolean;
 } = dual(2, (a: TSESTree.Node, b: TSESTree.Node): boolean => {
+  a = isTypeExpression(a) ? getUnderlyingExpression(a) : a;
+  b = isTypeExpression(b) ? getUnderlyingExpression(b) : b;
   switch (true) {
     case a === b:
       return true;
diff --git a/packages/utilities/ast/src/node.ts b/packages/utilities/ast/src/node.ts
diff --git a/packages/utilities/ast/src/process-env-node-env.ts b/packages/utilities/ast/src/process-env-node-env.ts
@@ -1,5 +1,6 @@
 import type { unit } from "@eslint-react/eff";
 import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
+
 import { isLiteral } from "./literal";
 
 /**
diff --git a/packages/utilities/ast/src/property-name.ts b/packages/utilities/ast/src/property-name.ts
@@ -1,8 +1,8 @@
 import { unit } from "@eslint-react/eff";
 import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
 
-import { getUnderlyingExpression } from "./expression";
-import { isTypeExpression } from "./node";
+import { getUnderlyingExpression } from "./expression-base";
+import { isTypeExpression } from "./node-is";
 
 export function getPropertyName(node: TSESTree.Node): string | unit {
   if (isTypeExpression(node)) {
diff --git a/packages/utilities/ast/src/traverse-down.ts b/packages/utilities/ast/src/traverse-down.ts
diff --git a/packages/utilities/ast/src/traverse-up.ts b/packages/utilities/ast/src/traverse-up.ts
diff --git a/packages/utilities/ast/src/traverse.ts b/packages/utilities/ast/src/traverse.ts
@@ -1,2 +1,36 @@
-export type * from "./traverse-down";
-export * from "./traverse-up";
+import { unit } from "@eslint-react/eff";
+import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
+
+/**
+ * Find the parent node that satisfies the test function
+ * @param node The AST node
+ * @param test The test function
+ * @returns The parent node that satisfies the test function or `_` if not found
+ */
+function findParentNode<A extends TSESTree.Node>(
+  node: TSESTree.Node | unit,
+  test: (n: TSESTree.Node) => n is A,
+): A | unit;
+/**
+ * Find the parent node that satisfies the test function or `_` if not found
+ * @param node The AST node
+ * @param test The test function
+ * @returns The parent node that satisfies the test function
+ */
+function findParentNode(node: TSESTree.Node | unit, test: (node: TSESTree.Node) => boolean): TSESTree.Node | unit;
+function findParentNode<A extends TSESTree.Node>(
+  node: TSESTree.Node | unit,
+  test: ((node: TSESTree.Node) => boolean) | ((n: TSESTree.Node) => n is A),
+): TSESTree.Node | A | unit {
+  if (node == null) return unit;
+  let parent = node.parent;
+  while (parent != null && parent.type !== T.Program) {
+    if (test(parent)) {
+      return parent;
+    }
+    parent = parent.parent;
+  }
+  return unit;
+}
+
+export { findParentNode };
diff --git a/packages/utilities/ast/src/vitest-mock.ts b/packages/utilities/ast/src/vitest-mock.ts
@@ -1,5 +1,6 @@
 import type { unit } from "@eslint-react/eff";
 import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
+
 import { isFunction } from "./node-is";
 
 /**
