storybookjs/storybook

Add MDX2 checking output to MDX2 automigration

Open

#20,978 opened on Feb 7, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (10,058 forks)batch import
clihelp wantedmaintenance

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Explore the existing automigration code in Storybook to understand how it runs. Then, investigate the MDX2 checker to see how to invoke it programmatically and capture its output. Design a way to display the checker results inline during migration.
Tech stack
typescriptreactnodejs
Domain
developer experiencetoolingcli
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.
Half day
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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70