storybookjs/storybook

Add MDX2 checking output to MDX2 automigration

Open

#20,978 opened on 2023年2月7日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
clihelp wantedmaintenance

説明

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.

コントリビューターガイド

技術スタック
typescriptnodejs
領域
developer experiencetooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScript knowledgeStorybook MDX2 migrationMDX2 checker APICommand line tools
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
30
調査方針
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.