Core: Built-in static stories.json support
#14945
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
Nx Cloud ReportCI ran the following commands for commit 02e7491. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch
Sent with 💌 from NxCloud. |
shilman
changed the title
tmeasday
reviewed
May 17, 2021
Comment on lines
+8
to
+13
| interface ExtractedStory { | ||
| id: string; | ||
| kind: string; | ||
| name: string; | ||
| parameters: Record<string, any>; | ||
| } |
There was a problem hiding this comment.
Don't want to use our existing types for this? Last thing we need is yet-another-story type definition.
| } | ||
| const csf = (await readCsf(csfFile)).parse(); | ||
| csf.stories.forEach((story) => { | ||
| stories[story.id] = { ...story, kind: csf.meta.title }; |
There was a problem hiding this comment.
Should we be only pulling out the exact parameters we want here? Also will the csf tools eventually return other stuff on the story object apart from parameters?
Comment on lines
+12
to
+22
| interface Meta { | ||
| title?: string; | ||
| includeStories?: string[] | RegExp; | ||
| excludeStories?: string[] | RegExp; | ||
| } | ||
|
|
||
| interface Story { | ||
| id: string; | ||
| name: string; | ||
| parameters: Record<string, any>; | ||
| } |
| ExportDefaultDeclaration: { | ||
| enter({ node }) { | ||
| if (t.isObjectExpression(node.declaration)) { | ||
| // export default { ... }; |
There was a problem hiding this comment.
What about const meta = {}; export default meta;?
| ExportNamedDeclaration: { | ||
| enter({ node }) { | ||
| if (t.isVariableDeclaration(node.declaration)) { | ||
| // export const X = ...; |
There was a problem hiding this comment.
What about const Story = {}; export { Story }; }?
9 tasks
shilman
requested review from
aaronmcadam,
alexandrebodin,
alterx,
CodeByAlex,
dangreenisrael,
danielduan,
igor-dv,
jbovenschen,
kazupon,
thani-sh,
ndelangen,
renaudtertrais,
saponifi3d,
stijnkoopal,
theinterned and
thomasbertet
as code owners
shilman
changed the title
stories.json support
2 tasks
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.
Issue: N/A
What I did
@storybook/csf-toolsfor statically analyzing CSF filesstories.jsonparameters.fileNameself-merging to unblock @tmeasday
Current limitations
Moved => #14966
What I need
Since lots of story metadata is NOT statically analyzable, we might need to redesign
stories.jsonand/or composition to accommodate static resultsHow to test
Manual test cases in
html-kitchen-sink(akaH) /react-ts(akaR) examples. Uncomment the appropriate line's inH'smain.jsconfig.yarn storybookinR,yarn storybookinHin another terminalyarn build-storybookinR,yarn storybookinHin another terminalUnit tests:
yarn test CsfFile