Document limitation for .mdx stories #102
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
|
Oops, I need to remove |
IanVS
changed the title
|
Thanks for your contribution @IanVS ! |
Merged
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 scratching my head for a bit as to why I was getting an error that no tests were found, when I had a
.stories.mdxfile that I assumed would be picked up. According to #36,--stories-jsonmode should be used to enable running tests against such stories.This adds a brief note in the README about this, though it might be good to clearly document exactly which tests this does support out of the box, and point to stories.json mode for others. But, I'll admit that I'm not clear on exactly what is supported myself.
📦 Published PR as canary version:
0.0.8-canary.102.5ccece6.0✨ Test out this PR locally via:
npm install @storybook/test-runner@0.0.8-canary.102.5ccece6.0 # or yarn add @storybook/test-runner@0.0.8-canary.102.5ccece6.0