-
Notifications
You must be signed in to change notification settings - Fork 516
chore: upgrade vue-renderer-markdown perf mermaid render #908
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughDev dependency bump in package.json: vue-renderer-markdown updated from 0.0.52-beta.1 to 0.0.52-beta.3. No exported/public API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
package.json (1)
160-160
: Optional: add a minimal render smoke test.Add a Vitest + Vue Test Utils snapshot for a Mermaid block to catch future regressions from renderer bumps.
I can scaffold a test under test/renderer that mounts MarkdownRenderer.vue with a sample mermaid graph and asserts rendered SVG presence. Want a patch?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
package.json
(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: neoragex2002
PR: ThinkInAIXYZ/deepchat#807
File: src/renderer/src/components/markdown/MarkdownRenderer.vue:58-58
Timestamp: 2025-08-28T08:07:05.182Z
Learning: In src/renderer/src/components/markdown/MarkdownRenderer.vue, the unscoped <style> tag is intentionally used for global prose styles and the anchor .markdown-renderer fix, as confirmed by user neoragex2002.
📚 Learning: 2025-07-23T00:45:57.322Z
Learnt from: CR
PR: ThinkInAIXYZ/deepchat#0
File: .cursor/rules/vue-shadcn.mdc:0-0
Timestamp: 2025-07-23T00:45:57.322Z
Learning: Applies to src/renderer/**/*.{vue} : Use Shadcn Vue, Radix Vue, and Tailwind for components and styling.
Applied to files:
package.json
📚 Learning: 2025-09-16T07:06:30.926Z
Learnt from: CR
PR: ThinkInAIXYZ/deepchat#0
File: AGENTS.md:0-0
Timestamp: 2025-09-16T07:06:30.926Z
Learning: Applies to test/{main,renderer}/**/*.{test,spec}.ts : Write tests with Vitest (jsdom) and Vue Test Utils
Applied to files:
package.json
📚 Learning: 2025-07-21T01:46:30.354Z
Learnt from: CR
PR: ThinkInAIXYZ/deepchat#0
File: .cursor/rules/i18n.mdc:0-0
Timestamp: 2025-07-21T01:46:30.354Z
Learning: Applies to src/renderer/src/**/* : Use the 'vue-i18n' framework for all internationalization in the renderer
Applied to files:
package.json
📚 Learning: 2025-07-23T00:45:57.322Z
Learnt from: CR
PR: ThinkInAIXYZ/deepchat#0
File: .cursor/rules/vue-shadcn.mdc:0-0
Timestamp: 2025-07-23T00:45:57.322Z
Learning: Applies to src/renderer/**/*.{vue} : Use Vue 3 with TypeScript, leveraging defineComponent and PropType.
Applied to files:
package.json
🔇 Additional comments (4)
package.json (4)
160-160
: Version bump LGTM; pinning an exact beta is prudent.No immediate API concerns from this change alone. Thanks for avoiding a range on a pre-release.
Please include brief release notes (or a changelog link) in the PR description summarizing what 0.0.52-beta.3 changes vs .1 and why it improves Mermaid render perf.
160-160
: Mermaid/CSS regression pass.Given prior note that MarkdownRenderer.vue uses unscoped global prose styles intentionally, please sanity-check that the upgraded renderer doesn’t inject conflicting styles or change Mermaid container class names.
Suggested quick checks:
- Render a flowchart, sequence, and gantt block; verify dark/light themes and zoom responsiveness.
- Test anchor links and code blocks still match our global .markdown-renderer styles.
160-160
: No lockfile changes required.
Ran pnpm install locally; pnpm did not modify pnpm-lock.yaml (lockfile unchanged). pnpm also reported "Ignored build scripts: vue-renderer-markdown" — run pnpm approve-builds if you intend to allow that script.
160-160
: Double-check peer deps and renderer/runtime placement.
- Ran pnpm install locally: [email protected] is in devDependencies and pnpm reported "Ignored build scripts: vue-renderer-markdown".
- Check vue-renderer-markdown's peerDependencies (Vue, Vite, mermaid/markdown-it) against the current stack (vue 3.5.21, vite 7.1.5, mermaid 11.11.0).
- If the renderer imports this at runtime, move it from devDependencies → dependencies to avoid Electron packaging/tree‑shaking/externalization surprises; if it’s build-time only, keep as devDependency.
- Approve its install/build scripts with pnpm approve-builds in CI if those scripts are required for packaging.
Pull Request Description
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.
*For example: I'm always frustrated when [...] *
Describe the solution you'd like
A clear and concise description of what you want to happen.
UI/UX changes for Desktop Application
If this PR introduces UI/UX changes, please describe them in detail.
Platform Compatibility Notes
If this PR has specific platform compatibility considerations (Windows, macOS, Linux), please describe them here.
Additional context
Add any other context about the pull request here.
Pull Request Description (中文)
你的功能请求是否与某个问题有关?请描述一下。
请对问题进行清晰扼要的描述。
*例如:我增加了 [...] 的功能 *
请描述你希望的解决方案
请对你希望实现的效果进行清晰扼要的描述。
桌面应用程序的 UI/UX 更改
如果此 PR 引入了 UI/UX 更改,请详细描述它们。
平台兼容性注意事项
如果此 PR 具有特定的平台兼容性考虑因素(Windows、macOS、Linux),请在此处描述。
附加背景
在此处添加关于此 Pull Request 的任何其他背景信息。
Summary by CodeRabbit