Skip to content

Commit 26e672b

Browse files
committed
docs: minor improvements
1 parent 1a70cf0 commit 26e672b

22 files changed

+48
-415
lines changed

packages/core/docs/README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,24 @@
44

55
# @eslint-react/core
66

7-
## Other
7+
## Namespaces
88

99
- [isReactAPI](@eslint-react/namespaces/isReactAPI/README.md)
1010
- [isReactAPICall](@eslint-react/namespaces/isReactAPICall/README.md)
1111
- [useComponentCollector](@eslint-react/namespaces/useComponentCollector/README.md)
1212
- [useComponentCollectorLegacy](@eslint-react/namespaces/useComponentCollectorLegacy/README.md)
1313
- [useHookCollector](@eslint-react/namespaces/useHookCollector/README.md)
14+
15+
## Interfaces
16+
1417
- [ClassComponent](interfaces/ClassComponent.md)
1518
- [FunctionComponent](interfaces/FunctionComponent.md)
1619
- [Hook](interfaces/Hook.md)
1720
- [SemanticEntry](interfaces/SemanticEntry.md)
1821
- [SemanticNode](interfaces/SemanticNode.md)
22+
23+
## Type Aliases
24+
1925
- [Component](type-aliases/Component.md)
2026
- [ComponentDetectionHint](type-aliases/ComponentDetectionHint.md)
2127
- [ComponentEffectPhaseKind](type-aliases/ComponentEffectPhaseKind.md)
@@ -27,6 +33,9 @@
2733
- [EffectKind](type-aliases/EffectKind.md)
2834
- [JSXDetectionHint](type-aliases/JSXDetectionHint.md)
2935
- [TypeVariant](type-aliases/TypeVariant.md)
36+
37+
## Variables
38+
3039
- [ComponentDetectionHint](variables/ComponentDetectionHint.md)
3140
- [ComponentFlag](variables/ComponentFlag.md)
3241
- [ComponentPhaseRelevance](variables/ComponentPhaseRelevance.md)
@@ -80,6 +89,9 @@
8089
- [isUseTransitionCall](variables/isUseTransitionCall.md)
8190
- [JSXDetectionHint](variables/JSXDetectionHint.md)
8291
- [REACT\_BUILTIN\_HOOK\_NAMES](variables/REACT_BUILTIN_HOOK_NAMES.md)
92+
93+
## Functions
94+
8395
- [findParentAttribute](functions/findParentAttribute.md)
8496
- [getAttribute](functions/getAttribute.md)
8597
- [getAttributeName](functions/getAttributeName.md)
@@ -88,15 +100,11 @@
88100
- [getComponentNameFromId](functions/getComponentNameFromId.md)
89101
- [getElementType](functions/getElementType.md)
90102
- [getFunctionComponentId](functions/getFunctionComponentId.md)
91-
- [getTypeVariants](functions/getTypeVariants.md)
92103
- [hasAnyAttribute](functions/hasAnyAttribute.md)
93104
- [hasAttribute](functions/hasAttribute.md)
94105
- [hasEveryAttribute](functions/hasEveryAttribute.md)
95106
- [hasNoneOrLooseComponentName](functions/hasNoneOrLooseComponentName.md)
96-
- [isAnyType](functions/isAnyType.md)
97107
- [isAssignmentToThisState](functions/isAssignmentToThisState.md)
98-
- [isBigIntType](functions/isBigIntType.md)
99-
- [isBooleanType](functions/isBooleanType.md)
100108
- [isChildrenOfCreateElement](functions/isChildrenOfCreateElement.md)
101109
- [isClassComponent](functions/isClassComponent.md)
102110
- [isComponentDidCatch](functions/isComponentDidCatch.md)
@@ -111,10 +119,6 @@
111119
- [isComponentWrapperCall](functions/isComponentWrapperCall.md)
112120
- [isComponentWrapperCallLoose](functions/isComponentWrapperCallLoose.md)
113121
- [isDeclaredInRenderPropLoose](functions/isDeclaredInRenderPropLoose.md)
114-
- [isEnumType](functions/isEnumType.md)
115-
- [isFalsyBigIntType](functions/isFalsyBigIntType.md)
116-
- [isFalsyNumberType](functions/isFalsyNumberType.md)
117-
- [isFalsyStringType](functions/isFalsyStringType.md)
118122
- [isFragmentElement](functions/isFragmentElement.md)
119123
- [isFunctionOfRender](functions/isFunctionOfRender.md)
120124
- [isFunctionOfRenderMethod](functions/isFunctionOfRenderMethod.md)
@@ -128,10 +132,6 @@
128132
- [isInitializedFromReact](functions/isInitializedFromReact.md)
129133
- [isJsxLike](functions/isJsxLike.md)
130134
- [isJsxText](functions/isJsxText.md)
131-
- [isNeverType](functions/isNeverType.md)
132-
- [isNullishType](functions/isNullishType.md)
133-
- [isNumberType](functions/isNumberType.md)
134-
- [isObjectType](functions/isObjectType.md)
135135
- [isPureComponent](functions/isPureComponent.md)
136136
- [isReactAPI](functions/isReactAPI.md)
137137
- [isReactAPICall](functions/isReactAPICall.md)
@@ -147,12 +147,7 @@
147147
- [isRenderMethodLike](functions/isRenderMethodLike.md)
148148
- [isRenderPropLoose](functions/isRenderPropLoose.md)
149149
- [isShouldComponentUpdate](functions/isShouldComponentUpdate.md)
150-
- [isStringType](functions/isStringType.md)
151150
- [isThisSetState](functions/isThisSetState.md)
152-
- [isTruthyBigIntType](functions/isTruthyBigIntType.md)
153-
- [isTruthyNumberType](functions/isTruthyNumberType.md)
154-
- [isTruthyStringType](functions/isTruthyStringType.md)
155-
- [isUnknownType](functions/isUnknownType.md)
156151
- [isUnsafeComponentWillMount](functions/isUnsafeComponentWillMount.md)
157152
- [isUnsafeComponentWillReceiveProps](functions/isUnsafeComponentWillReceiveProps.md)
158153
- [isUnsafeComponentWillUpdate](functions/isUnsafeComponentWillUpdate.md)
@@ -162,8 +157,3 @@
162157
- [useComponentCollector](functions/useComponentCollector.md)
163158
- [useComponentCollectorLegacy](functions/useComponentCollectorLegacy.md)
164159
- [useHookCollector](functions/useHookCollector.md)
165-
166-
## Types - Type Guards
167-
168-
- [isFalseLiteralType](functions/isFalseLiteralType.md)
169-
- [isTrueLiteralType](functions/isTrueLiteralType.md)

packages/core/docs/functions/getTypeVariants.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

packages/core/docs/functions/isAnyType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isBigIntType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isBooleanType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isEnumType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isFalseLiteralType.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

packages/core/docs/functions/isFalsyBigIntType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isFalsyNumberType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/core/docs/functions/isFalsyStringType.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)