storybookjs/storybook

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

Open

#29127 opened on Sep 14, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
addon: docsbughelp wanted

Description

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

Tech stack
typescriptreactstorybook
Domain
frontenddocumentationdeveloper experience
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with StorybookUnderstanding of MDXTypeScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.