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 (89,909 stars) (10,058 forks)batch import
addon: docsbughelp wantedsev:S3

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

Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Storybook internalsHMR mechanismComponent DocGen
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate the HMR update path for CSF files in Storybook's server core (likely in `lib/core server`). Identify when component metadata is updated after HMR and compare cases where docgen is successful vs not. The store update logic for component metadata after HMR should be traced to find the gap.