refactor: simplify various AST traversal methods usage

Rel1cx · Rel1cx · commit ea4d8c8d9ea1 · 2024-12-29T17:14:44.000+08:00
diff --git a/packages/core/src/component/component-render-method.ts b/packages/core/src/component/component-render-method.ts
@@ -42,9 +42,7 @@ export function isFunctionOfRenderMethod(node: AST.TSESTreeFunction) {
  * @returns `true` if node is inside class component's render block, `false` if not
  */
 export function isInsideRenderMethod(node: TSESTree.Node) {
-  const predicate = (node: TSESTree.Node): node is TSESTree.MethodDefinition => {
+  return O.isSome(AST.traverseUp(node, (node: TSESTree.Node) => {
     return isRenderMethodLike(node) && isClassComponent(node.parent.parent);
-  };
-
-  return O.isSome(AST.traverseUp(node, predicate));
+  }));
 }
diff --git a/packages/core/src/hook/hierarchy.ts b/packages/core/src/hook/hierarchy.ts
@@ -1,14 +1,9 @@
 import * as AST from "@eslint-react/ast";
 import { O } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
-import { AST_NODE_TYPES } from "@typescript-eslint/types";
 
-import { isReactHook, isReactHookCall } from "./is";
+import { isReactHook } from "./is";
 
 export function isInsideReactHook(node: TSESTree.Node) {
   return O.exists(AST.traverseUpGuard(node, AST.isFunction), isReactHook);
 }
-
-export function isInsideReactHookCall(node: TSESTree.Node): boolean {
-  return O.isSome(AST.traverseUp(node, n => AST.is(AST_NODE_TYPES.CallExpression)(n) && isReactHookCall(n)));
-}
diff --git a/packages/core/src/hook/is.ts b/packages/core/src/hook/is.ts
@@ -21,7 +21,8 @@ export function isReactHook(node: AST.TSESTreeFunction) {
  * @param node The node to check.
  * @returns `true` if the node is a React Hook call, `false` otherwise.
  */
-export function isReactHookCall(node: TSESTree.CallExpression) {
+export function isReactHookCall(node: TSESTree.Node) {
+  if (node.type !== AST_NODE_TYPES.CallExpression) return false;
   if (node.callee.type === AST_NODE_TYPES.Identifier) return isReactHookName(node.callee.name);
   if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
     return node.callee.property.type === AST_NODE_TYPES.Identifier && isReactHookName(node.callee.property.name);
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.ts
@@ -9,7 +9,7 @@ import {
   useComponentCollector,
   useComponentCollectorLegacy,
 } from "@eslint-react/core";
-import { O } from "@eslint-react/eff";
+import { O, or } from "@eslint-react/eff";
 import * as JSX from "@eslint-react/jsx";
 import type { RuleFeature } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
@@ -123,7 +123,7 @@ export default createRule<[], MessageID>({
           }
         }
         for (const { name, node: component } of classComponents) {
-          if (O.isNone(AST.traverseUp(component, node => isClassComponent(node) || isFunctionComponent(node)))) {
+          if (O.isNone(AST.traverseUp(component, or(isClassComponent, isFunctionComponent)))) {
             continue;
           }
           context.report({
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-did-mount.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-did-mount.ts
@@ -41,22 +41,19 @@ export default createRule<[], MessageID>({
     if (!context.sourceCode.text.includes("componentDidMount")) return {};
     function getReportDescriptor(node: TSESTree.CallExpression): O.Option<ReportDescriptor<MessageID>> {
       if (!isThisSetState(node)) return O.none();
-      const maybeParentClass = AST.traverseUp(
-        node,
-        AST.isOneOf([AST_NODE_TYPES.ClassDeclaration, AST_NODE_TYPES.ClassExpression]),
+      return F.pipe(
+        O.Do,
+        O.bind("clazz", () => AST.traverseUpGuard(node, isClassComponent)),
+        O.bind("method", ({ clazz }) => AST.traverseUpStop(node, clazz, isComponentDidMount)),
+        O.bind("upperScope", () => O.fromNullable(context.sourceCode.getScope(node).upper)),
+        O.filter(({ clazz, method, upperScope }) =>
+          method.parent === clazz.body && upperScope === context.sourceCode.getScope(method)
+        ),
+        O.map(() => ({
+          messageId: "noSetStateInComponentDidMount",
+          node,
+        })),
       );
-      if (O.isNone(maybeParentClass)) return O.none();
-      const parentClass = maybeParentClass.value;
-      if (!isClassComponent(parentClass)) return O.none();
-      const maybeParentMethod = AST.traverseUp(node, isComponentDidMount);
-      if (O.isNone(maybeParentMethod)) return O.none();
-      const parentMethod = maybeParentMethod.value;
-      if (parentMethod.parent !== parentClass.body) return O.none();
-      if (context.sourceCode.getScope(node).upper !== context.sourceCode.getScope(parentMethod)) return O.none();
-      return O.some({
-        messageId: "noSetStateInComponentDidMount",
-        node,
-      });
     }
     return {
       CallExpression: F.flow(getReportDescriptor, O.map(context.report)),
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-did-update.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-did-update.ts
@@ -41,22 +41,19 @@ export default createRule<[], MessageID>({
     if (!context.sourceCode.text.includes("componentDidUpdate")) return {};
     function getReportDescriptor(node: TSESTree.CallExpression): O.Option<ReportDescriptor<MessageID>> {
       if (!isThisSetState(node)) return O.none();
-      const maybeParentClass = AST.traverseUp(
-        node,
-        AST.isOneOf([AST_NODE_TYPES.ClassDeclaration, AST_NODE_TYPES.ClassExpression]),
+      return F.pipe(
+        O.Do,
+        O.bind("clazz", () => AST.traverseUpGuard(node, isClassComponent)),
+        O.bind("method", ({ clazz }) => AST.traverseUpStop(node, clazz, isComponentDidUpdate)),
+        O.bind("upperScope", () => O.fromNullable(context.sourceCode.getScope(node).upper)),
+        O.filter(({ clazz, method, upperScope }) =>
+          method.parent === clazz.body && upperScope === context.sourceCode.getScope(method)
+        ),
+        O.map(() => ({
+          messageId: "noSetStateInComponentDidUpdate",
+          node,
+        })),
       );
-      if (O.isNone(maybeParentClass)) return O.none();
-      const parentClass = maybeParentClass.value;
-      if (!isClassComponent(parentClass)) return O.none();
-      const maybeParentMethod = AST.traverseUp(node, isComponentDidUpdate);
-      if (O.isNone(maybeParentMethod)) return O.none();
-      const parentMethod = maybeParentMethod.value;
-      if (parentMethod.parent !== parentClass.body) return O.none();
-      if (context.sourceCode.getScope(node).upper !== context.sourceCode.getScope(parentMethod)) return O.none();
-      return O.some({
-        messageId: "noSetStateInComponentDidUpdate",
-        node,
-      });
     }
     return {
       CallExpression: F.flow(getReportDescriptor, O.map(context.report)),
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-will-update.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-set-state-in-component-will-update.ts
@@ -41,22 +41,19 @@ export default createRule<[], MessageID>({
     if (!context.sourceCode.text.includes("componentWillUpdate")) return {};
     function getReportDescriptor(node: TSESTree.CallExpression): O.Option<ReportDescriptor<MessageID>> {
       if (!isThisSetState(node)) return O.none();
-      const maybeParentClass = AST.traverseUp(
-        node,
-        AST.isOneOf([AST_NODE_TYPES.ClassDeclaration, AST_NODE_TYPES.ClassExpression]),
+      return F.pipe(
+        O.Do,
+        O.bind("clazz", () => AST.traverseUpGuard(node, isClassComponent)),
+        O.bind("method", ({ clazz }) => AST.traverseUpStop(node, clazz, isComponentWillUpdate)),
+        O.bind("upperScope", () => O.fromNullable(context.sourceCode.getScope(node).upper)),
+        O.filter(({ clazz, method, upperScope }) =>
+          method.parent === clazz.body && upperScope === context.sourceCode.getScope(method)
+        ),
+        O.map(() => ({
+          messageId: "noSetStateInComponentWillUpdate",
+          node,
+        })),
       );
-      if (O.isNone(maybeParentClass)) return O.none();
-      const parentClass = maybeParentClass.value;
-      if (!isClassComponent(parentClass)) return O.none();
-      const maybeParentMethod = AST.traverseUp(node, isComponentWillUpdate);
-      if (O.isNone(maybeParentMethod)) return O.none();
-      const parentMethod = maybeParentMethod.value;
-      if (parentMethod.parent !== parentClass.body) return O.none();
-      if (context.sourceCode.getScope(node).upper !== context.sourceCode.getScope(parentMethod)) return O.none();
-      return O.some({
-        messageId: "noSetStateInComponentWillUpdate",
-        node,
-      });
     }
     return {
       CallExpression: F.flow(getReportDescriptor, O.map(context.report)),

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import {`
`9`	`9`	`useComponentCollector,`
`10`	`10`	`useComponentCollectorLegacy,`
`11`	`11`	`} from "@eslint-react/core";`
`12`		`-import { O } from "@eslint-react/eff";`
	`12`	`+import { O, or } from "@eslint-react/eff";`
`13`	`13`	`import * as JSX from "@eslint-react/jsx";`
`14`	`14`	`import type { RuleFeature } from "@eslint-react/types";`
`15`	`15`	`import type { TSESTree } from "@typescript-eslint/types";`
`@@ -123,7 +123,7 @@ export default createRule<[], MessageID>({`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`	`for (const { name, node: component } of classComponents) {`
`126`		`- if (O.isNone(AST.traverseUp(component, node => isClassComponent(node) \|\| isFunctionComponent(node)))) {`
	`126`	`+ if (O.isNone(AST.traverseUp(component, or(isClassComponent, isFunctionComponent)))) {`
`127`	`127`	`continue;`
`128`	`128`	`}`
`129`	`129`	`context.report({`