mcpField
R
rspress-v2-upgrade

rspress-v2-upgrade

github.com/rstackjs开发97144 次安装6 天前更新
代码仓库

关于 rspress-v2-upgrade

用于将 Rspress 项目从 v1 升级到 v2 的技能，面向项目维护者。它涵盖依赖、配置和主题迁移，并通过构建与开发服务器验证结果。

主要功能

  1. 01检查 Rspress 包与项目配置
  2. 02识别适用的破坏性变更
  3. 03更新依赖与导入路径
  4. 04通过构建和开发服务器验证

适用场景

  1. 01规划 v1 到 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