Mention TSX index file requirement in README #6887
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
I was stuck getting Storybook working with TypeScript following the steps here. My components weren't showing up in the Storybook index. Diffing my project with the [demo repo](https://github.com/johot/storybook4-cra2-typescript-react-docgen-typescript-demo) I realized that my index file had the wrong name. Not sure where this requirement comes from, but it doesn't seem to work with `stories/index.tsx`, which is the likeliest name the user is going to give this file if the default is `stories/index.js`.
|
I made this change using the web UI, and submitting against the |
ndelangen
approved these changes
May 28, 2019
ndelangen
approved these changes
May 28, 2019
ndelangen
approved these changes
Jun 3, 2019
shilman
pushed a commit
that referenced
this pull request
Jun 5, 2019
Mention TSX index file requirement in README
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.
I was stuck getting Storybook working with TypeScript following the steps here. My components weren't showing up in the Storybook index.
Issue:
Following the instructions for integrating Storybook with TypeScript in a project started with the
create-react-appscript, the components I added in mystories/indexwere not showing up on the storybook index page.What I did
Diffed my project with the demo repo, realized that my index file had a different name. Not sure where this requirement comes from, but stories won't show up in the index if it has the name
stories/index.tsx, which is the likeliest name the user is going to give this file since the default isstories/index.js.How to test
Is this testable with Jest or Chromatic screenshots?
No
Does this need a new example in the kitchen sink apps?
No
Does this need an update to the documentation?
No, it is an update to the documentation