styleguidist/react-styleguidist

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

Open

#1271 aperta il 8 feb 2019

Vedi su GitHub
 (3 commenti) (2 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wanted

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia come react docgen estrae i PropTypes dai componenti, poi indaga il formato di output di babel plugin flow react proptypes e proponi un nuovo risolutore o plugin per utilizzare quell'output per generare documentazione.
Tech stack
reacttypescriptjavascript
Dominio
frontenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ReactBabelFlow PropTypes
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40