feat: Codemod for Chakra UI #10538
Open
feat: Codemod for Chakra UI #10538
+5,433
−103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 6df5d37 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Adebesin-Cell
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Adds the new
@chakra-ui/codemodpackage to help automate migration of Chakra UI projects from v2 to v3 following the official migration guide.This package provides codemods for updating component props, restructuring components, and refactoring theme configurations according to v3 changes. It covers all migration steps outlined in the guide, helping developers upgrade with minimal manual effort.
⛳️ Current behavior
Developers must manually update:
isActive→data-active,colorScheme→colorPalette)Collapse→Collapsible,Modal→Dialog)This process is error-prone and time-consuming.
🚀 New behavior
The codemods automate the migration:
createSystemanddefaultConfig💣 Is this a breaking change?
No, the codemod is a migration helper. It does not change runtime behavior by itself but updates the codebase to match v3 conventions.
📝 Additional Information
Developers should review all changes after running codemods and complete any remaining manual migration steps according to the migration guide.
This package is intended to speed up the upgrade process and reduce manual effort.