refactor(core): rename and consolidate component flag types

Rel1cx · Rel1cx · commit 80e673fd1b58 · 2025-01-21T02:59:24.000+08:00
diff --git a/packages/core/docs/README.md b/packages/core/docs/README.md
@@ -15,13 +15,12 @@
 
 ## Type Aliases
 
-- [ERClassComponentFlag](type-aliases/ERClassComponentFlag.md)
 - [ERComponent](type-aliases/ERComponent.md)
+- [ERComponentFlag](type-aliases/ERComponentFlag.md)
 - [ERComponentHint](type-aliases/ERComponentHint.md)
 - [ERComponentKind](type-aliases/ERComponentKind.md)
 - [EREffectKind](type-aliases/EREffectKind.md)
 - [EREffectPhaseKind](type-aliases/EREffectPhaseKind.md)
-- [ERFunctionComponentFlag](type-aliases/ERFunctionComponentFlag.md)
 - [ERHookKind](type-aliases/ERHookKind.md)
 - [ERLifecyclePhaseKind](type-aliases/ERLifecyclePhaseKind.md)
 - [ERPhaseKind](type-aliases/ERPhaseKind.md)
@@ -31,9 +30,8 @@
 
 - [COMPONENT\_DISPLAY\_NAME\_ASSIGNMENT\_SELECTOR](variables/COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR.md)
 - [DEFAULT\_COMPONENT\_HINT](variables/DEFAULT_COMPONENT_HINT.md)
-- [ERClassComponentFlag](variables/ERClassComponentFlag.md)
+- [ERComponentFlag](variables/ERComponentFlag.md)
 - [ERComponentHint](variables/ERComponentHint.md)
-- [ERFunctionComponentFlag](variables/ERFunctionComponentFlag.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/type-aliases/ERClassComponentFlag.md b/packages/core/docs/type-aliases/ERClassComponentFlag.md
diff --git a/packages/core/docs/type-aliases/ERComponentFlag.md b/packages/core/docs/type-aliases/ERComponentFlag.md
@@ -0,0 +1,9 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / ERComponentFlag
+
+# Type Alias: ERComponentFlag
+
+> **ERComponentFlag**: `bigint`
diff --git a/packages/core/docs/type-aliases/ERFunctionComponentFlag.md b/packages/core/docs/type-aliases/ERFunctionComponentFlag.md
diff --git a/packages/core/docs/variables/ERClassComponentFlag.md b/packages/core/docs/variables/ERClassComponentFlag.md
diff --git a/packages/core/docs/variables/ERComponentFlag.md b/packages/core/docs/variables/ERComponentFlag.md
@@ -0,0 +1,35 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / ERComponentFlag
+
+# Variable: ERComponentFlag
+
+> **ERComponentFlag**: `object`
+
+## Type declaration
+
+### Async
+
+> **Async**: `bigint`
+
+### CreateElement
+
+> **CreateElement**: `bigint`
+
+### ForwardRef
+
+> **ForwardRef**: `bigint`
+
+### Memo
+
+> **Memo**: `bigint`
+
+### None
+
+> **None**: `bigint` = `0n`
+
+### PureComponent
+
+> **PureComponent**: `bigint`
diff --git a/packages/core/docs/variables/ERFunctionComponentFlag.md b/packages/core/docs/variables/ERFunctionComponentFlag.md
diff --git a/packages/core/src/component/component-collector-legacy.ts b/packages/core/src/component/component-collector-legacy.ts
@@ -3,7 +3,7 @@ import { _ } from "@eslint-react/eff";
 import { getId } from "@eslint-react/shared";
 import type { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
 
-import { ERClassComponentFlag } from "./component-flag";
+import { ERComponentFlag } from "./component-flag";
 import type { ERClassComponent } from "./component-semantic-node";
 import { isClassComponent, isPureComponent } from "./is";
 
@@ -28,8 +28,8 @@ export function useComponentCollectorLegacy() {
     const id = AST.getClassIdentifier(node);
     const key = getId();
     const flag = isPureComponent(node)
-      ? ERClassComponentFlag.PureComponent
-      : ERClassComponentFlag.None;
+      ? ERComponentFlag.PureComponent
+      : ERComponentFlag.None;
     components.set(
       key,
       {
diff --git a/packages/core/src/component/component-collector.ts b/packages/core/src/component/component-collector.ts
@@ -11,7 +11,7 @@ import { isChildrenOfCreateElement } from "../element";
 import { isReactHookCall } from "../hook";
 import { DEFAULT_COMPONENT_HINT, ERComponentHint } from "./component-collector-hint";
 import { COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR } from "./component-display-name";
-import { ERFunctionComponentFlag } from "./component-flag";
+import { ERComponentFlag } from "./component-flag";
 import { getFunctionComponentIdentifier } from "./component-id";
 import { isFunctionOfRenderMethod } from "./component-lifecycle";
 import { getComponentNameFromIdentifier, hasNoneOrValidComponentName } from "./component-name";
@@ -47,12 +47,12 @@ function hasValidHierarchy(node: AST.TSESTreeFunction, context: RuleContext, hin
 }
 
 function getComponentFlag(initPath: ERFunctionComponent["initPath"]) {
-  let flag = ERFunctionComponentFlag.None;
+  let flag = ERComponentFlag.None;
   if (initPath != null && AST.hasCallInFunctionInitPath("memo", initPath)) {
-    flag |= ERFunctionComponentFlag.Memo;
+    flag |= ERComponentFlag.Memo;
   }
   if (initPath != null && AST.hasCallInFunctionInitPath("forwardRef", initPath)) {
-    flag |= ERFunctionComponentFlag.ForwardRef;
+    flag |= ERComponentFlag.ForwardRef;
   }
   return flag;
 }
diff --git a/packages/core/src/component/component-flag.ts b/packages/core/src/component/component-flag.ts
@@ -1,24 +1,11 @@
-export type ERClassComponentFlag = bigint;
+/* eslint-disable perfectionist/sort-objects */
+export type ERComponentFlag = bigint;
 
-export const ERClassComponentFlag = {
+export const ERComponentFlag = {
   None: 0n,
   PureComponent: 1n << 0n,
-  // Reserved for future use
-  // CreateElement: 1n << 1n,
-};
-
-export type ERFunctionComponentFlag = bigint;
-
-/* eslint-disable perfectionist/sort-objects */
-export const ERFunctionComponentFlag = {
-  None: 0n,
-  Memo: 1n << 0n,
-  ForwardRef: 1n << 1n,
-  // Reserved for future use
-  // CreateElement: 1n << 2n,
-  // Reserved for future use
-  // hasHooks: 1n << 3n,
-  // Reserved for future use
-  // Async: 1n << 4n,
+  CreateElement: 1n << 1n,
+  Memo: 1n << 2n,
+  Async: 1n << 3n,
+  ForwardRef: 1n << 4n,
 };
-/* eslint-enable perfectionist/sort-objects */
diff --git a/packages/core/src/component/component-semantic-node.ts b/packages/core/src/component/component-semantic-node.ts
@@ -4,7 +4,7 @@ import type { TSESTree } from "@typescript-eslint/types";
 
 import type { ERSemanticNode } from "../semantic-node";
 import type { ERComponentHint } from "./component-collector-hint";
-import type { ERClassComponentFlag, ERFunctionComponentFlag } from "./component-flag";
+import type { ERComponentFlag } from "./component-flag";
 
 /* eslint-disable perfectionist/sort-interfaces */
 export interface ERFunctionComponent extends ERSemanticNode {
@@ -14,7 +14,7 @@ export interface ERFunctionComponent extends ERSemanticNode {
     | TSESTree.Identifier[];
   kind: "function";
   node: AST.TSESTreeFunction;
-  flag: ERFunctionComponentFlag;
+  flag: ERComponentFlag;
   hint: ERComponentHint;
   initPath:
     | _
@@ -31,7 +31,7 @@ export interface ERClassComponent extends ERSemanticNode {
     | TSESTree.Identifier;
   kind: "class";
   node: AST.TSESTreeClass;
-  flag: ERClassComponentFlag;
+  flag: ERComponentFlag;
   hint: ERComponentHint;
   methods: AST.TSESTreeMethodOrProperty[];
   displayName:
diff --git a/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts b/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts
@@ -1,4 +1,4 @@
-import { DEFAULT_COMPONENT_HINT, ERFunctionComponentFlag, useComponentCollector } from "@eslint-react/core";
+import { DEFAULT_COMPONENT_HINT, ERComponentFlag, useComponentCollector } from "@eslint-react/core";
 import type { RuleFeature } from "@eslint-react/shared";
 import type { CamelCase } from "string-ts";
 
@@ -46,9 +46,9 @@ export default createRule<[], MessageID>({
             data: {
               name,
               displayName: displayName != null ? context.sourceCode.getText(displayName) : "none",
-              forwardRef: (flag & ERFunctionComponentFlag.ForwardRef) > 0n,
+              forwardRef: (flag & ERComponentFlag.ForwardRef) > 0n,
               hookCalls: hookCalls.length,
-              memo: (flag & ERFunctionComponentFlag.Memo) > 0n,
+              memo: (flag & ERComponentFlag.Memo) > 0n,
             },
           });
         }
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
@@ -1,5 +1,5 @@
 import * as AST from "@eslint-react/ast";
-import { DEFAULT_COMPONENT_HINT, ERFunctionComponentFlag, useComponentCollector } from "@eslint-react/core";
+import { DEFAULT_COMPONENT_HINT, ERComponentFlag, useComponentCollector } from "@eslint-react/core";
 import type { RuleFeature } from "@eslint-react/shared";
 import type { CamelCase } from "string-ts";
 
@@ -46,7 +46,7 @@ export default createRule<[], MessageID>({
       "Program:exit"(node) {
         const components = ctx.getAllComponents(node);
         for (const { node, displayName, flag } of components.values()) {
-          const isMemoOrForwardRef = (flag & (ERFunctionComponentFlag.ForwardRef | ERFunctionComponentFlag.Memo)) > 0n;
+          const isMemoOrForwardRef = (flag & (ERComponentFlag.ForwardRef | ERComponentFlag.Memo)) > 0n;
           if (AST.getFunctionIdentifier(node) != null) {
             continue;
           }
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-redundant-should-component-update.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-redundant-should-component-update.ts
@@ -1,5 +1,5 @@
 import * as AST from "@eslint-react/ast";
-import { ERClassComponentFlag, useComponentCollectorLegacy } from "@eslint-react/core";
+import { ERComponentFlag, useComponentCollectorLegacy } from "@eslint-react/core";
 import type { RuleFeature } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -47,7 +47,7 @@ export default createRule<[], MessageID>({
         const components = ctx.getAllComponents(node);
 
         for (const { name = "PureComponent", node: component, flag } of components.values()) {
-          if ((flag & ERClassComponentFlag.PureComponent) === 0n) {
+          if ((flag & ERComponentFlag.PureComponent) === 0n) {
             continue;
           }
           const { body } = component.body;

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import { isChildrenOfCreateElement } from "../element";`
`11`	`11`	`import { isReactHookCall } from "../hook";`
`12`	`12`	`import { DEFAULT_COMPONENT_HINT, ERComponentHint } from "./component-collector-hint";`
`13`	`13`	`import { COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR } from "./component-display-name";`
`14`		`-import { ERFunctionComponentFlag } from "./component-flag";`
	`14`	`+import { ERComponentFlag } from "./component-flag";`
`15`	`15`	`import { getFunctionComponentIdentifier } from "./component-id";`
`16`	`16`	`import { isFunctionOfRenderMethod } from "./component-lifecycle";`
`17`	`17`	`import { getComponentNameFromIdentifier, hasNoneOrValidComponentName } from "./component-name";`
`@@ -47,12 +47,12 @@ function hasValidHierarchy(node: AST.TSESTreeFunction, context: RuleContext, hin`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`function getComponentFlag(initPath: ERFunctionComponent["initPath"]) {`
`50`		`- let flag = ERFunctionComponentFlag.None;`
	`50`	`+ let flag = ERComponentFlag.None;`
`51`	`51`	`if (initPath != null && AST.hasCallInFunctionInitPath("memo", initPath)) {`
`52`		`- flag \|= ERFunctionComponentFlag.Memo;`
	`52`	`+ flag \|= ERComponentFlag.Memo;`
`53`	`53`	`}`
`54`	`54`	`if (initPath != null && AST.hasCallInFunctionInitPath("forwardRef", initPath)) {`
`55`		`- flag \|= ERFunctionComponentFlag.ForwardRef;`
	`55`	`+ flag \|= ERComponentFlag.ForwardRef;`
`56`	`56`	`}`
`57`	`57`	`return flag;`
`58`	`58`	`}`