fix: remove Chakra UI composition in storybook #552
Conversation
WalkthroughThe pull request modifies the Storybook configuration file by adding a new Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.storybook/main.ts (1)
26-28: Consider enhancing the documentation.The comments could be improved by:
- Adding a TODO marker to revisit this when v2 URL becomes available
- Including a reference to relevant Chakra UI documentation
- // Disable Chakra UI storybook composition as it fetches the v3. - // I did not find the URL of the v2 at the moment to replace it. + // TODO: Temporarily disable Chakra UI storybook composition as it fetches v3. + // Replace with v2 URL when available (see: https://chakra-ui.com/getting-started/storybook-guide)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.storybook/main.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Lint and Type Check (22)
- GitHub Check: Playwright E2E Tests
🔇 Additional comments (1)
.storybook/main.ts (1)
25-29: LGTM! The solution effectively addresses the version compatibility issue.The implementation correctly disables the Chakra UI Storybook composition to prevent fetching v3, which aligns with the PR objectives. The comments provide clear context about the rationale and current limitations.
Let's verify there are no remaining Chakra UI Storybook references:
✅ Verification successful
Verification successful: Chakra UI composition is correctly disabled
The changes effectively prevent fetching Chakra UI v3 docs while maintaining local component usage. The remaining Chakra UI imports in
preview.tsxare independent of the Storybook composition and don't affect the version compatibility issue being addressed.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for any remaining Chakra UI Storybook references # that might need to be addressed # Search for Chakra UI related configurations in Storybook files rg -i "chakra.*storybook|storybook.*chakra" .storybook/ # Check package.json for any Chakra UI Storybook dependencies jq '.dependencies + .devDependencies' package.json | rg -i "chakra.*storybook"Length of output: 226
Script:
#!/bin/bash # Check for Chakra UI related imports and configurations in Storybook files rg -i "@chakra-ui" .storybook/ -A 2 # Look for any composition or reference configurations fd -e ts -e js -p "preview" .storybook/ --exec cat {}Length of output: 414
Describe your changes
Remove the Chakra UI Storybook automatic composition as it fetches the v3 of Chakra UI
Checklist
pnpm storybookcommand and everything is workingSummary by CodeRabbit