Storybook: Add webpack loader for easier story descriptions #39165
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.15 MB ℹ️ View Unchanged
|
ciampo
approved these changes
Mar 3, 2022
| test: /\/stories\/.+\.js$/, | ||
| // Currently does not work with our tsx stories | ||
| // See https://github.com/storybookjs/storybook/issues/17275 | ||
| test: /\/stories\/.+\.(j|t)sx?$/, |
There was a problem hiding this comment.
I've tried adding a Story description to Divider (a tsx story) and it seemed to work — what should we expect to be broken?
There was a problem hiding this comment.
This rule is for @storybook/source-loader, aka this tab:
It stays stuck in this loading state. Fortunately this Story tab isn't particularly necessary once we get the code snippets cleaned up in Docs view. We might even remove it at some point?
There was a problem hiding this comment.
Yeah, if we show code snippets in the docs it's not really necessary
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.
Follow-up to #38727 (comment)
Description
This adds a simple webpack loader (based on
story-description-loader) that will allow us to write story descriptions more easily as doc comments, rather than as a deep parameter:Before
After
The deep parameter path is way too hard to remember, so I imagine people (including me) will have to search for a code snippet every time they want to add a description. The doc comment way is much more intuitive for everyone, and will possibly become a built-in Storybook feature. Given that we will be adding a lot more story descriptions as part of our doc improvement efforts, I think this loader will be a huge help.
Additional benefits
Testing Instructions
npm run storybook:devFontSizePickerand their descriptions.Types of changes
Storybook only.
Checklist:
*.native.jsfiles for terms that need renaming or removal).