Automigrate: Prefer framework import #30785
Draft
Conversation
This file contains 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
Introduces a new automigrate fix that helps users transition from renderer-specific packages to framework packages in Storybook 9.0. The fix: - Detects renderer and framework packages in project - Allows interactive selection of framework - Transforms import statements - Removes renderer dependencies from package.json
Adds comprehensive test coverage for the renderer to framework migration fix, including: - Source file transformation tests - Package.json dependency removal tests - Framework and renderer detection tests - Error handling scenarios
|
View your CI Pipeline Execution ↗ for commit 38758e9.
☁️ Nx Cloud last updated this comment at |
|
View your CI Pipeline Execution ↗ for commit 54facb7.
☁️ Nx Cloud last updated this comment at |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
This pull request to
code/lib/cli-storybookintroduces new functionality to automate the migration from renderer packages to framework packages. The changes include adding new helper functions, updating existing functions, and adding comprehensive tests.Key changes include:
New Functionality:
code/lib/cli-storybook/src/automigrate/fixes/renderer-to-framework.ts: Added functions to detect frameworks and renderers, transform source files, remove renderer packages frompackage.json, and prompt the user for framework selection.Testing:
code/lib/cli-storybook/src/automigrate/fixes/renderer-to-framework.test.ts: Added tests to verify the new functionality, including transforming source files, removing renderer packages frompackage.json, and handling various edge cases such as file read errors.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>