storybookjs/storybook

Make HMR work with component JSDoc comments

Open

#20.734 aberto em 23 de jan. de 2023

Ver no GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (10.058 forks)batch import
addon: docsbughelp wantedsev:S3

Métricas do repositório

Stars
 (89.909 stars)
Métricas de merge de PR
 (Mesclagem média 7d 22h) (184 fundiu PRs em 30d)

Description

When you update the comment on the component for a CSF file, the component is HMR-ed:

  • In some cases the new comment + docgen comes over the wire
  • In other cases it does not.

In all cases, the component in the store is not updated with new docgen info. We need to figure out what's happening and if it is possible to resolve.

Guia do colaborador

Direção de pesquisa
Investigue o mecanismo de atualização HMR para informações de docgen de componentes em arquivos CSF. Rastreie o caminho de recarregamento do módulo e verifique se o armazenamento é atualizado corretamente.
Pilha de tecnologia
typescript
Domain
frontenddeveloper experiencetooling
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.
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
TypeScriptStorybook
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65