refactor(XMarkdown): move mermaid & highlight to standalone components, drop x-markdown dependency #1402
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
|
|
Summary of ChangesHello @Div627, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request undertakes a significant refactoring of the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a significant refactoring that moves the Mermaid and HighlightCode functionalities from x-markdown into standalone components within the main x package. This is a great move for modularity and decouples x-markdown from @ant-design/x dependencies. The changes are extensive, involving moving files, updating dependencies, creating new components with their own tests and documentation, and adjusting the theming and locale infrastructure.
My review has identified a few issues:
- There's a critical issue in the new
CodeHighlightercomponent where it's missing optional chaining when accessing context configuration, which could lead to runtime errors. This is inconsistent with theMermaidcomponent where this was handled correctly. - A leftover
console.logstatement was found in a Dumi theme file.
Overall, this is a well-executed refactoring. Once these issues are addressed, the PR should be in good shape.
packages/x/.dumi/theme/builtins/XMarkdownComponentTokenTable/index.tsx
Outdated
Show resolved
Hide resolved
Deploying ant-design-x with
|
| Latest commit: |
031684a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ec180d87.ant-design-x.pages.dev |
| Branch Preview URL: | https://feature-markdown-component.ant-design-x.pages.dev |
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. |
Bundle ReportChanges will increase total bundle size by 11.52MB (713.74%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: x-markdown-array-pushAssets Changed:
|
size-limit report 📦
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feature #1402 +/- ##
===========================================
+ Coverage 94.17% 94.37% +0.20%
===========================================
Files 140 136 -4
Lines 3860 3802 -58
Branches 1087 1084 -3
===========================================
- Hits 3635 3588 -47
+ Misses 222 211 -11
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
这个体积变化是不是有问题？ |
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log