Improve react docgen plugin usage #460
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
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.
Fixes #456
This uses the same approach as storybook itself. The
react-docgenplugin is used as long as the option is not set tofalse(previously we did not respect that), and it is used on all files unless the option is set toreact-docgen-typescript, in which case it does not run on typescript files, and leaves those to the other plugin.This also includes a change to always set
savePropValueAsStringon the typescript plugin, as storybook does, even though from what I can tell, storybook is fine even when it's set to false. But, it seems worth it to match storybook to avoid any subtle bugs or corner cases it might be intended to prevent.