rspress-v2-upgrade
Migrate Rspress projects from v1 to v2. Use when a user asks to upgrade Rspress, follow the v1-to-v2 guide, update configs/themes, or validate the upgrade.
How do I install this agent skill?
npx skills add https://github.com/rstackjs/agent-skills --skill rspress-v2-upgradeIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides a standard workflow for upgrading Rspress projects from version 1 to 2. It reads project configuration files, references official documentation, and updates dependencies using established developer tools like npx and taze. No malicious behavior or security risks were identified.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
1/1 file flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Rspress v1 to v2 upgrade
Workflow
-
Confirm current setup
- Read
package.jsonto identify Rspress and plugin packages in use. - Locate the Rspress config file (commonly
rspress.config.(ts|js|mjs|cjs)). - Check for custom theme files and MDX usage.
- Read
-
Open the official upgrade guide
- Use the v1 → v2 guide as the source of truth:
-
Plan the upgrade path
- List breaking changes that apply to the project's current config, plugins, and theme.
- Note any removed or renamed packages, options, and APIs.
-
Update dependencies
- Replace
rspresswith@rspress/core@^2.0.0. - Remove packages now built into
@rspress/core(e.g.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). - Bump remaining Rspress plugins to latest versions via
npx taze major --include /rspress/ -w -r. - Ensure Node.js >= 20.9.0.
- Replace
-
Apply config and code changes
- Update import paths (
rspress/runtime→@rspress/core/runtime,rspress/theme→@rspress/core/theme,@rspress/theme-default→@rspress/core/theme-original). - If the project has a custom theme (in
themedirectory), use@rspress/core/theme-originalto import the original theme components. - Update the Rspress config to match v2 options and defaults.
- Remove deprecated or unsupported settings.
- Update import paths (
-
Validate
- Run the build and dev server.
- Fix any warnings or errors that appear in the new version. If errors or warnings occur, please refer to the Official Upgrade Guide and first check if it's caused by any omitted or incomplete migration steps.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/rstackjs/agent-skills/rspress-v2-upgrade">View rspress-v2-upgrade on skillZs</a>