styleguidist/react-styleguidist

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

Open

#1.271 aberto em 8 de fev. de 2019

Ver no GitHub
 (3 comments) (2 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Estude como o react docgen extrai PropTypes dos componentes, depois investigue o formato de saída do babel plugin flow react proptypes e proponha um novo resolvedor ou plugin para usar essa saída na geração de documentação.
Pilha de tecnologia
reacttypescriptjavascript
Domain
frontenddocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
ReactBabelFlow PropTypes
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40