Repository navigation
chore(deps): migrate to VitePress 2 and Vite 8.2 - #829
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (7)
💤 Files with no reviewable changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughVite and the React Vite plugin were upgraded across applications and examples. VitePress now renders Mermaid fences through a custom Vue component. ESM-compatible imports and path resolution were added. Workspace overrides and Node.js requirements were updated. ChangesTooling and documentation migration
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@package.json`:
- Around line 102-104: Update the vitepress-plugin-mermaid dependency in
package.json to a release whose declared peer dependency supports vitepress
2.0.0-alpha.19, and refresh the lockfile accordingly while preserving the
existing VitePress version.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 5d1891e3-40d7-4ecf-ba5b-05a631ac61ad
⛔ Files ignored due to path filters (2)
apps/sqlrooms-cli-ui/app-scaffolds/scaffolds.generated.jsonis excluded by!**/*.generated.*pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (40)
apps/sqlrooms-cli-ui/app-scaffolds/get-started/package.jsonapps/sqlrooms-cli-ui/package.jsonapps/sqlrooms-cli-ui/plugins/scaffolds.tsapps/sqlrooms-cli-ui/vite.config.tsdocs/.vitepress/config.tsdocs/.vitepress/gen-api-sidebar.tsexamples/ai-agent/package.jsonexamples/ai-core/package.jsonexamples/ai-rag/package.jsonexamples/ai-subagents/package.jsonexamples/ai/package.jsonexamples/app-builder/app-scaffolds/get-started/package.jsonexamples/app-builder/package.jsonexamples/app-builder/plugins/generateScaffolds.tsexamples/app-builder/plugins/scaffolds.tsexamples/app-builder/vite.config.tsexamples/canvas-sync/package.jsonexamples/canvas/package.jsonexamples/code-editor/package.jsonexamples/color-scales/package.jsonexamples/cosmos-embedding/package.jsonexamples/cosmos/package.jsonexamples/deckgl-discuss/package.jsonexamples/deckgl-mosaic/package.jsonexamples/deckgl/package.jsonexamples/get-started/package.jsonexamples/kepler/package.jsonexamples/layout/package.jsonexamples/minimal/package.jsonexamples/mosaic/package.jsonexamples/multi-room/package.jsonexamples/notebook/package.jsonexamples/pivot/package.jsonexamples/query-motherduck/package.jsonexamples/query-pwa/package.jsonexamples/query-websocket/package.jsonexamples/query/package.jsonexamples/sync/package.jsonpackage.jsonpnpm-workspace.yaml
| "vitepress": "2.0.0-alpha.19", | ||
| "vitepress-plugin-llms": "^1.13.4", | ||
| "vitepress-plugin-mermaid": "^2.0.17" |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
curl -fsSL https://registry.npmjs.org/vitepress-plugin-mermaid/2.0.17 |
jq '{peerDependencies, peerDependenciesMeta}'
rg -n 'vitepress-plugin-mermaid|vitepress@' pnpm-lock.yamlRepository: sqlrooms/sqlrooms
Length of output: 975
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
python3 - <<'PY'
import json, urllib.request
urls = [
"https://registry.npmjs.org/vitepress-plugin-mermaid/2.0.17",
"https://registry.npmjs.org/vitepress-plugin-mermaid/latest",
"https://registry.npmjs.org/vitepress-plugin-mermaid",
]
for url in urls:
print(f"\n## {url}")
try:
with urllib.request.urlopen(url, timeout=20) as r:
data = json.load(r)
if url.endswith("/latest") or not url.endswith("/"):
version = data.get("version")
deps = data.get("peerDependencies")
print("version", version)
print("peerDependencies", deps)
else:
latest = data.get("dist-tags", {}).get("latest")
versions = data.get("versions", {})
for v in [latest, "2.0.18", "2.1.0"]:
if v in versions:
d = versions[v]
print("version", v)
print("peerDependencies", d.get("peerDependencies"))
except Exception as e:
print("ERROR", type(e).__name__, e)
PYRepository: sqlrooms/sqlrooms
Length of output: 787
🌐 Web query:
npm vitepress-plugin-mermaid 2.0.17 peerDependencies vitepress
💡 Result:
For version 2.0.17 of the vitepress-plugin-mermaid package, the defined peerDependency for VitePress is ^1.0.0 || ^1.0.0-alpha [1][2][3]. While this configuration explicitly targets VitePress 1.x, users often report that the plugin continues to function correctly when used with VitePress 2.x [4]. If you encounter dependency resolution errors when installing in a VitePress 2.x project, it is standard practice to bypass the restriction using flags such as --force or --legacy-peer-deps with npm [4].
Citations:
- 1: https://registry.npmjs.org/vitepress-plugin-mermaid
- 2: https://www.npmjs.com/package/vitepress-plugin-mermaid
- 3: https://npmx.dev/package/vitepress-plugin-mermaid/v/2.0.17
- 4: Not compatible with VitePress 2.0? emersonbottero/vitepress-plugin-mermaid#86
Use a VitePress-2-compatible vitepress-plugin-mermaid release.
[email protected] declares vitepress: "^1.0.0 || ^1.0.0-alpha", while this manifest installs [email protected]. The lockfile can satisfy this request now, but the dependency contract does not cover VitePress 2.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@package.json` around lines 102 - 104, Update the vitepress-plugin-mermaid
dependency in package.json to a release whose declared peer dependency supports
vitepress 2.0.0-alpha.19, and refresh the lockfile accordingly while preserving
the existing VitePress version.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b6dfd5e74a
ℹ️ 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".
| "@vitejs/plugin-react": "^4.3.0", | ||
| "vite": "^7.3.2" | ||
| "@vitejs/plugin-react": "^5.2.0", | ||
| "vite": "^8.2.0" |
There was a problem hiding this comment.
Regenerate the app-builder scaffold manifest
This version bump only changes the source scaffold, but the app-builder UI imports app-scaffolds/scaffolds.generated.json and its Vite plugin is apply: 'serve', so production builds do not regenerate that manifest. The checked-in manifest still embeds @vitejs/plugin-react ^4.3.0 and vite ^5.4.0, so users opening the built app-builder continue to get the old Vite scaffold despite this migration. Please regenerate and commit the manifest, or make generation run for builds too.
Useful? React with 👍 / 👎.
| "typescript-language-server": "^5.1.3", | ||
| "vitepress": "^1.6.4", | ||
| "vitepress-plugin-llms": "^1.8.0", | ||
| "vitepress": "2.0.0-alpha.19", |
There was a problem hiding this comment.
Use a VitePress 2-compatible Mermaid integration
This moves the docs build to VitePress 2, but the existing withMermaid integration in docs/.vitepress/config.ts still comes from [email protected], whose lockfile peer range is only vitepress: ^1.0.0 || ^1.0.0-alpha; docs/persistence.md has Mermaid fences that rely on that plugin. In docs builds/previews after this upgrade, those diagrams are now on an unsupported/incompatible plugin path and can fail or render as raw code, so please update or replace the Mermaid integration as part of the VitePress 2 migration.
Useful? React with 👍 / 👎.
What changed
2.0.0-alpha.19) and updatedvitepress-plugin-llms.8.2.0with@vitejs/plugin-react5.2.0.22.12.Why
This replaces the two split Renovate updates with one coherent migration, avoids mixed Vite versions in the lockfile, and lets VitePress use Vite 8 directly.
Supersedes #826 and #827.
Impact and compatibility
vitepress-plugin-mermaidcurrently declares a VitePress 1 peer range. It nevertheless builds successfully with VitePress 2, and browser QA confirmed all three Mermaid diagrams on the persistence page render as SVGs without console errors.>=22.12, matching Vite 8's engine requirement.Checks
pnpm install --frozen-lockfile --ignore-scriptspnpm sort-package-json:checkpnpm build— 48/48 workspace buildspnpm docs:build— TypeDoc and VitePress production buildpnpm build:apps— 39/39 app tasksKnown unrelated validation limitations
code-editor-examplecurrently fails on existingQualifiedTableName.toArrayTypeScript errors.Summary by CodeRabbit