reactjs / reactjs/react-docgen
react-docgen cannot extract comments with hermes-parser
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Component comment blocks as well as proptype comments cannot be extracted with react docgen when using babel hermes-parser plugin https://www.npmjs.com/package/babel-plugin-syntax-hermes-parser. This parser is essential when running an application with flow
This issue explains it a bit more https://github.com/facebook/hermes/issues/1098. Would it be possible to improve the default handlers to support this?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Hermes issue and inspect react-docgen's default handlers, then reproduce extraction with babel-plugin-syntax-hermes-parser enabled. Done means component comment blocks and prop-type comments are extracted correctly in that parser configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100