refactor(ast): restructure the module

Rel1cx · Rel1cx · commit c00dd8bb714c · 2025-04-16T21:24:23.000+08:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -43,5 +43,5 @@
   "mdx.server.enable": true,
   "npm.packageManager": "pnpm",
   "typescript.preferences.importModuleSpecifier": "non-relative",
-  "typescript.tsdk": "node_modules/typescript/lib",
-}
+  "typescript.tsdk": "node_modules/typescript/lib"
+}
diff --git a/packages/core/src/component/component-collector-legacy.ts b/packages/core/src/component/component-collector-legacy.ts
@@ -34,7 +34,7 @@ export function useComponentCollectorLegacy(): useComponentCollectorLegacy.Retur
     if (!isClassComponent(node)) {
       return;
     }
-    const id = AST.getClassIdentifier(node);
+    const id = AST.getClassId(node);
     const key = getId();
     const flag = isPureComponent(node)
       ? ComponentFlag.PureComponent
diff --git a/packages/core/src/component/component-id.ts b/packages/core/src/component/component-id.ts
@@ -9,7 +9,7 @@ export function getFunctionComponentId(
   context: RuleContext,
   node: AST.TSESTreeFunction,
 ): TSESTree.Identifier | TSESTree.Identifier[] | _ {
-  const functionId = AST.getFunctionIdentifier(node);
+  const functionId = AST.getFunctionId(node);
   if (functionId != null) {
     return functionId;
   }
diff --git a/packages/core/src/component/component-render-prop.ts b/packages/core/src/component/component-render-prop.ts
@@ -19,7 +19,7 @@ import { isJsxLike, JSXDetectionHint } from "../jsx";
 export function isRenderFunctionLoose(context: RuleContext, node: AST.TSESTreeFunction) {
   const { body, parent } = node;
   // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-  if (AST.getFunctionIdentifier(node)?.name.startsWith("render")) {
+  if (AST.getFunctionId(node)?.name.startsWith("render")) {
     return parent.type === T.JSXExpressionContainer
       && parent.parent.type === T.JSXAttribute
       && parent.parent.name.type === T.JSXIdentifier
diff --git a/packages/core/src/hook/hook-collector.ts b/packages/core/src/hook/hook-collector.ts
@@ -25,7 +25,7 @@ export function useHookCollector(): useHookCollector.ReturnType {
   const hooks = new Map<string, Hook>();
   const functionEntries: FunctionEntry[] = [];
   const onFunctionEnter = (node: AST.TSESTreeFunction) => {
-    const id = AST.getFunctionIdentifier(node);
+    const id = AST.getFunctionId(node);
     const key = getId();
     const name = id?.name;
     if (name != null && isReactHookName(name)) {
diff --git a/packages/core/src/hook/hook-is.ts b/packages/core/src/hook/hook-is.ts
@@ -12,7 +12,7 @@ import { isReactHookName } from "./hook-name";
 
 export function isReactHook(node: AST.TSESTreeFunction | _) {
   if (node == null) return false;
-  const id = AST.getFunctionIdentifier(node);
+  const id = AST.getFunctionId(node);
   return id?.name != null && isReactHookName(id.name);
 }
 
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.ts
@@ -112,7 +112,7 @@ export function create(context: RuleContext<MessageID, Options>): RuleListener {
       const functionComponents = collector.ctx.getAllComponents(program);
       const classComponents = collectorLegacy.ctx.getAllComponents(program);
       for (const { node: component } of functionComponents.values()) {
-        const id = AST.getFunctionIdentifier(component);
+        const id = AST.getFunctionId(component);
         if (id?.name == null) continue;
         const name = id.name;
         if (isValidName(name, options)) return;
@@ -123,7 +123,7 @@ export function create(context: RuleContext<MessageID, Options>): RuleListener {
         });
       }
       for (const { node: component } of classComponents.values()) {
-        const id = AST.getClassIdentifier(component);
+        const id = AST.getClassId(component);
         if (id?.name == null) continue;
         const name = id.name;
         if (isValidName(name, options)) continue;
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-forward-ref.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-forward-ref.ts
@@ -50,7 +50,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
       if (!ER.isForwardRefCall(context, node)) {
         return;
       }
-      const id = AST.getFunctionIdentifier(node);
+      const id = AST.getFunctionId(node);
       context.report({
         messageId: "noForwardRef",
         node: id ?? node,
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-missing-component-display-name.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-missing-component-display-name.ts
@@ -48,14 +48,14 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
       const components = ctx.getAllComponents(program);
       for (const { node, displayName, flag } of components.values()) {
         const isMemoOrForwardRef = (flag & (ER.ComponentFlag.ForwardRef | ER.ComponentFlag.Memo)) > 0n;
-        if (AST.getFunctionIdentifier(node) != null) {
+        if (AST.getFunctionId(node) != null) {
           continue;
         }
         if (!isMemoOrForwardRef) {
           continue;
         }
         if (displayName == null) {
-          const id = AST.getFunctionIdentifier(node);
+          const id = AST.getFunctionId(node);
           context.report({
             messageId: "noMissingComponentDisplayName",
             node: id ?? node,
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-context-value.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-context-value.ts
@@ -81,7 +81,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
             messageId: "unstableContextValue",
             node: constructionNode,
             data: {
-              type: AST.toReadableNodeType(constructionNode),
+              type: AST.toDelimiterCaseType(constructionNode),
               suggestion,
             },
           });
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-default-props.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-default-props.ts
@@ -78,7 +78,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
           if (ER.isReactHookCall(construction.node)) {
             continue;
           }
-          const forbiddenType = AST.toReadableNodeType(right);
+          const forbiddenType = AST.toDelimiterCaseType(right);
           context.report({
             messageId: "noUnstableDefaultProps",
             node: right,
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
@@ -88,7 +88,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
     if (currentClass == null || !ER.isClassComponent(currentClass)) {
       return;
     }
-    const className = AST.getClassIdentifier(currentClass)?.name;
+    const className = AST.getClassId(currentClass)?.name;
     const defs = propertyDefs.get(currentClass);
     const usages = propertyUsages.get(currentClass);
     if (defs == null) {
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
@@ -62,7 +62,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
     if (currentClass == null || !ER.isClassComponent(currentClass)) {
       return;
     }
-    const className = AST.getClassIdentifier(currentClass)?.name;
+    const className = AST.getClassId(currentClass)?.name;
     const { node: defNode, isUsed = false } = stateDefs.get(currentClass) ?? {};
     if (defNode == null || isUsed) {
       return;
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/prefer-destructuring-assignment.ts b/packages/plugins/eslint-plugin-react-x/src/rules/prefer-destructuring-assignment.ts
@@ -62,7 +62,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
         if (!AST.isFunction(block)) {
           return false;
         }
-        const id = AST.getFunctionIdentifier(block);
+        const id = AST.getFunctionId(block);
         return id != null
           && ER.isComponentNameLoose(id.name)
           && components.some((component) => component.node === block);
diff --git a/packages/utilities/ast/src/__tests__/get-class-id.test.ts b/packages/utilities/ast/src/__tests__/get-class-id.test.ts
@@ -7,7 +7,7 @@ import { simpleTraverse } from "@typescript-eslint/typescript-estree";
 
 import { describe, expect, it } from "vitest";
 import { getFixturesRootDir } from "../../../../../test";
-import { getClassIdentifier } from "../ast-class-id";
+import { getClassId } from "../ast-class-id";
 
 function parse(code: string) {
   return parseForESLint(code, {
@@ -29,10 +29,11 @@ describe("get class identifier from class declaration", () => {
         if (node.type !== T.ClassDeclaration) {
           return;
         }
-        expect(getClassIdentifier(node)).include({ type: T.Identifier, name: expected });
+        expect(getClassId(node)).include({ type: T.Identifier, name: expected });
         n = node;
       },
     }, true);
+    ``;
     expect(n).not.toBeNull();
   });
 });
@@ -50,7 +51,7 @@ describe("get class identifier from class expression", () => {
         if (node.type !== T.ClassExpression) {
           return;
         }
-        expect(getClassIdentifier(node)).include({ type: T.Identifier, name: expected });
+        expect(getClassId(node)).include({ type: T.Identifier, name: expected });
         n = node;
       },
     }, true);
diff --git a/packages/utilities/ast/src/__tests__/get-function-id.test.ts b/packages/utilities/ast/src/__tests__/get-function-id.test.ts
@@ -7,7 +7,7 @@ import { simpleTraverse } from "@typescript-eslint/typescript-estree";
 
 import { describe, expect, it } from "vitest";
 import { getFixturesRootDir } from "../../../../../test";
-import { getFunctionIdentifier } from "../ast-function-id";
+import { getFunctionId } from "../ast-function-id";
 import { isFunction } from "../ast-is";
 
 function parse(code: string) {
@@ -29,7 +29,7 @@ describe("get function identifier from function declaration", () => {
         if (!isFunction(node)) {
           return;
         }
-        expect(getFunctionIdentifier(node)).include({ type: T.Identifier, name: expected });
+        expect(getFunctionId(node)).include({ type: T.Identifier, name: expected });
         n = node;
       },
     }, true);
@@ -64,7 +64,7 @@ describe("get function identifier from function expression", () => {
         if (!isFunction(node)) {
           return;
         }
-        expect(getFunctionIdentifier(node)).include({ type: T.Identifier, name: expected });
+        expect(getFunctionId(node)).include({ type: T.Identifier, name: expected });
         n = node;
       },
     }, true);
diff --git a/packages/utilities/ast/src/__tests__/get-nested-return-statements.test.ts b/packages/utilities/ast/src/__tests__/get-nested-return-statements.test.ts
@@ -9,7 +9,7 @@ import tsx from "dedent";
 import { describe, expect, it } from "vitest";
 import { getFixturesRootDir } from "../../../../../test";
 import { isFunction } from "../ast-is";
-import { getNestedReturnStatements } from "../ast-return-statement";
+import { getNestedReturnStatements } from "../ast-hierarchy";
 
 function parse(code: string) {
   return parseForESLint(code, {
diff --git a/packages/utilities/ast/src/ast-class-id.ts b/packages/utilities/ast/src/ast-class-id.ts
@@ -9,7 +9,7 @@ import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
  * @param node The AST node to check
  * @returns class identifier or null
  */
-export function getClassIdentifier(node: TSESTreeClass): TSESTree.Identifier | _ {
+export function getClassId(node: TSESTreeClass): TSESTree.Identifier | _ {
   if (node.id != null) return node.id;
   if (node.parent.type === T.VariableDeclarator && node.parent.id.type === T.Identifier) {
     return node.parent.id;
diff --git a/packages/utilities/ast/src/ast-expression.ts b/packages/utilities/ast/src/ast-expression.ts
@@ -22,125 +22,3 @@ export function getJSExpression(node: TSESTree.Node): Exclude<
 export function isThisExpression(node: TSESTree.Expression) {
   return getJSExpression(node).type === T.ThisExpression;
 }
-
-/**
- * Get all nested expressions of type T in an expression like node
- * @param type The type of the expression to retrieve within the node
- * @returns A partially applied function bound to a predicate of type T. The returned function can be called passing a
- * node, and it will return an array of all nested expressions of type T.
- */
-// dprint-ignore
-export function getNestedExpressionsOfType<TNodeType extends T>(type: TNodeType): (node: TSESTree.Node) => Extract<TSESTree.Node, { type: TNodeType }>[] {
-  const isNodeOfType = is(type);
-  return function(node) {
-    const boundGetNestedExpressionsOfType = getNestedExpressionsOfType(type);
-    const expressions: Extract<TSESTree.Node, { type: TNodeType }>[] = [];
-    if (isNodeOfType(node)) {
-      expressions.push(node);
-    }
-    if ("arguments" in node) {
-      const chunk = node.arguments
-        .map(getNestedExpressionsOfType(type))
-        .flat(1);
-      expressions.push(...chunk);
-    }
-    if (
-      "expression" in node
-      && node.expression !== true
-      && node.expression !== false
-    ) {
-      const chunk = boundGetNestedExpressionsOfType(node.expression);
-      expressions.push(...chunk);
-    }
-    if ("left" in node) {
-      const chunk = boundGetNestedExpressionsOfType(node.left);
-      expressions.push(...chunk);
-    }
-    if ("right" in node) {
-      const chunk = boundGetNestedExpressionsOfType(node.right);
-      expressions.push(...chunk);
-    }
-    if ("test" in node && node.test != null) {
-      const chunk = boundGetNestedExpressionsOfType(node.test);
-      expressions.push(...chunk);
-    }
-    if ("consequent" in node) {
-      const chunk = Array.isArray(node.consequent)
-        ? node.consequent.map(boundGetNestedExpressionsOfType).flat(1)
-        : boundGetNestedExpressionsOfType(node.consequent);
-      expressions.push(...chunk);
-    }
-    if ("alternate" in node && node.alternate != null) {
-      const chunk = Array.isArray(node.alternate)
-        ? node.alternate.map(boundGetNestedExpressionsOfType).flat(1)
-        : boundGetNestedExpressionsOfType(node.alternate);
-      expressions.push(...chunk);
-    }
-    if ("elements" in node) {
-      const chunk = node.elements
-        .filter((x) => x != null)
-        .map(getNestedExpressionsOfType(type))
-        .flat(1);
-      expressions.push(...chunk);
-    }
-    if ("properties" in node) {
-      const chunk = node.properties
-        .map(boundGetNestedExpressionsOfType)
-        .flat(1);
-      expressions.push(...chunk);
-    }
-    if ("expressions" in node) {
-      const chunk = node.expressions
-        .map(boundGetNestedExpressionsOfType)
-        .flat(1);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.Property) {
-      const chunk = boundGetNestedExpressionsOfType(node.value);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.SpreadElement) {
-      const chunk = boundGetNestedExpressionsOfType(node.argument);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.MemberExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.object);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.UnaryExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.argument);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.ChainExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.expression);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.TSNonNullExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.expression);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.TSAsExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.expression);
-      expressions.push(...chunk);
-    }
-    if (node.type === T.TSSatisfiesExpression) {
-      const chunk = boundGetNestedExpressionsOfType(node.expression);
-      expressions.push(...chunk);
-    }
-    return expressions;
-  };
-}
-
-/**
- * Get all nested new expressions in an expression like node
- * @param node The node to get the nested new expressions from
- * @returns All nested new expressions
- */
-export const getNestedNewExpressions = getNestedExpressionsOfType(T.NewExpression);
-
-/**
- * Get all nested call expressions in a expression like node
- * @param node The node to get the nested call expressions from
- * @returns All nested call expressions
- */
-export const getNestedCallExpressions = getNestedExpressionsOfType(T.CallExpression);
diff --git a/packages/utilities/ast/src/ast-function-id.ts b/packages/utilities/ast/src/ast-function-id.ts
@@ -14,7 +14,7 @@ import { _ } from "@eslint-react/eff";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import { isMethodOrProperty, isTypeAssertionExpression } from "./ast-is";
 
-export function getFunctionIdentifier(node: TSESTree.Expression | TSESTreeFunction): TSESTree.Identifier | _ {
+export function getFunctionId(node: TSESTree.Expression | TSESTreeFunction): TSESTree.Identifier | _ {
   switch (true) {
     // function MaybeComponent() {}
     case "id" in node
@@ -56,7 +56,7 @@ export function getFunctionIdentifier(node: TSESTree.Expression | TSESTreeFuncti
     // const MaybeComponent = (() => {}) as FunctionComponent;
     // const MaybeComponent = (() => {}) satisfies FunctionComponent;
     case isTypeAssertionExpression(node.parent):
-      return getFunctionIdentifier(node.parent);
+      return getFunctionId(node.parent);
   }
   return _;
 }
diff --git a/packages/utilities/ast/src/ast-hierarchy.ts b/packages/utilities/ast/src/ast-hierarchy.ts
diff --git a/packages/utilities/ast/src/ast-id.ts b/packages/utilities/ast/src/ast-id.ts
diff --git a/packages/utilities/ast/src/ast-return-statement.ts b/packages/utilities/ast/src/ast-return-statement.ts
diff --git a/packages/utilities/ast/src/ast-to-readable-node-type.ts b/packages/utilities/ast/src/ast-to-readable-node-type.ts
diff --git a/packages/utilities/ast/src/ast-to-string.ts b/packages/utilities/ast/src/ast-to-string.ts
diff --git a/packages/utilities/ast/src/index.ts b/packages/utilities/ast/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ export function useComponentCollectorLegacy(): useComponentCollectorLegacy.Retur`
`34`	`34`	`if (!isClassComponent(node)) {`
`35`	`35`	`return;`
`36`	`36`	`}`
`37`		`- const id = AST.getClassIdentifier(node);`
	`37`	`+ const id = AST.getClassId(node);`
`38`	`38`	`const key = getId();`
`39`	`39`	`const flag = isPureComponent(node)`
`40`	`40`	`? ComponentFlag.PureComponent`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ export function getFunctionComponentId(`
`9`	`9`	`context: RuleContext,`
`10`	`10`	`node: AST.TSESTreeFunction,`
`11`	`11`	`): TSESTree.Identifier \| TSESTree.Identifier[] \| _ {`
`12`		`- const functionId = AST.getFunctionIdentifier(node);`
	`12`	`+ const functionId = AST.getFunctionId(node);`
`13`	`13`	`if (functionId != null) {`
`14`	`14`	`return functionId;`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import { isReactHookName } from "./hook-name";`
`12`	`12`
`13`	`13`	`export function isReactHook(node: AST.TSESTreeFunction \| _) {`
`14`	`14`	`if (node == null) return false;`
`15`		`- const id = AST.getFunctionIdentifier(node);`
	`15`	`+ const id = AST.getFunctionId(node);`
`16`	`16`	`return id?.name != null && isReactHookName(id.name);`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {`
`50`	`50`	`if (!ER.isForwardRefCall(context, node)) {`
`51`	`51`	`return;`
`52`	`52`	`}`
`53`		`- const id = AST.getFunctionIdentifier(node);`
	`53`	`+ const id = AST.getFunctionId(node);`
`54`	`54`	`context.report({`
`55`	`55`	`messageId: "noForwardRef",`
`56`	`56`	`node: id ?? node,`