Support sub-components assigned to default export #411
Conversation
This file contains hidden or 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
stevenpetryk
force-pushed
the
sub-component-support
branch
from
0bc4f8a to
611854c
Compare
stevenpetryk
force-pushed
the
sub-component-support
branch
from
611854c to
52afa6f
Compare
stevenpetryk
commented
Jan 28, 2022
| export default function Root(props: { name: string }) { | ||
| return <span>root {props.name}</span>; | ||
| } | ||
| Root.displayName = 'Root'; |
There was a problem hiding this comment.
I had to explicitly set displayName here because, if I don't, the docgen incorrectly names this component SubComponent (naming it after the file). I feel like it's tangentially related to #395.
stevenpetryk
commented
Jan 28, 2022
| description: '' | ||
| } | ||
| }, | ||
| Sub: { |
There was a problem hiding this comment.
Without the change below, the component names are Root and default.Sub, which is not correct.
pvasek
pushed a commit
to pvasek/react-docgen-typescript
that referenced
this pull request
Mar 15, 2022
pvasek
added a commit
that referenced
this pull request
Mar 15, 2022
fix: the merging of PR #411 introduced a regression error
abharvey
pushed a commit
to abharvey/react-docgen-typescript
that referenced
this pull request
Jun 14, 2022
fix: the merging of PR styleguidist#411 introduced a regression error
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.
This prevents an issue where, when a component is the default export of a file, assigning any other component as a property causes the docgen to put
defaultin the component's display name.This fixes #394 and upstream would fix hipstersmoothie/react-docgen-typescript-plugin#57. It's a somewhat naive fix, but it keeps the test suite passing.