refactor: code optimizations

Author: Rel1cx

.github/CONTRIBUTING.md

@@ -60,8 +60,9 @@ ESLint React does not accept contributions of a purely utilitarian nature.
 - `@eslint-react/types`: Type definitions.
 - `@eslint-react/shared`: Shared constants and functions.
 - `@eslint-react/ast`: TSESTree AST primitive utility module.
+- `@eslint-react/var`: TSESTree AST utility module for static analysis of variables.
 - `@eslint-react/jsx`: TSESTree AST utility module for static analysis of JSX.
-- `@eslint-react/core`: ESLint utility module for static analysis of React core API and Patterns.
+- `@eslint-react/core`: ESLint utility module for static analysis of React core APIs and Patterns.
 - `@eslint-react/eslint-plugin-jsx`: ESLint plugin for JSX related rules.
 - `@eslint-react/eslint-plugin-react`: ESLint plugin for React related rules.
 - `@eslint-react/eslint-plugin-react-hooks`: ESLint plugin for React Hooks related rules.

VERSION

@@ -1 +1 @@
-0.10.5
+0.10.6-beta.0

package.json

@@ -1,11 +1,12 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "0.10.5",
+  "version": "0.10.6-beta.0",
   "description": "ESLint React's monorepo. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",
   "keywords": [
     "eslint",
     "eslint-plugin",
     "eslint-react",
+    "eslint-plugin-react",
     "react",
     "ts",
     "tsx",

packages/core/docs/README.md

@@ -15,25 +15,22 @@
 
 - [ERClassComponentFlag](README.md#erclasscomponentflag)
 - [ERComponent](README.md#ercomponent)
-- [ERComponentCollectorHint](README.md#ercomponentcollectorhint)
+- [ERComponentHint](README.md#ercomponenthint)
 - [ERComponentInitPath](README.md#ercomponentinitpath)
 - [ERComponentKind](README.md#ercomponentkind)
-- [ERConstruction](README.md#erconstruction)
 - [ERFunctionComponentFlag](README.md#erfunctioncomponentflag)
 
 ### Variables
 
-- [DEFAULT\_COMPONENT\_COLLECTOR\_HINT](README.md#default_component_collector_hint)
+- [DEFAULT\_COMPONENT\_HINT](README.md#default_component_hint)
 - [ERClassComponentFlag](README.md#erclasscomponentflag-1)
-- [ERComponentCollectorHint](README.md#ercomponentcollectorhint-1)
-- [ERConstruction](README.md#erconstruction-1)
+- [ERComponentHint](README.md#ercomponenthint-1)
 - [ERFunctionComponentFlag](README.md#erfunctioncomponentflag-1)
 - [RE\_COMPONENT\_NAME](README.md#re_component_name)
 - [RE\_HOOK\_NAME](README.md#re_hook_name)
 
 ### Functions
 
-- [constructionDetector](README.md#constructiondetector)
 - [getComponentInitPath](README.md#getcomponentinitpath)
 - [getComponentNameFromIdentifier](README.md#getcomponentnamefromidentifier)
 - [getFunctionComponentIdentifier](README.md#getfunctioncomponentidentifier)
@@ -76,7 +73,6 @@
 - [isReactHookCallWithName](README.md#isreacthookcallwithname)
 - [isReactHookCallWithNameLoose](README.md#isreacthookcallwithnameloose)
 - [isReactHookName](README.md#isreacthookname)
-- [isUnstableAssignmentPattern](README.md#isunstableassignmentpattern)
 - [isUseCallbackCall](README.md#isusecallbackcall)
 - [isUseContextCall](README.md#isusecontextcall)
 - [isUseDebugValueCall](README.md#isusedebugvaluecall)
@@ -113,9 +109,9 @@ ___
 
 ___
 
-### ERComponentCollectorHint
+### ERComponentHint
 
-Ƭ **ERComponentCollectorHint**: `bigint`
+Ƭ **ERComponentHint**: `bigint`
 
 ___
 
@@ -131,21 +127,15 @@ ___
 
 ___
 
-### ERConstruction
-
-Ƭ **ERConstruction**: `Data.TaggedEnum`\<\{ `Array`: \{ `node`: `TSESTree.ArrayExpression` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `AssignmentExpression`: \{ `node`: `TSESTree.Node` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `ClassExpression`: \{ `node`: `TSESTree.ClassExpression` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `FunctionDeclaration`: \{ `node`: `TSESTree.FunctionDeclaration` ; `usage`: `O.Option`\<`TSESTree.Expression` \| `TSESTree.Identifier`\>  } ; `FunctionExpression`: \{ `node`: `TSESTree.ArrowFunctionExpression` \| `TSESTree.FunctionExpression` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `JSXElement`: \{ `node`: `TSESTree.JSXElement` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `JSXFragment`: \{ `node`: `TSESTree.JSXFragment` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `NewExpression`: \{ `node`: `TSESTree.NewExpression` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `None`: {} ; `ObjectExpression`: \{ `node`: `TSESTree.ObjectExpression` ; `usage`: `O.Option`\<`TSESTree.Node`\>  } ; `RegExpLiteral`: \{ `node`: `TSESTree.Literal` ; `usage`: `O.Option`\<`TSESTree.Node`\>  }  }\>
-
-___
-
 ### ERFunctionComponentFlag
 
 Ƭ **ERFunctionComponentFlag**: `bigint`
 
 ## Variables
 
-### DEFAULT\_COMPONENT\_COLLECTOR\_HINT
+### DEFAULT\_COMPONENT\_HINT
 
-• `Const` **DEFAULT\_COMPONENT\_COLLECTOR\_HINT**: `bigint`
+• `Const` **DEFAULT\_COMPONENT\_HINT**: `bigint`
 
 ___
 
@@ -162,9 +152,9 @@ ___
 
 ___
 
-### ERComponentCollectorHint
+### ERComponentHint
 
-• **ERComponentCollectorHint**: `Object`
+• **ERComponentHint**: `Object`
 
 hints for component collector
 
@@ -191,28 +181,6 @@ hints for component collector
 
 ___
 
-### ERConstruction
-
-• **ERConstruction**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `Array` | `Constructor`\<`Data`\<\{ `_tag`: ``"Array"`` ; `node`: `ArrayExpression` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `AssignmentExpression` | `Constructor`\<`Data`\<\{ `_tag`: ``"AssignmentExpression"`` ; `node`: `Node` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `ClassExpression` | `Constructor`\<`Data`\<\{ `_tag`: ``"ClassExpression"`` ; `node`: `ClassExpression` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `FunctionDeclaration` | `Constructor`\<`Data`\<\{ `_tag`: ``"FunctionDeclaration"`` ; `node`: `FunctionDeclaration` ; `usage`: `Option`\<`Expression`\>  }\>, ``"_tag"``\> |
-| `FunctionExpression` | `Constructor`\<`Data`\<\{ `_tag`: ``"FunctionExpression"`` ; `node`: `ArrowFunctionExpression` \| `FunctionExpression` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `JSXElement` | `Constructor`\<`Data`\<\{ `_tag`: ``"JSXElement"`` ; `node`: `JSXElement` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `JSXFragment` | `Constructor`\<`Data`\<\{ `_tag`: ``"JSXFragment"`` ; `node`: `JSXFragment` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `NewExpression` | `Constructor`\<`Data`\<\{ `_tag`: ``"NewExpression"`` ; `node`: `NewExpression` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `None` | `Constructor`\<`Data`\<\{ `_tag`: ``"None"``  }\>, ``"_tag"``\> |
-| `ObjectExpression` | `Constructor`\<`Data`\<\{ `_tag`: ``"ObjectExpression"`` ; `node`: `ObjectExpression` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-| `RegExpLiteral` | `Constructor`\<`Data`\<\{ `_tag`: ``"RegExpLiteral"`` ; `node`: `Literal` ; `usage`: `Option`\<`Node`\>  }\>, ``"_tag"``\> |
-
-___
-
 ### ERFunctionComponentFlag
 
 • **ERFunctionComponentFlag**: `Object`
@@ -239,44 +207,6 @@ ___
 
 ## Functions
 
-### constructionDetector
-
-▸ **constructionDetector**\<`T`\>(`context`): (`node`: `TSESTree.Node`) => [`ERConstruction`](README.md#erconstruction)
-
-Get a function that detects the construction of a given node.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends `Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\> |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `context` | `T` | The rule context |
-
-#### Returns
-
-`fn`
-
-A function that detects the construction of a given node
-
-▸ (`node`): [`ERConstruction`](README.md#erconstruction)
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | `TSESTree.Node` |
-
-##### Returns
-
-[`ERConstruction`](README.md#erconstruction)
-
-___
-
 ### getComponentInitPath
 
 ▸ **getComponentInitPath**(`node`): `O.Option`\<[`ERComponentInitPath`](README.md#ercomponentinitpath)\>
@@ -1084,24 +1014,6 @@ ___
 
 ___
 
-### isUnstableAssignmentPattern
-
-▸ **isUnstableAssignmentPattern**(`node`): node is AssignmentPattern & Object
-
-Check if the given node is an unstable assignment pattern (will change between assignments)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `node` | `AssignmentPattern` | The AST node to check |
-
-#### Returns
-
-node is AssignmentPattern & Object
-
-___
-
 ### isUseCallbackCall
 
 ▸ **isUseCallbackCall**(`node`, `context`, `pragma`): `boolean`
@@ -1459,7 +1371,7 @@ ___
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `context` | `Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\> | `undefined` |
-| `hint` | `bigint` | `DEFAULT_COMPONENT_COLLECTOR_HINT` |
+| `hint` | `bigint` | `DEFAULT_COMPONENT_HINT` |
 | `pragma` | `string` | `undefined` |
 
 #### Returns

packages/core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eslint-react/core",
-  "version": "0.10.5",
-  "description": "ESLint React's ESLint utility module for static analysis of React core API and Patterns.",
+  "version": "0.10.6-beta.0",
+  "description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
     "url": "https://github.com/rel1cx/eslint-react/issues"

packages/core/src/component/component-collector-hint.ts

@@ -1,14 +1,14 @@
-import { JSXValueCheckHint } from "@eslint-react/jsx";
+import { JSXValueHint } from "@eslint-react/jsx";
 
-export type ERComponentCollectorHint = bigint;
+export type ERComponentHint = bigint;
 
 /* eslint-disable perfectionist/sort-objects */
 /**
  * hints for component collector
  */
-export const ERComponentCollectorHint = {
-  ...JSXValueCheckHint,
-  // 1n << 0n - 1n << 63n are reserved for JSXValueCheckHint
+export const ERComponentHint = {
+  ...JSXValueHint,
+  // 1n << 0n - 1n << 63n are reserved for JSXValueHint
   // Skip function component created by React.memo
   SkipMemo: 1n << 64n,
   // Skip function component created by React.forwardRef
@@ -24,8 +24,8 @@ export const ERComponentCollectorHint = {
 } as const;
 /* eslint-enable perfectionist/sort-objects */
 
-export const DEFAULT_COMPONENT_COLLECTOR_HINT = 0n
-  | ERComponentCollectorHint.SkipUndefinedLiteral
-  | ERComponentCollectorHint.SkipBooleanLiteral
-  | ERComponentCollectorHint.SkipStringLiteral
-  | ERComponentCollectorHint.SkipNumberLiteral;
+export const DEFAULT_COMPONENT_HINT = 0n
+  | ERComponentHint.SkipUndefinedLiteral
+  | ERComponentHint.SkipBooleanLiteral
+  | ERComponentHint.SkipStringLiteral
+  | ERComponentHint.SkipNumberLiteral;

packages/core/src/component/component-collector.ts

@@ -18,7 +18,7 @@ import { isMatching, match } from "ts-pattern";
 
 import { isReactHookCall } from "../hook";
 import type { ERFunctionComponent } from "./component";
-import { DEFAULT_COMPONENT_COLLECTOR_HINT, ERComponentCollectorHint } from "./component-collector-hint";
+import { DEFAULT_COMPONENT_HINT, ERComponentHint } from "./component-collector-hint";
 import { ERFunctionComponentFlag } from "./component-flag";
 import { getFunctionComponentIdentifier } from "./component-identifier";
 import { getComponentInitPath, hasCallInInitPath } from "./component-init-path";
@@ -41,19 +41,19 @@ function hasValidHierarchy(node: TSESTreeFunction, context: RuleContext, hint: b
     return false;
   }
 
-  if (hint & ERComponentCollectorHint.SkipMapCallback && isMapCall(node.parent)) {
+  if (hint & ERComponentHint.SkipMapCallback && isMapCall(node.parent)) {
     return false;
   }
 
-  if (hint & ERComponentCollectorHint.SkipObjectMethod && isFunctionOfObjectMethod(node.parent)) {
+  if (hint & ERComponentHint.SkipObjectMethod && isFunctionOfObjectMethod(node.parent)) {
     return false;
   }
 
-  if (hint & ERComponentCollectorHint.SkipClassMethod && isFunctionOfClassMethod(node.parent)) {
+  if (hint & ERComponentHint.SkipClassMethod && isFunctionOfClassMethod(node.parent)) {
     return false;
   }
 
-  if (hint & ERComponentCollectorHint.SkipClassProperty && isFunctionOfClassProperty(node.parent)) {
+  if (hint & ERComponentHint.SkipClassProperty && isFunctionOfClassProperty(node.parent)) {
     return false;
   }
 
@@ -88,7 +88,7 @@ function getComponentFlag(initPath: ERFunctionComponent["initPath"], pragma: str
 
 export function useComponentCollector(
   context: RuleContext,
-  hint: bigint = DEFAULT_COMPONENT_COLLECTOR_HINT,
+  hint: bigint = DEFAULT_COMPONENT_HINT,
   pragma = getPragmaFromContext(context),
 ) {
   const components = new Map<string, ERFunctionComponent>();

packages/core/src/component/component.ts

@@ -3,7 +3,7 @@ import type { O } from "@eslint-react/tools";
 import type { TSESTree } from "@typescript-eslint/types";
 
 import type { ERAnalyzerNode } from "../internal";
-import type { ERComponentCollectorHint } from "./component-collector-hint";
+import type { ERComponentHint } from "./component-collector-hint";
 import type { ERClassComponentFlag, ERFunctionComponentFlag } from "./component-flag";
 import type { ERComponentInitPath } from "./component-init-path";
 
@@ -13,7 +13,7 @@ export interface ERFunctionComponent extends ERAnalyzerNode {
   kind: "function";
   node: TSESTreeFunction;
   flag: ERFunctionComponentFlag;
-  hint: ERComponentCollectorHint;
+  hint: ERComponentHint;
   initPath: O.Option<ERComponentInitPath>;
   hookCalls: TSESTree.CallExpression[];
   displayName: O.Option<TSESTree.Expression>;
@@ -24,7 +24,7 @@ export interface ERClassComponent extends ERAnalyzerNode {
   kind: "class";
   node: TSESTreeClass;
   flag: ERClassComponentFlag;
-  hint: ERComponentCollectorHint;
+  hint: ERComponentHint;
   methods: (TSESTree.MethodDefinition | TSESTree.PropertyDefinition)[];
   displayName: O.Option<TSESTree.Expression>;
 }