refactor: minor improvements

Rel1cx · Rel1cx · commit a432afe9052a · 2024-12-01T03:37:12.000+08:00
diff --git a/packages/core/docs/README.md b/packages/core/docs/README.md
@@ -34,7 +34,7 @@
 - [ERClassComponentFlag](variables/ERClassComponentFlag.md)
 - [ERComponentHint](variables/ERComponentHint.md)
 - [ERFunctionComponentFlag](variables/ERFunctionComponentFlag.md)
-- [PHASE\_RELEVANCE](variables/PHASE_RELEVANCE.md)
+- [ERPhaseRelevance](variables/ERPhaseRelevance.md)
 - [RE\_COMPONENT\_NAME](variables/RE_COMPONENT_NAME.md)
 - [RE\_HOOK\_NAME](variables/RE_HOOK_NAME.md)
 
diff --git a/packages/core/docs/variables/ERPhaseRelevance.md b/packages/core/docs/variables/ERPhaseRelevance.md
@@ -2,11 +2,11 @@
 
 ***
 
-[@eslint-react/core](../README.md) / PHASE\_RELEVANCE
+[@eslint-react/core](../README.md) / ERPhaseRelevance
 
-# Variable: PHASE\_RELEVANCE
+# Variable: ERPhaseRelevance
 
-> `const` **PHASE\_RELEVANCE**: `BiRecord`\<`object`\>
+> `const` **ERPhaseRelevance**: `BiRecord`\<`object`\>
 
 ## Type declaration
 
diff --git a/packages/core/src/component/component-id.ts b/packages/core/src/component/component-id.ts
@@ -5,7 +5,7 @@ import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
 
 import { isReactHookCallWithNameLoose } from "../hook";
-import { isForwardRefCall, isMemoCall } from "../react-api";
+import { isForwardRefCall, isMemoCall } from "../utils";
 
 function isComponentWrapperCall(node: TSESTree.Node, context: RuleContext) {
   if (node.type !== AST_NODE_TYPES.CallExpression) return false;
diff --git a/packages/core/src/element/hierarchy.ts b/packages/core/src/element/hierarchy.ts
@@ -4,7 +4,7 @@ import type { RuleContext } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
 
-import { isCreateElementCall } from "../react-api";
+import { isCreateElementCall } from "../utils";
 
 /**
  * Determines whether inside createElement's props.
diff --git a/packages/core/src/element/misc.ts b/packages/core/src/element/misc.ts
@@ -3,7 +3,7 @@ import type { RuleContext } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
 
-import { isInitializedFromReact } from "../is-initialized-from-react";
+import { isInitializedFromReact } from "../utils";
 
 /**
  * Check if a node is `<Fragment></Fragment>` or `<Pragma.Fragment></Pragma.Fragment>`
diff --git a/packages/core/src/hook/is.ts b/packages/core/src/hook/is.ts
@@ -5,7 +5,7 @@ import type { RuleContext } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
 
-import { isInitializedFromReact } from "../is-initialized-from-react";
+import { isInitializedFromReact } from "../utils";
 import { isReactHookName } from "./hook-name";
 
 export function isReactHook(node: AST.TSESTreeFunction) {
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -2,12 +2,9 @@ export * from "./component";
 export * from "./effect";
 export * from "./element";
 export * from "./hook";
-export * from "./is-from-react";
-export * from "./is-initialized-from-react";
-export * from "./is-react-api";
 export * from "./phase";
-export * from "./react-api";
 export * from "./render-prop";
 export type * from "./semantic-entry";
 export type * from "./semantic-node";
 export * from "./state";
+export * from "./utils";
diff --git a/packages/core/src/is-react-api.ts b/packages/core/src/is-react-api.ts
diff --git a/packages/core/src/phase.ts b/packages/core/src/phase.ts
diff --git a/packages/core/src/phase/constants.ts b/packages/core/src/phase/constants.ts
@@ -0,0 +1,6 @@
+import birecord from "birecord";
+
+export const ERPhaseRelevance = birecord({
+  mount: "unmount",
+  setup: "cleanup",
+});
diff --git a/packages/core/src/phase/index.ts b/packages/core/src/phase/index.ts
@@ -0,0 +1,3 @@
+export * from "./constants";
+export * from "./is-inverse-phase";
+export type * from "./phase";
diff --git a/packages/core/src/phase/is-inverse-phase.ts b/packages/core/src/phase/is-inverse-phase.ts
@@ -0,0 +1,9 @@
+import { F } from "@eslint-react/tools";
+
+import { ERPhaseRelevance } from "./constants";
+import type { ERPhaseKind } from "./phase";
+
+export const isInversePhase: {
+  (a: ERPhaseKind): (b: ERPhaseKind) => boolean;
+  (a: ERPhaseKind, b: ERPhaseKind): boolean;
+} = F.dual(2, (a: ERPhaseKind, b: ERPhaseKind) => ERPhaseRelevance.get(a) === b);
diff --git a/packages/core/src/phase/phase.ts b/packages/core/src/phase/phase.ts
@@ -0,0 +1,3 @@
+export type EREffectPhaseKind = "cleanup" | "setup";
+export type ERLifecyclePhaseKind = "mount" | "unmount";
+export type ERPhaseKind = EREffectPhaseKind | ERLifecyclePhaseKind;
diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
@@ -0,0 +1,3 @@
+export * from "./is-from-react";
+export * from "./is-initialized-from-react";
+export * from "./is-react-api";
diff --git a/packages/core/src/utils/is-from-react.ts b/packages/core/src/utils/is-from-react.ts
diff --git a/packages/core/src/utils/is-initialized-from-react.ts b/packages/core/src/utils/is-initialized-from-react.ts
diff --git a/packages/core/src/utils/is-react-api.ts b/packages/core/src/utils/is-react-api.ts
@@ -1,4 +1,20 @@
-import { isReactAPICallWithName, isReactAPIWithName } from "./is-react-api";
+import { isCallFromReact, isCallFromReactMember, isFromReact, isFromReactMember } from "./is-from-react";
+
+export function isReactAPIWithName(name: string): ReturnType<typeof isFromReact>;
+export function isReactAPIWithName(name: string, member: string): ReturnType<typeof isFromReactMember>;
+export function isReactAPIWithName(name: string, member?: string) {
+  return member
+    ? isFromReactMember(name, member)
+    : isFromReact(name);
+}
+
+export function isReactAPICallWithName(name: string): ReturnType<typeof isCallFromReact>;
+export function isReactAPICallWithName(name: string, member: string): ReturnType<typeof isCallFromReactMember>;
+export function isReactAPICallWithName(name: string, member?: string) {
+  return member
+    ? isCallFromReactMember(name, member)
+    : isCallFromReact(name);
+}
 
 export const isChildrenCount = isReactAPIWithName("Children", "count");
 export const isChildrenForEach = isReactAPIWithName("Children", "forEach");
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-event-listener.ts b/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-event-listener.ts
@@ -1,7 +1,7 @@
 /* eslint-disable better-mutation/no-mutating-methods */
 import * as AST from "@eslint-react/ast";
 import type { EREffectMethodKind, ERLifecycleMethodKind, ERPhaseKind } from "@eslint-react/core";
-import { isInversePhase, PHASE_RELEVANCE } from "@eslint-react/core";
+import { isInversePhase, ERPhaseRelevance } from "@eslint-react/core";
 import * as JSX from "@eslint-react/jsx";
 import { F, isBoolean, O } from "@eslint-react/tools";
 import * as VAR from "@eslint-react/var";
@@ -214,7 +214,7 @@ export default createRule<[], MessageID>({
       ["CallExpression"](node) {
         const [fNode, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
         if (!fNode || !fKind) return;
-        if (!PHASE_RELEVANCE.has(fKind)) return;
+        if (!ERPhaseRelevance.has(fKind)) return;
         match(getCallKind(node))
           .with("addEventListener", (callKind) => {
             const [type, listener, options] = node.arguments;
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-interval.ts b/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-interval.ts
@@ -1,7 +1,7 @@
 /* eslint-disable better-mutation/no-mutating-methods */
 import type * as AST from "@eslint-react/ast";
 import type { EREffectMethodKind, ERLifecycleMethodKind, ERPhaseKind } from "@eslint-react/core";
-import { PHASE_RELEVANCE } from "@eslint-react/core";
+import { ERPhaseRelevance } from "@eslint-react/core";
 import { F, O } from "@eslint-react/tools";
 import * as VAR from "@eslint-react/var";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -93,7 +93,7 @@ export default createRule<[], MessageID>({
           case "clearInterval": {
             const [fNode, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
             if (!fNode || !fKind) break;
-            if (!PHASE_RELEVANCE.has(fKind)) break;
+            if (!ERPhaseRelevance.has(fKind)) break;
             const [intervalIdNode] = node.arguments;
             if (!intervalIdNode) break;
             cEntries.push({
@@ -108,7 +108,7 @@ export default createRule<[], MessageID>({
           case "setInterval": {
             const [fNode, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
             if (!fNode || !fKind) break;
-            if (!PHASE_RELEVANCE.has(fKind)) break;
+            if (!ERPhaseRelevance.has(fKind)) break;
             const intervalIdNode = O.getOrNull(VAR.getVariableDeclaratorID(node));
             if (!intervalIdNode) {
               context.report({
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-resize-observer.ts b/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-resize-observer.ts
@@ -1,7 +1,7 @@
 /* eslint-disable better-mutation/no-mutating-methods */
 import * as AST from "@eslint-react/ast";
 import type { EREffectMethodKind, ERPhaseKind } from "@eslint-react/core";
-import { PHASE_RELEVANCE } from "@eslint-react/core";
+import { ERPhaseRelevance } from "@eslint-react/core";
 import { F, not, O, or } from "@eslint-react/tools";
 import type { RuleContext } from "@eslint-react/types";
 import * as VAR from "@eslint-react/var";
@@ -124,7 +124,7 @@ export default createRule<[], MessageID>({
       ["CallExpression"](node) {
         const [_, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
         if (node.callee.type !== AST_NODE_TYPES.MemberExpression) return;
-        if (!PHASE_RELEVANCE.has(fKind)) return;
+        if (!ERPhaseRelevance.has(fKind)) return;
         const { object } = node.callee;
         match(getCallKind(node, context))
           .with("disconnect", () => {
@@ -170,7 +170,7 @@ export default createRule<[], MessageID>({
       },
       ["NewExpression"](node) {
         const [fNode, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
-        if (!fNode || !PHASE_RELEVANCE.has(fKind)) return;
+        if (!fNode || !ERPhaseRelevance.has(fKind)) return;
         if (!isNewResizeObserver(node)) return;
         const id = getInstanceID(node);
         if (O.isNone(id)) {
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-timeout.ts b/packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-timeout.ts
@@ -1,7 +1,7 @@
 /* eslint-disable better-mutation/no-mutating-methods */
 import type * as AST from "@eslint-react/ast";
 import type { EREffectMethodKind, ERLifecycleMethodKind, ERPhaseKind } from "@eslint-react/core";
-import { PHASE_RELEVANCE } from "@eslint-react/core";
+import { ERPhaseRelevance } from "@eslint-react/core";
 import { F, O } from "@eslint-react/tools";
 import * as VAR from "@eslint-react/var";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -90,7 +90,7 @@ export default createRule<[], MessageID>({
       ["CallExpression"](node) {
         const [fNode, fKind] = fStack.findLast(f => f.at(1) !== "other") ?? [];
         if (!fNode || !fKind) return;
-        if (!PHASE_RELEVANCE.has(fKind)) return;
+        if (!ERPhaseRelevance.has(fKind)) return;
         switch (getCallKind(node)) {
           case "clearTimeout": {
             const [timeoutIdNode] = node.arguments;
