styleguidist/react-styleguidist

Add support for babel-plugin-flow-react-proptypes

Open

#1,271 opened on Feb 8, 2019

View on GitHub
 (3 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

The problem

react-docgen isn't very reliable, and doesn't work at all with styled components.

Proposed solution

Allow to generate the documentation from React PropTypes autogenerated with babel-plugin-flow-react-proptypes starting from the Flow types.

Alternative solutions

Fix react-docgen, but it's not trivial.

Additional context

I think it's a low hanging fruit that will improve the quality of the generated documentation for Flow users. It may even be used as a fallback solution if react-docgen fails.

Contributor guide

Research direction
Study how react docgen extracts PropTypes from components, then investigate the babel plugin flow react proptypes output format and propose a new resolver or plugin to use that output for generating documentation.
Tech stack
reacttypescriptjavascript
Domain
frontenddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactBabelFlow PropTypes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40