-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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: Split Storybook CLI #28519
Merged
Merged
Core: Split Storybook CLI #28519
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
Contributor
…li-split # Conflicts: # code/core/src/common/versions.ts
kasperpeulen
commented
Jul 10, 2024
c79abe1
to
bd92435
Compare
bd92435
to
c31b249
Compare
f08d494
to
bcd8b77
Compare
ndelangen
reviewed
Jul 11, 2024
Failed to publish canary version of this pull request, triggered by @kasperpeulen. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/9905459943 |
ndelangen
approved these changes
Aug 1, 2024
…rybook into kasper/cli-split
14 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ci:daily
Run the CI jobs that normally run in the daily job.
maintenance
User-facing maintenance tasks
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
Implements the CLI split RFC:
#23590
The build and dev command is moved to
@storybook/core/cli
together with other shared CLI logic.The init command is moved to
create-storybook
All other commands are moved
@storybook/cli
.In the
storybook
package there is aproxy.ts
file that orchestrates thestorybook
package to forward the command with npx to the right package:storybook/code/lib/cli/src/proxy.ts
Lines 1 to 21 in d085503
By using
npx
, the user doesn't have to install a bunch of dependencies, such asjscodeshift
, that are not needed for basic storybook commands. It now only needs to download that when it actually needs it.This makes sure that the
storybook
package is as lean as possible. We remove 370 packages and 70MB install size with this PR.Next to that, we can now consolidate the
@storybook/core
package withstorybook
in a follow-up PR cc @ndelangen, which would clean up our code base quite a bit.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: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-28519-sha-8fbf6907
. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-28519-sha-8fbf6907 sandbox
or in an existing project withnpx storybook@0.0.0-pr-28519-sha-8fbf6907 upgrade
.More information
0.0.0-pr-28519-sha-8fbf6907
kasper/cli-split
8fbf6907
1722526319
)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=28519