-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Core: Add Rsbuild frameworks to known frameworks #28694
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
Added storybook-react-rsbuild
and storybook-vue3-rsbuild
to the known frameworks list to ensure proper detection and categorization.
- Modified
code/core/src/common/utils/get-storybook-info.ts
to includestorybook-react-rsbuild
andstorybook-vue3-rsbuild
in theframeworkPackages
object. - Ensures
storybook-react-rsbuild
is categorized as areact
framework. - Ensures
storybook-vue3-rsbuild
is categorized as avue
framework. - No security issues or logical errors identified; compatibility with existing infrastructure should be verified.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit cff0346. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fi3ework thanks for the PR! react
/vue3
are renderers not frameworks, so you'll probably need to add react-rsbuild
and vue3-rsbuild
to the list of SupportedFrameworks
, etc.
Thanks for hinting. I used to open the PR in github.dev so sorry for missing modifying others. There's one place blocking me here https://github.com/storybookjs/storybook/blob/next/code/lib/cli/src/helpers.ts#L141-L159. Since Rsbuild builder is either of the two core builder, there seems no way to change the code under the current code premise. |
@shilman any guidance for which core builder to use? Maybe |
@fi3ework @jeffijoe Sorry for the slow response. AFAICT that constant I'm unsure if that code even needs updating, since it's purpose is to migrate from older versions of Storybook to post-8.0 conventions. And these Rsbuild frameworks are presumably 8.0+. But if it was necessary to include the new frameworks, I would probably change the type like this: - export const frameworkToDefaultBuilder: Record<SupportedFrameworks, CoreBuilder> = {
+ export const frameworkToDefaultBuilder: Record<SupportedFrameworks, CoreBuilder | string> = { |
Thank you, @shilman, for the kind suggestion. I have updated the code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's even nicer. Thanks @fi3ework !!
@shilman just tested it, everything works and the |
Closes rspack-contrib/storybook-rsbuild#51.
What I did
Add
storybook-react-rsbuild
andstorybook-vue3-rsbuild
to known frameworks, which could make the former being detected as anreact
framework.Checklist for Contributors
Testing
npm create rsbuild@latest
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:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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 pull request has been released as version
0.0.0-pr-28694-sha-b28ec221
. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-28694-sha-b28ec221 sandbox
or in an existing project withnpx storybook@0.0.0-pr-28694-sha-b28ec221 upgrade
.More information
0.0.0-pr-28694-sha-b28ec221
patch-3
b28ec221
1723405372
)To request a new release of this pull request, mention the
@storybookjs/core
team.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=28694