refactor(core): add function docs and reorganize component-related code

Author: Rel1cx

packages/core/docs/README.md

@@ -90,16 +90,20 @@
 
 ## Functions
 
+- [getComponentFlagFromInitPath](functions/getComponentFlagFromInitPath.md)
 - [getComponentNameFromId](functions/getComponentNameFromId.md)
 - [getFunctionComponentId](functions/getFunctionComponentId.md)
 - [hasNoneOrLooseComponentName](functions/hasNoneOrLooseComponentName.md)
 - [isAssignmentToThisState](functions/isAssignmentToThisState.md)
+- [isChildrenOfCreateElement](functions/isChildrenOfCreateElement.md)
 - [isClassComponent](functions/isClassComponent.md)
 - [isComponentDidCatch](functions/isComponentDidCatch.md)
 - [isComponentDidMount](functions/isComponentDidMount.md)
 - [isComponentName](functions/isComponentName.md)
 - [isComponentNameLoose](functions/isComponentNameLoose.md)
 - [isComponentWillUnmount](functions/isComponentWillUnmount.md)
+- [isComponentWrapperCall](functions/isComponentWrapperCall.md)
+- [isComponentWrapperCallLoose](functions/isComponentWrapperCallLoose.md)
 - [isDeclaredInRenderPropLoose](functions/isDeclaredInRenderPropLoose.md)
 - [isFunctionOfComponentDidMount](functions/isFunctionOfComponentDidMount.md)
 - [isFunctionOfComponentWillUnmount](functions/isFunctionOfComponentWillUnmount.md)

packages/core/docs/functions/getComponentFlagFromInitPath.md

@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / getComponentFlagFromInitPath
+
+# Function: getComponentFlagFromInitPath()
+
+> **getComponentFlagFromInitPath**(`initPath`): `bigint`
+
+## Parameters
+
+### initPath
+
+`undefined` | [`FunctionInitPath`](../-internal-/type-aliases/FunctionInitPath.md)
+
+## Returns
+
+`bigint`

packages/core/docs/functions/isChildrenOfCreateElement.md

@@ -0,0 +1,31 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isChildrenOfCreateElement
+
+# Function: isChildrenOfCreateElement()
+
+> **isChildrenOfCreateElement**(`context`, `node`): `boolean`
+
+Determines whether inside `createElement`'s children.
+
+## Parameters
+
+### context
+
+[`RuleContext`](../-internal-/type-aliases/RuleContext.md)
+
+The rule context
+
+### node
+
+[`Node`](../-internal-/type-aliases/Node.md)
+
+The AST node to check
+
+## Returns
+
+`boolean`
+
+`true` if the node is inside createElement's children

packages/core/docs/functions/isComponentWrapperCall.md

@@ -0,0 +1,31 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isComponentWrapperCall
+
+# Function: isComponentWrapperCall()
+
+> **isComponentWrapperCall**(`context`, `node`): `boolean`
+
+Check if the node is a call expression for a component wrapper
+
+## Parameters
+
+### context
+
+[`RuleContext`](../-internal-/type-aliases/RuleContext.md)
+
+The ESLint rule context
+
+### node
+
+[`Node`](../-internal-/type-aliases/Node.md)
+
+The node to check
+
+## Returns
+
+`boolean`
+
+`true` if the node is a call expression for a component wrapper

packages/core/docs/functions/isComponentWrapperCallLoose.md

@@ -0,0 +1,31 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isComponentWrapperCallLoose
+
+# Function: isComponentWrapperCallLoose()
+
+> **isComponentWrapperCallLoose**(`context`, `node`): `boolean`
+
+Check if the node is a call expression for a component wrapper loosely
+
+## Parameters
+
+### context
+
+[`RuleContext`](../-internal-/type-aliases/RuleContext.md)
+
+The ESLint rule context
+
+### node
+
+[`Node`](../-internal-/type-aliases/Node.md)
+
+The node to check
+
+## Returns
+
+`boolean`
+
+`true` if the node is a call expression for a component wrapper loosely

packages/core/docs/functions/useComponentCollectorLegacy.md

@@ -8,7 +8,7 @@
 
 > **useComponentCollectorLegacy**(): [`ReturnType`](../@eslint-react/namespaces/useComponentCollectorLegacy/type-aliases/ReturnType.md)
 
-Get a ctx and listeners for the rule to collect class components
+Get a ctx and listeners object for the rule to collect class components
 
 ## Returns
 

packages/core/docs/variables/ComponentCollectorHint.md

@@ -8,7 +8,7 @@
 
 > **ComponentCollectorHint**: `object`
 
-hints for component collector
+Hints for component collector
 
 ## Type declaration
 

packages/core/docs/variables/DEFAULT_COMPONENT_HINT.md

@@ -7,3 +7,5 @@
 # Variable: DEFAULT\_COMPONENT\_HINT
 
 > `const` **DEFAULT\_COMPONENT\_HINT**: `bigint`
+
+Default component collector hint

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

@@ -4,7 +4,7 @@ import * as JSX from "@eslint-react/jsx";
 export type ComponentCollectorHint = bigint;
 
 /**
- * hints for component collector
+ * Hints for component collector
  */
 export const ComponentCollectorHint = {
   /**
@@ -37,6 +37,9 @@ export const ComponentCollectorHint = {
   SkipClassProperty: 1n << 69n,
 } as const;
 
+/**
+ * Default component collector hint
+ */
 export const DEFAULT_COMPONENT_HINT = 0n
   | ComponentCollectorHint.SkipBooleanLiteral
   | ComponentCollectorHint.SkipEmptyArray

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

@@ -17,7 +17,7 @@ export declare namespace useComponentCollectorLegacy {
 }
 
 /**
- * Get a ctx and listeners for the rule to collect class components
+ * Get a ctx and listeners object for the rule to collect class components
  * @returns The context and listeners for the rule
  */
 export function useComponentCollectorLegacy(): useComponentCollectorLegacy.ReturnType {