Storybook: Make description-loader more reliable #40616
Merged
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
|
Size Change: 0 B Total Size: 1.23 MB ℹ️ View Unchanged
|
ciampo
approved these changes
Apr 27, 2022
There was a problem hiding this comment.
LGTM 🚀 The warning is gone, and the story description is still being shown like before.
Not related to changes in this PR, but inspired by https://github.com/WordPress/gutenberg/pull/40164/files#r859619333 I tried passing parameters to a story (e.g. adding WithCustomUnits.parameters = {}; as the last line of packages/components/src/unit-control/stories/index.tsx), and effectively that makes the description go away from the rendered story. Not sure if we can do anything about it, though
mirka
force-pushed
the
fix/storybook-comment-description
branch
from
0124658
to
dc01a3b
Compare
mirka
changed the title
Great point, and I'm happy to report that I figured it out! This PR is now more about that bug fix rather than the deprecation fix. I've updated the PR description with new instructions. Ready for another spin 🙏 |
ciampo
approved these changes
Apr 28, 2022
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?
Two bug fixes:
MyStory.parameters = {}statements in the code.MyStory.story.parameters.docs.storyDescriptionMyStory.parameters.docs.description.storyWhy?
The webpack loader code added in #39165 was naive in a few ways:
MyStory.story.parameters.docs.storyDescription = "foo"statement right after the named export statement, meaning that any existing statements in the code after that likeMyStory.parameters = { ... }could erase the story description.Testing Instructions
npm run storybook:devGo to the Docs view of
UnitControl.In the story file for that component, pick a story with a JSDoc comment description. Add some custom config like:
In this case, the explicit story description should be shown in the Docs view.
Remove the explicit description from the code. Now, the JSDoc comment description should be shown in the Docs view.
The console warnings below shouldn't be thrown anymore.