More information for props with type enum, union, etc.
Open
Nobody has claimed this yet.
jira-sync-complete
- Dominant language
- TypeScript
- Stars
- 90
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
We can get more information out of these types (from react-docgen). We just need to put a little work into extracting it and rendering it legibly. That would save us from the need to type out details about, say, which strings are allowed for an enum type.
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 locating the prop type extraction and rendering entry points, then inspect the react-docgen data available for enum and union types. The work is done when those types' useful details are rendered legibly without requiring manually typed allowed-value descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100