用途:帮助把 Rspress 项目从 v1 升级到 v2,适用于用户要求升级 Rspress、按 v1→v2 指南迁移、更新配置或主题、以及验证升级结果的场景。
主要能力与流程:先确认现状,读取 package.json 识别所用 Rspress 与插件包,定位 Rspress 配置文件(常见为 rspress.config.(ts|js|mjs|cjs)),检查自定义主题文件与 MDX 用法。以官方升级指南为准:https://rspress.rs/guide/migration/rspress-1-x。随后规划升级路径,列出影响当前配置、插件与主题的破坏性变更,记录被移除或重命名的包、选项与 API。
依赖更新:将 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;其余 Rspress 插件用 npx taze major --include /rspress/ -w -r 升级到最新版本;确保 Node.js >= 20.9.0。
配置与代码调整:更新导入路径,如 rspress/runtime → @rspress/core/runtime、rspress/theme → @rspress/core/theme、@rspress/theme-default → @rspress/core/theme-original;若项目在 theme 目录有自定义主题,使用 @rspress/core/theme-original 导入原始主题组件;按 v2 选项与默认值更新配置,移除已弃用或不支持的设置。
验证:运行构建与开发服务器,修复新版本出现的警告或错误;若出现错误或警告,参考官方升级指南,先检查是否因遗漏或不完整的迁移步骤导致。
限制:资料未提供具体版本兼容矩阵、回滚方案或自动化脚本,实际迁移需以官方指南和项目实际情况为准。