react-docgen cannot extract comments with hermes-parser

Open
#835 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
react, typescript
Domain
documentation

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.

Description

flow typescript

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?

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.