reactjs / reactjs/react-docgen
Handle Complex Unions and Intersections
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Currently react-docgen doesn't handle some more complex cases for typescript Props
I help maintain react-docgen-typescript where I recently implemented this
Here is our bustling collection of valid typescript react component tests
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 with the linked react-docgen-typescript parser.ts implementation and its src/tests/data collection of valid TypeScript React component cases. Compare those cases with react-docgen's parser and tests to identify the missing complex union and intersection handling. Done means these prop types are extracted correctly without regressing existing cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100