styleguidist/react-styleguidist

Ignore doctag doesn't work with TypeScript

Open

#830 aberto em 18 de fev. de 2018

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

Métricas do repositório

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

Description

    "react-styleguidist": "^6.2.5",
    "react-docgen-typescript": "^1.2.3",

using

export interface RoleProps {
    /** 
     * @ignore 
     */
    css?: M.Styling.CSSProperties
    /** @ignore */
    dontappear?: string;
} 

Both appear in the generated Styleguide.

Guia do colaborador

Direção de pesquisa
Investigue por que a tag @ignore não está sendo respeitada pelo react docgen typescript. Verifique se a tag está sendo analisada corretamente e se existem filtros que devem excluir propriedades ignoradas.
Pilha de tecnologia
typescript
Domain
tooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
GitNode.jsTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70