storybookjs/storybook

Add MDX2 checking output to MDX2 automigration

Open

#20,978 opened on Feb 7, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
clihelp wantedmaintenance

Description

Currently in the MDX2 migration we say that there will likely be issues that the automigration can't handle.

We can make this a lot better if we actually run the MDX2 checker on the user's project IN the automigration and show the result inline.

Given what a pain MDX2 is, we should do this to make the user's life that much easier.

Contributor guide

Tech stack
typescriptnodejs
Domain
developer experiencetooling
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript knowledgeStorybook MDX2 migrationMDX2 checker APICommand line tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
First, locate the existing MDX2 automigration code in the Storybook repository (likely under `lib/core server` or similar). Understand how the MDX2 checker is currently run and its output format. Then, modify the automigration to invoke the checker and display its results inline. Look for existing tests and comments in related files for guidance. Since there are no linked issues or PRs, start by exploring the migration code and the checker's API.