storybookjs/storybook

Add MDX2 checking output to MDX2 automigration

Open

#20,978 建立於 2023年2月7日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)TypeScript (89,909 star) (10,058 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.