styleguidist/react-styleguidist

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

Open

#1 271 ouverte le 8 févr. 2019

Voir sur GitHub
 (3 commentaires) (2 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Étudiez comment react docgen extrait les PropTypes des composants, puis examinez le format de sortie de babel plugin flow react proptypes et proposez un nouveau résolveur ou plugin pour utiliser cette sortie afin de générer de la documentation.
Stack technique
reacttypescriptjavascript
Domaine
frontenddocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ReactBabelFlow PropTypes
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40