Upgrade VitePress to 2.0.0 alpha for newer esbuild#7
Conversation
…build Dependabot flagged the VitePress 1.6.4 line because its Vite dependency brought in an older esbuild. Upgrading to the current VitePress alpha moves the docs toolchain to Vite 7 and esbuild 0.27 while keeping this repository's current docs config, build scripts, and Pages workflow working unchanged. Constraint: The published CLI runtime should stay untouched; this change is limited to docs tooling Constraint: The repo Pages site must keep building with the existing VitePress config and GitHub Actions flow Rejected: Stay on VitePress 1.6.4 and override transitive esbuild manually | keeps the repo on an older unsupported toolchain branch Rejected: Hold the upgrade until VitePress 2 is stable | leaves the Dependabot issue in place despite a verified compatible upgrade path Confidence: medium Scope-risk: moderate Reversibility: clean Directive: Revisit this dependency once VitePress 2 exits alpha so the repo can move back to a stable release line without redoing the docs surface Tested: npm ls vitepress vite esbuild; npm run build; npm test; npm run docs:build; npm audit Not-tested: GitHub Actions CI run for this dependency-only branch
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ac76575324
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| }, | ||
| "engines": { | ||
| "node": "^18.0.0 || >=20.0.0" | ||
| "node": "^20.19.0 || >=22.12.0" |
There was a problem hiding this comment.
Upgrading to vitepress@2.0.0-alpha.17 pulls in Vite 7, and the lockfile now records Vite's engine as ^20.19.0 || >=22.12.0 (package-lock.json), but the repo still advertises "node": ">=22.0.0" in package.json. That mismatch means contributors on Node 22.0–22.11 satisfy the declared project engine yet can fail when running docs commands (vitepress build/dev) due to Vite's runtime Node version check.
Useful? React with 👍 / 👎.
1 participant
Summary
vitepressfrom1.6.4to2.0.0-alpha.17Analysis
vitepress@1.6.4depends onvite@^5.4.14, which resolved tovite@5.4.21andesbuild@0.21.5vitepress@2.0.0-alpha.17depends onvite@^7.3.1, which resolved tovite@7.3.1andesbuild@0.27.4defineConfig,cleanUrls,srcExclude, local search, default theme extension) still builds successfully on the alpha line2.0.0-alpha.12through2.0.0-alpha.17; the listed breaking changes are around markdown include handling and CJK markdown options, which this repo does not useTesting
Risk