storybookjs/storybook

[Bug]: Rendering of MDX documentation fails when the imported stories file changes

Geschlossen

#29.127 geöffnet am 14.09.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (10.058 Forks)batch import
addon: docsbughelp wanted

Repository-Metriken

Stars
 (89.909 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 7T 22h) (184 gemergte PRs in 30 T)

Beschreibung

Describe the bug

When adding a new story to a stories file that is imported in a .mdx file, the following error is thrown:

Invalid value passed to the 'of' prop. The value was resolved to a 'component or unknown' type but the only types for this block are: story.

It happens when the imported story files is modified in other ways as well, but this is the most simple case to replicate this bug.

Reproduction link

https://stackblitz.com/edit/github-unrkza-3cuztn?file=src%2Fstories%2FButton.stories.ts

Reproduction steps

  1. Go to the link above
  2. Open "Buttons documentation" doc in the preview pane
  3. Open src/stories/Button.stories.tsx file
  4. Duplicate e.g. the Secondary story and rename it to e.g. Tertiary

Expected behavior: The doc is still rendered correctly.

Actual behavior: The error mentioned above it thrown.

System

I'm not sure how to run `npx storybook@latest info` on StackBlitz, as the terminal does not seem to work for me. I am using the React 18 Webpack template, which uses Storybook 8.4.0-alpha.0.

Additional context

It makes writing documentation using MDX files a bit frustrating ;)

Contributor Guide

Research-Richtung
Investigate the codebase of storybookjs/storybook, focusing on how MDX files are processed and how story imports are resolved during hot module replacement. Look at the relevant core addon for docs and the MDX compiler. The error suggests a type mismatch in the 'of' prop for story blocks. Examine the code path when a stories file changes and how the story metadata is updated. Check existing issues or PRs related to MDX and story import updates.
Tech Stack
typescriptreactstorybook
Domain
frontenddocumentationdeveloper experience
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Familiarity with StorybookUnderstanding of MDXTypeScript basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45