Add support for JsDoc tags (fix issue #28) #34
Merged
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
The TypeScript compiler helpfully splits JsDoc comments into two, exposing the bulk of the text via symbol.getDocumentationComment() and the JsDoc tags via symbol.getJsDocTags(). react-docgen expects to be given the full JsDoc comment including the tags, so we need to reconstitute the full comment back again from the parts exposed by TypeScript. This also DRYs out the comment parsing, to make whitespace trimming consistent.
Collaborator
|
Excellent, thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The TypeScript compiler splits JsDoc comments into two, and react-docgen-typescript was only pulling comment data from one of the two places. This PR rebuilds the full comment from both parts.
(Pulling the comment formation logic out into a helper method also has the effect of providing consistent handling both for null/undefined symbols when extracting comments and for whitespace-trimming.)