-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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: Remove storiesOf
-API
#24655
Merged
Merged
Core: Remove storiesOf
-API
#24655
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
ndelangen
requested review from
cdedreuille,
JReinhold,
kasperpeulen,
shilman,
valentinpalkovic,
yannbf and
tmeasday
as code owners
November 1, 2023 15:20
ndelangen
added
api: stories
maintenance
User-facing maintenance tasks
story index
ci:normal
labels
Nov 1, 2023
8 tasks
valentinpalkovic
approved these changes
Nov 8, 2023
ndelangen
added
ci:daily
Run the CI jobs that normally run in the daily job.
ci:normal
and removed
ci:normal
labels
Nov 23, 2023
…rybook into norbert/remove-storiesof
8 tasks
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
api: stories
BREAKING CHANGE
ci:daily
Run the CI jobs that normally run in the daily job.
maintenance
User-facing maintenance tasks
story index
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
It's time.
The
storiesOf
-API has been around since forever, but it's major problem has always been the fact that defining stories using it needed the code to run in order for storybook to determine which stories to show in the sidebar, which creates a bi-directional dependence between manager & preview.We've created CSF as a replacement for defining stories in/with. This has seen a few iteration/improvements/enhancements.
CSF is statically analyzable/extractable; which causes storybook to extract stories much much faster in NodeJS as it starts-up.
The other benefit is storybook can also lazy load stories as they are navigated to.
In Storybook 6.x we introduced
storyStoreV7
as a feature-flag, which users could/would opt-in to to get much faster start-times, at the cost of it not supporting thestoriesOf
-API.In Storybook 7.0 this feature-flag was inverted to be
true
by default.And now in Storybook 8.0 we're removing the
storiesOf
-API entirely.One of the remaining use-cases for
storiesOf
has been dynamically generating stories.In Storybook 7 we've introduced an indexer API which solves this problem, in a different way.
In Storybook 8 that API has matured and been iterated upon. I won't go into details here.
So this is the end of the road for
storiesOf
.Notes
This PR does not yet remove storyStoreV7 feature flag (yet). It does make that flag effectively broken by design.
I figured we could take the task of removing storyStoreV6 support step by step, starting with this (the most public) one.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
TBD
Documentation
!!! TODO !!!
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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team 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>