storybookjs/storybook

Make HMR work with component JSDoc comments

Open

#20,734 opened on Jan 23, 2023

View on GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (10,058 forks)batch import
addon: docsbughelp wantedsev:S3

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (Avg merge 7d 22h) (184 merged PRs in 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.

Contributor guide

Research direction
Investigate the HMR update mechanism for component docgen info in CSF files. Trace the module reload path and check if the store updates correctly.
Tech stack
typescript
Domain
frontenddeveloper experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptStorybook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65