Skip to content

Commit 2421835

Browse files
committed
refactor: rename component identifier functions and update documentation
1 parent 1fe795a commit 2421835

File tree

7 files changed

+26
-26
lines changed

7 files changed

+26
-26
lines changed

packages/core/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@
9090

9191
## Functions
9292

93-
- [getComponentNameFromIdentifier](functions/getComponentNameFromIdentifier.md)
94-
- [getFunctionComponentIdentifier](functions/getFunctionComponentIdentifier.md)
93+
- [getComponentNameFromId](functions/getComponentNameFromId.md)
94+
- [getFunctionComponentId](functions/getFunctionComponentId.md)
9595
- [hasNoneOrLooseComponentName](functions/hasNoneOrLooseComponentName.md)
9696
- [isAssignmentToThisState](functions/isAssignmentToThisState.md)
9797
- [isClassComponent](functions/isClassComponent.md)

packages/core/docs/functions/getComponentNameFromIdentifier.md renamed to packages/core/docs/functions/getComponentNameFromId.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
***
44

5-
[@eslint-react/core](../README.md) / getComponentNameFromIdentifier
5+
[@eslint-react/core](../README.md) / getComponentNameFromId
66

7-
# Function: getComponentNameFromIdentifier()
7+
# Function: getComponentNameFromId()
88

9-
> **getComponentNameFromIdentifier**(`node`): `undefined` \| `string`
9+
> **getComponentNameFromId**(`id`): `undefined` \| `string`
1010
1111
## Parameters
1212

13-
### node
13+
### id
1414

1515
`undefined` | [`Identifier`](../-internal-/interfaces/Identifier.md) | [`Identifier`](../-internal-/interfaces/Identifier.md)[]
1616

packages/core/docs/functions/getFunctionComponentIdentifier.md renamed to packages/core/docs/functions/getFunctionComponentId.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
***
44

5-
[@eslint-react/core](../README.md) / getFunctionComponentIdentifier
5+
[@eslint-react/core](../README.md) / getFunctionComponentId
66

7-
# Function: getFunctionComponentIdentifier()
7+
# Function: getFunctionComponentId()
88

9-
> **getFunctionComponentIdentifier**(`context`, `node`): `undefined` \| [`Identifier`](../-internal-/interfaces/Identifier.md) \| [`Identifier`](../-internal-/interfaces/Identifier.md)[]
9+
> **getFunctionComponentId**(`context`, `node`): `undefined` \| [`Identifier`](../-internal-/interfaces/Identifier.md) \| [`Identifier`](../-internal-/interfaces/Identifier.md)[]
1010
1111
## Parameters
1212

packages/core/docs/functions/hasNoneOrLooseComponentName.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
# Function: hasNoneOrLooseComponentName()
88

9-
> **hasNoneOrLooseComponentName**(`context`, `node`): `boolean`
9+
> **hasNoneOrLooseComponentName**(`context`, `fn`): `boolean`
1010
1111
## Parameters
1212

1313
### context
1414

1515
[`RuleContext`](../-internal-/type-aliases/RuleContext.md)
1616

17-
### node
17+
### fn
1818

1919
[`TSESTreeFunction`](../-internal-/type-aliases/TSESTreeFunction.md)
2020

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ import { DISPLAY_NAME_ASSIGNMENT_SELECTOR } from "../constants";
1414
import { isReactHookCall } from "../hook";
1515
import { DEFAULT_COMPONENT_HINT } from "./component-collector-hint";
1616
import { ERComponentFlag } from "./component-flag";
17-
import { getFunctionComponentIdentifier } from "./component-id";
18-
import { getComponentNameFromIdentifier, hasNoneOrLooseComponentName } from "./component-name";
17+
import { getFunctionComponentId } from "./component-id";
18+
import { getComponentNameFromId, hasNoneOrLooseComponentName } from "./component-name";
1919
import { hasValidHierarchy } from "./hierarchy";
2020

2121
type FunctionEntry = {
@@ -107,8 +107,8 @@ export function useComponentCollector(
107107
&& hasValidHierarchy(context, entry.node, hint);
108108
if (!isComponent) return;
109109
const initPath = AST.getFunctionInitPath(entry.node);
110-
const id = getFunctionComponentIdentifier(context, entry.node);
111-
const name = getComponentNameFromIdentifier(id);
110+
const id = getFunctionComponentId(context, entry.node);
111+
const name = getComponentNameFromId(id);
112112
const key = getId();
113113
components.set(key, {
114114
id,
@@ -157,8 +157,8 @@ export function useComponentCollector(
157157
if (!isComponent) return;
158158
entry.isComponent = true;
159159
const initPath = AST.getFunctionInitPath(entry.node);
160-
const id = getFunctionComponentIdentifier(context, entry.node);
161-
const name = getComponentNameFromIdentifier(id);
160+
const id = getFunctionComponentId(context, entry.node);
161+
const name = getComponentNameFromId(id);
162162
components.set(entry.key, {
163163
id,
164164
key: entry.key,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function isComponentWrapperCall(
1919
|| isReactHookCallWithNameLoose(node)("useCallback");
2020
}
2121

22-
export function getFunctionComponentIdentifier(
22+
export function getFunctionComponentId(
2323
context: RuleContext,
2424
node: AST.TSESTreeFunction,
2525
): TSESTree.Identifier | TSESTree.Identifier[] | _ {

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { RuleContext } from "@eslint-react/kit";
33
import type { TSESTree } from "@typescript-eslint/types";
44
import { _ } from "@eslint-react/eff";
55

6-
import { getFunctionComponentIdentifier } from "./component-id";
6+
import { getFunctionComponentId } from "./component-id";
77

88
export const RE_COMPONENT_NAME = /^[A-Z]/u;
99

@@ -17,15 +17,15 @@ export function isComponentNameLoose(name: string) {
1717
return RE_COMPONENT_NAME_LOOSE.test(name);
1818
}
1919

20-
export function getComponentNameFromIdentifier(node: TSESTree.Identifier | TSESTree.Identifier[] | _) {
21-
if (node == null) return _;
22-
return Array.isArray(node)
23-
? node.map((n) => n.name).join(".")
24-
: node.name;
20+
export function getComponentNameFromId(id: TSESTree.Identifier | TSESTree.Identifier[] | _) {
21+
if (id == null) return _;
22+
return Array.isArray(id)
23+
? id.map((n) => n.name).join(".")
24+
: id.name;
2525
}
2626

27-
export function hasNoneOrLooseComponentName(context: RuleContext, node: AST.TSESTreeFunction) {
28-
const id = getFunctionComponentIdentifier(context, node);
27+
export function hasNoneOrLooseComponentName(context: RuleContext, fn: AST.TSESTreeFunction) {
28+
const id = getFunctionComponentId(context, fn);
2929
if (id == null) return true;
3030
const name = Array.isArray(id)
3131
? id.at(-1)?.name

0 commit comments

Comments
 (0)