Bump Storybook to 6.1 #2054
Merged
Bump Storybook to 6.1 #2054
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
This allows a user to create a custom Storybook preview file in `web/config/storybook.preview.js` and have it imported into the framework's version. I haven't added any documentation yet for two reasons. First, I want some confirmation that this approach is reasonable. But also, this actually took me a lot longer than it should have because I didn't realize that we're still on Storybook 5.3 and had to use the old `addDecorator` syntax. I suspect this will trip up other users as well, so perhaps it would be worthwhile to update to the latest Storybook before publicizing this feature? Anyone who tries to reference the Storybook docs for the content of this file will likely also be confused.
|
cc @peterp who is apparently the Storybook expert! |
corbt
commented
Mar 21, 2021
corbt
commented
Mar 21, 2021
corbt
commented
Mar 21, 2021
| @@ -0,0 +1,8 @@ | |||
| // This is an example of a custom preview.js file. If you'd like to | |||
There was a problem hiding this comment.
I created this file since ~__REDWOOD__USER_STORYBOOK_PREVIEW_CONFIG should always be aliased to a valid filepath, otherwise HMR complains when we require it. This is essentially a no-op file to alias it to if the user doesn't have their own config file.
|
What a nice suprize on a Sunday evening, thanks for doing this! |
peterp
approved these changes
Mar 21, 2021
peterp
reviewed
Mar 21, 2021
peterp
approved these changes
Mar 21, 2021
My pleasure! Took less code than I expected. 😄 |
This was referenced Mar 22, 2021
Closed
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.
This PR is a superset of #2048. It lets users define a custom Storybook preview file in
web/config/storybook.preview.js, and then merges that into the framework's storybook preview config.Additionally, it bumps the
@storybook/reactdependency from 5.3 to 6.1 (the latest stable version). This turned out to be a pretty simple change, since none of the features that Redwood depends on broke. It is possible that this breaks some user Storybook configurations, but based on the small (if verbose) list of breaking changes from 5.3 -> 6.0 and 6.0 -> 6.1 here I think very few users will be affected.I decided to combine these into one PR because they ended up being pretty intertwined. Storybook changed the recommended format of the
preview.jsfile from the oldaddDecoratorstyle to a newexport default decorators = [...]style with the 6.0 release, so the way we merge the user config had change as well. I can separate them back out if helpful, but I recommend releasing them together because we don't want folks to start writing customstorybook.preview.jsfiles against the 5.3 API if we're about to bump to 6.1 anyway.No documentation added here yet; want to make sure the code is good before putting time into that.