reactjs / reactjs/react-docgen
Class components with private members breaks docgen
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Running docgen on class-based component with private member syntax results in following error:
TypeError: Argument must be an Identifier or a Literal
This is blocking us from scraping component information for documentation for internal meta components. This was supposedly fixed in https://github.com/reactjs/react-docgen/issues/346, but I am still seeing the error
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
Start by reproducing docgen with a class-based React component that uses private member syntax, then compare the behavior with the fix discussed in issue 346. Confirm the failure no longer occurs and that component information is extracted for documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100