chore(spindle-ui,spindle-hooks): optimize Storybook for AI#1975
chore(spindle-ui,spindle-hooks): optimize Storybook for AI#1975
Conversation
|
|
Visit the preview URL for this PR (updated for commit ce8a94e): https://ameba-spindle-hooks--pr1975-chore-optimize-story-mjkyke6l.web.app (expires Fri, 24 Apr 2026 10:17:50 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 7dd86a3c25a55dbb81dd4fa259473bf50648140b |
|
Visit the preview URL for this PR (updated for commit ce8a94e): https://ameba-spindle--pr1975-chore-optimize-story-omeiuujx.web.app (expires Fri, 24 Apr 2026 10:18:18 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: e7521619a2dd5c653490c8246e81ec2a5c8f1435 |
- reactDocgenをreact-docgen-typescriptに変更し、プロップ情報をマニフェストに反映 - 全MDXファイルのMetaタグにsummaryを追加し、AIエージェントへのコンテキスト提供を強化 - 全ストーリーのmetaにcomponentを追加し、プロップ抽出を有効化
1cd1262 to
ce8a94e
Compare
There was a problem hiding this comment.
Pull request overview
Storybook AI Best Practices に沿って、Storybook(addon-mcp 経由)から取得できるコンポーネント/ドキュメントのメタ情報(Props 抽出・summary)を増やし、AI エージェント向けコンテキストを充実させるPRです。
Changes:
- Storybook の TypeScript docgen を
react-docgen-typescriptに切り替え - 各コンポーネントの MDX
<Meta>にsummaryを追加 - 各 story の meta に
componentを追加して Props 抽出を有効化
Reviewed changes
Copilot reviewed 64 out of 64 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/spindle-ui/.storybook/main.js | reactDocgen を react-docgen-typescript に変更 |
| packages/spindle-ui/storybook/UserNotificationTypes.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Toast/Toast.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Toast/Toast.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/TextLink/TextLink.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/TextButton/TextButton.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Table/Table.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Table/Table.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/SubtleButton/SubtleButton.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/StackNotificationManager/StackNotificationManager.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/StackNotificationManager/StackNotificationManager.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/SnackBar/SnackBar.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/SnackBar/SnackBar.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/SegmentedControl/SegmentedControl.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Rating/Rating.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Pagination/Pagination.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Pagination/Pagination.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/NavigationTab/UnderlineTab/UnderlineTab.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/NavigationTab/UnderlineTab/UnderlineTab.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Modal/SemiModal/SemiModal.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Modal/SemiModal/SemiModal.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Modal/AppealModal/AppealModal.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Modal/AppealModal/AppealModal.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/List/MoreLink.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/List/MoreLink.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/LinkButton/LinkButton.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/LinkButton/LinkButton.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/InlineNotification/InlineNotification.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/InlineNotification/InlineNotification.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/IconButton/IconButton.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/IconButton/IconButton.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Icon/index.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Icon/index.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/HeroCarousel/HeroCarousel.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/HeroCarousel/HeroCarousel.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/ToggleSwitch/ToggleSwitch.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/TextField/TextField.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Form/TextField/TextField.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/TextArea/TextArea.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Form/TextArea/TextArea.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/Radio/Radio.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/InvalidMessage/InvalidMessage.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/InputLabel/InputLabel.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/InlineDropDown/InlineDropDown.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Form/InlineDropDown/InlineDropDown.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/DropDown/DropDown.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Form/DropDown/DropDown.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/Checkbox/Checkbox.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Form/ButtonSwitch/ButtonSwitch.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/DropdownMenu/DropdownMenu.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/DropdownMenu/DropdownMenu.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Dialog/Dialog.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Dialog/Dialog.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/ButtonGroup/ButtonGroup.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/ButtonGroup/ButtonGroup.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Button/Button.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Button/Button.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/Breadcrumb/Breadcrumb.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/Breadcrumb/Breadcrumb.mdx | <Meta> に summary を追加 |
| packages/spindle-ui/src/BottomButton/BottomButton.stories.tsx | story meta に component を追加 |
| packages/spindle-ui/src/BottomButton/BottomButton.mdx | <Meta> に summary を追加 |
| packages/spindle-hooks/.storybook/main.js | reactDocgen を react-docgen-typescript に変更 |
| packages/spindle-hooks/src/useTimeDistance/useTimeDistance.mdx | <Meta> に summary を追加 |
| packages/spindle-hooks/src/useCarousel/useCarousel.mdx | <Meta> に summary を追加 |
|
reg-suit detected visual differences. Check this report, and review them.
How can I change the check status?If reviewers approve this PR, the reg context status will be green automatically. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ce8a94eb2d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| const meta: Meta<typeof SemiModal.Frame> = { | ||
| title: 'Modal/SemiModal', | ||
| component: SemiModal.Frame, |
There was a problem hiding this comment.
copilotの指摘にもあるように react-docgen-typescript に変更したことによってコンポーネントを解決できずPropsが取得されないケースあるんですかね?
概要
Storybook AI Best Practices に基づき、AIエージェント(addon-mcp経由)へのコンテキスト提供を最適化しました。
reactDocgenをreact-docgen-typescriptに変更し、プロップ情報をマニフェストに反映<Meta>タグにsummaryを追加componentを追加し、プロップ抽出を有効化確認方法
pnpm install && pnpm --filter spindle-ui storybook:start今回未対応の項目(別PRで対応予定)
!manifestタグによるマニフェストのキュレーション(VRT用ストーリーの除外など)