Skip to content

Commit

Permalink
refactor: component api docs generation (#7216)
Browse files Browse the repository at this point in the history
  • Loading branch information
segunadebayo committed Jan 11, 2023
1 parent efc2ce9 commit 08e3ffc
Show file tree
Hide file tree
Showing 110 changed files with 1,060 additions and 495 deletions.
5 changes: 5 additions & 0 deletions .changeset/lazy-impalas-shop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@chakra-ui/props-docs": minor
---

[BREAKING] Refactor props docs and improved its output structure
5 changes: 5 additions & 0 deletions .changeset/witty-seas-explain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@chakra-ui/icons": patch
---

Fix export for `ReactIcon`
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"build:tokens": "chakra-cli tokens packages/components/theme/src --out packages/core/styled-system/dist/theming.types.d.ts",
"build": "turbo run build --filter=!./examples/* --filter=!*props-docs",
"build:fast": "turbo run build:fast --filter=!./examples/* --filter=!*props-docs",
"build:prop-docs": "pnpm --filter=*props-docs build",
"build:prop-docs": "pnpm typedocs && pnpm --filter=*props-docs build",
"typedocs": "pnpm --filter=./packages/components/** typedocs",
"postbuild": "pnpm build:tokens",
"dev": "turbo run dev --filter=!./examples/*",
"typecheck": "tsc --noEmit",
Expand Down Expand Up @@ -55,6 +56,7 @@
"@chakra-ui/cli": "workspace:*",
"@chakra-ui/storybook-addon": "workspace:*",
"@chakra-ui/test-utils": "workspace:*",
"@chakra-ui/theme": "workspace:*",
"@changesets/changelog-github": "0.4.6",
"@changesets/cli": "2.24.1",
"@changesets/get-release-plan": "3.0.12",
Expand All @@ -74,6 +76,7 @@
"@swc/core": "^1.2.177",
"@testing-library/jest-dom": "^5.16.4",
"@types/edit-json-file": "^1.6.1",
"@types/fs-extra": "11.0.1",
"@types/jest": "^28.1.1",
"@types/mkdirp": "1.0.2",
"@types/node": "^18.0.0",
Expand All @@ -94,6 +97,7 @@
"eslint-plugin-react": "7.30.1",
"eslint-plugin-react-hooks": "4.6.0",
"eslint-plugin-testing-library": "5.5.1",
"fs-extra": "11.1.0",
"find-packages": "9.0.6",
"find-up": "^6.3.0",
"husky": "^7.0.4",
Expand Down
3 changes: 2 additions & 1 deletion packages/components/accordion/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
"clean": "rimraf dist .turbo",
"typecheck": "tsc --noEmit",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
18 changes: 11 additions & 7 deletions packages/components/accordion/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
export { AccordionButton, type AccordionButtonProps } from "./accordion-button"
export { Accordion } from "./accordion"
export type { AccordionProps } from "./accordion"
export { AccordionButton } from "./accordion-button"
export type { AccordionButtonProps } from "./accordion-button"
export { useAccordionStyles } from "./accordion-context"
export { AccordionIcon } from "./accordion-icon"
export { AccordionItem, type AccordionItemProps } from "./accordion-item"
export { AccordionPanel, type AccordionPanelProps } from "./accordion-panel"
export { Accordion, type AccordionProps } from "./accordion"
export { AccordionItem } from "./accordion-item"
export type { AccordionItemProps } from "./accordion-item"
export { AccordionPanel } from "./accordion-panel"
export type { AccordionPanelProps } from "./accordion-panel"
export {
AccordionProvider,
useAccordionItem,
useAccordionContext,
useAccordion,
useAccordionContext,
useAccordionItem,
} from "./use-accordion"
export type {
UseAccordionItemProps,
UseAccordionProps,
UseAccordionItemReturn,
UseAccordionProps,
UseAccordionReturn,
} from "./use-accordion"
export { useAccordionItemState } from "./use-accordion-item-state"
3 changes: 2 additions & 1 deletion packages/components/alert/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
"clean": "rimraf dist .turbo",
"typecheck": "tsc --noEmit",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
18 changes: 10 additions & 8 deletions packages/components/alert/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
export { Alert, type AlertProps } from "./alert"
export { useAlertStyles, type AlertStatus } from "./alert-context"
export {
AlertDescription,
type AlertDescriptionProps,
} from "./alert-description"
export { AlertIcon, type AlertIconProps } from "./alert-icon"
export { AlertTitle, type AlertTitleProps } from "./alert-title"
export { Alert } from "./alert"
export type { AlertProps } from "./alert"
export { useAlertStyles } from "./alert-context"
export type { AlertStatus } from "./alert-context"
export { AlertDescription } from "./alert-description"
export type { AlertDescriptionProps } from "./alert-description"
export { AlertIcon } from "./alert-icon"
export type { AlertIconProps } from "./alert-icon"
export { AlertTitle } from "./alert-title"
export type { AlertTitleProps } from "./alert-title"
3 changes: 2 additions & 1 deletion packages/components/avatar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
9 changes: 6 additions & 3 deletions packages/components/avatar/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
export { Avatar, type AvatarProps } from "./avatar"
export { AvatarGroup, type AvatarGroupProps } from "./avatar-group"
export { AvatarBadge, type AvatarBadgeProps } from "./avatar-badge"
export { Avatar } from "./avatar"
export type { AvatarProps } from "./avatar"
export { AvatarBadge } from "./avatar-badge"
export type { AvatarBadgeProps } from "./avatar-badge"
export { useAvatarStyles } from "./avatar-context"
export { AvatarGroup } from "./avatar-group"
export type { AvatarGroupProps } from "./avatar-group"
export { GenericAvatarIcon } from "./generic-avatar-icon"
3 changes: 2 additions & 1 deletion packages/components/breadcrumb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
11 changes: 7 additions & 4 deletions packages/components/breadcrumb/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
export { Breadcrumb, type BreadcrumbProps } from "./breadcrumb"
export { BreadcrumbItem, type BreadcrumbItemProps } from "./breadcrumb-item"
export { Breadcrumb } from "./breadcrumb"
export type { BreadcrumbProps } from "./breadcrumb"
export { useBreadcrumbStyles } from "./breadcrumb-context"
export { BreadcrumbItem } from "./breadcrumb-item"
export type { BreadcrumbItemProps } from "./breadcrumb-item"
export { BreadcrumbLink } from "./breadcrumb-link"
export type { BreadcrumbLinkProps } from "./breadcrumb-link"
export {
BreadcrumbSeparator,
type BreadcrumbSeparatorProps,
} from "./breadcrumb-separator"
export { BreadcrumbLink, type BreadcrumbLinkProps } from "./breadcrumb-link"
export { useBreadcrumbStyles } from "./breadcrumb-context"
export type { BreadcrumbOptions } from "./breadcrumb-types"
3 changes: 2 additions & 1 deletion packages/components/button/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
9 changes: 6 additions & 3 deletions packages/components/button/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
export { Button, type ButtonProps } from "./button"
export { ButtonGroup, type ButtonGroupProps } from "./button-group"
export { IconButton, type IconButtonProps } from "./icon-button"
export { Button } from "./button"
export type { ButtonProps } from "./button"
export { ButtonGroup } from "./button-group"
export type { ButtonGroupProps } from "./button-group"
export { IconButton } from "./icon-button"
export type { IconButtonProps } from "./icon-button"
export { ButtonSpinner } from "./button-spinner"
export { useButtonGroup } from "./button-context"
export type { ButtonOptions } from "./button-types"
3 changes: 2 additions & 1 deletion packages/components/card/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"devDependencies": {
"@chakra-ui/system": "workspace:*",
Expand Down
4 changes: 0 additions & 4 deletions packages/components/card/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
export { Card } from "./card"
export type { CardProps } from "./card"

export { CardBody } from "./card-body"
export type { CardBodyProps } from "./card-body"

export { useCardStyles } from "./card-context"

export { CardFooter } from "./card-footer"
export type { CardFooterProps } from "./card-footer"

export { CardHeader } from "./card-header"
export type { CardHeaderProps } from "./card-header"
3 changes: 2 additions & 1 deletion packages/components/checkbox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
22 changes: 12 additions & 10 deletions packages/components/checkbox/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
export { CheckboxGroup, type CheckboxGroupProps } from "./checkbox-group"
export { CheckboxIcon, type CheckboxIconProps } from "./checkbox-icon"
export { Checkbox } from "./checkbox"
export type { CheckboxProps } from "./checkbox"
export { CheckboxGroup } from "./checkbox-group"
export type { CheckboxGroupProps } from "./checkbox-group"
export { CheckboxIcon } from "./checkbox-icon"
export type { CheckboxIconProps } from "./checkbox-icon"
export type {
UseCheckboxGroupProps,
UseCheckboxProps,
CheckboxGroupContext,
CheckboxState,
UseCheckboxGroupProps,
UseCheckboxProps,
} from "./checkbox-types"
export { Checkbox, type CheckboxProps } from "./checkbox"
export {
useCheckboxGroup,
type UseCheckboxGroupReturn,
} from "./use-checkbox-group"
export { useCheckbox, type UseCheckboxReturn } from "./use-checkbox"
export { useCheckbox } from "./use-checkbox"
export type { UseCheckboxReturn } from "./use-checkbox"
export { useCheckboxGroup } from "./use-checkbox-group"
export type { UseCheckboxGroupReturn } from "./use-checkbox-group"
3 changes: 2 additions & 1 deletion packages/components/clickable/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
3 changes: 2 additions & 1 deletion packages/components/clickable/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from "./use-clickable"
export { useClickable } from "./use-clickable"
export type { UseClickableProps, UseClickableReturn } from "./use-clickable"
3 changes: 2 additions & 1 deletion packages/components/close-button/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
3 changes: 2 additions & 1 deletion packages/components/close-button/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from "./close-button"
export { CloseButton } from "./close-button"
export type { CloseButtonProps } from "./close-button"
3 changes: 2 additions & 1 deletion packages/components/color-mode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"publishConfig": {
"access": "public"
Expand Down
11 changes: 4 additions & 7 deletions packages/components/color-mode/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
export {
ColorModeProvider,
DarkMode,
LightMode,
type ColorModeProviderProps,
} from "./color-mode-provider"
export { ColorModeProvider, DarkMode, LightMode } from "./color-mode-provider"
export type { ColorModeProviderProps } from "./color-mode-provider"
export {
cookieStorageManager,
cookieStorageManagerSSR,
createCookieStorageManager,
localStorageManager,
createLocalStorageManager,
} from "./storage-manager"
export { ColorModeScript, type ColorModeScriptProps } from "./color-mode-script"
export { ColorModeScript } from "./color-mode-script"
export type { ColorModeScriptProps } from "./color-mode-script"
export {
useColorMode,
useColorModeValue,
Expand Down
3 changes: 2 additions & 1 deletion packages/components/control-box/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
3 changes: 2 additions & 1 deletion packages/components/control-box/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from "./control-box"
export { ControlBox } from "./control-box"
export type { ControlBoxOptions, ControlBoxProps } from "./control-box"
3 changes: 2 additions & 1 deletion packages/components/counter/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
3 changes: 2 additions & 1 deletion packages/components/counter/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from "./use-counter"
export { useCounter } from "./use-counter"
export type { UseCounterProps, UseCounterReturn } from "./use-counter"
3 changes: 2 additions & 1 deletion packages/components/editable/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
24 changes: 11 additions & 13 deletions packages/components/editable/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
export { Editable, type EditableProps } from "./editable"
export { EditableInput, type EditableInputProps } from "./editable-input"
export {
EditableTextarea,
type EditableTextareaProps,
} from "./editable-textarea"
export { EditablePreview, type EditablePreviewProps } from "./editable-preview"
export {
useEditable,
type UseEditableProps,
type UseEditableReturn,
} from "./use-editable"
export { Editable } from "./editable"
export type { EditableProps } from "./editable"
export { useEditableStyles } from "./editable-context"
export { EditableInput } from "./editable-input"
export type { EditableInputProps } from "./editable-input"
export { EditablePreview } from "./editable-preview"
export type { EditablePreviewProps } from "./editable-preview"
export { EditableTextarea } from "./editable-textarea"
export type { EditableTextareaProps } from "./editable-textarea"
export { useEditable } from "./use-editable"
export type { UseEditableProps, UseEditableReturn } from "./use-editable"
export { useEditableControls } from "./use-editable-controls"
export { useEditableState } from "./use-editable-state"
export { useEditableStyles } from "./editable-context"
3 changes: 2 additions & 1 deletion packages/components/env/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
3 changes: 2 additions & 1 deletion packages/components/env/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from "./env"
export { EnvironmentProvider, useEnvironment } from "./env"
export type { EnvironmentProviderProps } from "./env"
3 changes: 2 additions & 1 deletion packages/components/focus-lock/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"typecheck": "tsc --noEmit",
"build:fast": "tsup src",
"prepack": "clean-package",
"postpack": "clean-package restore"
"postpack": "clean-package restore",
"typedocs": "tsx ../../../scripts/generate-type-docs.ts"
},
"clean-package": "../../../clean-package.config.json",
"tsup": {
Expand Down
Loading

1 comment on commit 08e3ffc

@vercel
Copy link

@vercel vercel bot commented on 08e3ffc Jan 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.