mcpField
R
rspress-v2-upgrade

rspress-v2-upgrade

github.com/rstackjs開発97144 回インストール6 日前に更新
リポジトリ

rspress-v2-upgrade について

Rspress プロジェクトを v1 から v2 に移行するためのスキルです。依存関係、設定、テーマの変更を案内し、ビルドと開発サーバーで移行を検証します。

主な機能

  1. 01Rspress パッケージと設定の確認
  2. 02該当する破壊的変更の特定
  3. 03依存関係とインポートパスの更新
  4. 04ビルドと開発サーバーによる検証

活用シーン

  1. 01v1 から v2 への移行計画
  2. 02カスタムテーマを使うプロジェクトの更新
  3. 03移行後のエラー確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/rstackjs/agent-skills --skill rspress-v2-upgrade

インストール後、Claude Code で/rspress-v2-upgradeを入力して読み込まれたか確認します。

詳細

Rspress v1 から v2 へのアップグレード

ワークフロー

  1. 現在の設定を確認する

    • package.json を読み、使用中の Rspress とプラグインのパッケージを特定します。
    • Rspress の設定ファイルを探します（一般的には rspress.config.(ts|js|mjs|cjs) です）。
    • カスタムテーマファイルと MDX の使用状況を確認します。

  2. 公式アップグレードガイドを開く

  3. アップグレードの手順を計画する

    • プロジェクトの現在の設定、プラグイン、テーマに該当する破壊的変更をリストアップします。
    • 削除または名称変更されたパッケージ、オプション、API を確認します。

  4. 依存関係を更新する

    • rspress を @rspress/core@^2.0.0 に置き換えます。
    • @rspress/core に組み込まれたパッケージを削除します（例：rspress、@rspress/plugin-shiki、@rspress/plugin-auto-nav-sidebar、@rspress/plugin-container-syntax、@rspress/plugin-last-updated、@rspress/plugin-medium-zoom、@rspress/theme-default、@rspress/runtime）。
    • npx taze major --include /rspress/ -w -r を実行して、残りの Rspress プラグインを最新バージョンに更新します。
    • Node.js が 20.9.0 以上であることを確認します。

  5. 設定とコードを変更する

    • インポートパスを更新します（rspress/runtime → @rspress/core/runtime、rspress/theme → @rspress/core/theme、@rspress/theme-default → @rspress/core/theme-original）。
    • プロジェクトにカスタムテーマ（theme ディレクトリ内）がある場合は、@rspress/core/theme-original を使用してオリジナルテーマのコンポーネントをインポートします。
    • Rspress の設定を v2 のオプションとデフォルトに合わせて更新します。
    • 非推奨または未サポートの設定を削除します。

  6. 検証する

    • ビルドと開発サーバーを実行します。
    • 新しいバージョンで発生した警告やエラーを修正します。エラーや警告が発生した場合は、公式アップグレードガイドを参照し、まず移行手順の省略や不備が原因でないか確認してください。

コメント

Markdown 対応