Skip to content

docs(bubble2.0): XMarkdown #1089

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

Merged
merged 1 commit into from
Aug 3, 2025
Merged

Conversation

Div627
Copy link

@Div627 Div627 commented Aug 2, 2025

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

  • Describe the source of related requirements, such as links to relevant issue discussions.
  • For example: close #xxxx, fix #xxxx

💡 Background and Solution

  • The specific problem to be addressed.
  • List the final API implementation and usage if needed.
  • If there are UI/interaction changes, consider providing screenshots or GIFs.

📝 Change Log

Language Changelog
🇺🇸 English
🇨🇳 Chinese

Summary by CodeRabbit

重大变更

  • 移除了 Bubble、Conversations、Sender、ThoughtChain、XProvider 等主要组件及其相关文档、样例和样式,导致这些功能不再可用。
  • 项目结构调整为 Monorepo,原有包拆分为多个独立包,核心包如 @ant-design/x-card、@ant-design/x-markdown 等单独维护。
  • package.json 及 .gitignore 等配置文件大幅调整,采用 Yarn workspaces 管理多包,依赖与脚本重构。

新特性

  • 新增 @ant-design/x-card 和 @ant-design/x-markdown 两个包,分别提供基础卡片和 Markdown 渲染能力。
  • @ant-design/x-markdown 支持动画文本渲染、插件元数据生成脚本等新功能。

测试

  • 为新包补充了单元测试、快照测试和 Dekko 目录结构验证,提升包的可靠性。

构建与工具链

  • 新增并完善各包的 Father 构建配置、Jest 测试配置、TypeScript 配置等,支持多格式输出和覆盖率分析。
  • 优化 GitHub Actions 工作流,统一构建、测试、部署流程,提升 CI/CD 效率。

文档

  • 移除原有组件的中英文文档,新增或优化部分包的 README 与开发说明,便于本地开发与贡献。

其他

  • 新增脚本自动生成插件元数据与版本号,便于包管理和版本追踪。
  • 依赖精简与规范,提升整体项目可维护性和一致性。

@Div627 Div627 requested review from afc163, kimteayon and anxLiang August 2, 2025 13:13
Copy link
Contributor

github-actions bot commented Aug 2, 2025

Prepare preview

Copy link
Contributor

coderabbitai bot commented Aug 2, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

本次变更将原有的单包架构(@ant-design/x)彻底重构为多包(monorepo)架构,移除了大量旧有组件(如 Bubble、Sender、Conversations、ThoughtChain、Actions 及相关样例、文档和样式),并引入了新的 packages/x-card 与 packages/x-markdown 两个子包,包含其基础配置、测试、脚本和部分新实现。CI、构建、测试、忽略规则等均已全面适配 monorepo 结构。

Changes

Cohort / File(s) Change Summary
Monorepo 架构与配置重构
.gitignore, package.json, biome.json, .github/workflows/*, README.md, README-zh_CN.md
将项目从单包切换为 monorepo,重构工作区、脚本、依赖、CI 流程、忽略规则与文档,全部适配多包结构。
Bubble 组件及相关
components/bubble/*
完全移除 Bubble 组件、相关 hooks、样例、测试、接口定义及中英文文档。
Sender 组件及相关
components/sender/*
完全移除 Sender 组件、相关样例及中英文文档。
Conversations 组件及相关
components/conversations/*
完全移除 Conversations 组件、相关 hooks、样例、样式及中英文文档。
ThoughtChain 组件及相关
components/thought-chain/*
完全移除 ThoughtChain 组件、样例、样式及中英文文档。
Actions 组件及相关
components/actions/*
完全移除 Actions 组件、相关样例、接口定义、测试及文档。
XProvider 及上下文
components/x-provider/*
完全移除 XProvider 组件、上下文定义、样例及中英文文档。
类型与工具
components/_util/type.ts
移除 AnyObject 类型定义。
主题编辑器页面
.dumi/pages/theme-editor*
移除主题编辑器页面实现。
PeterCat 组件
.dumi/theme/common/PeterCat.tsx
移除 PeterCat 组件。
新包 x-card 基础结构
packages/x-card/*
新增 x-card 子包,包含 package.json、tsconfig、typings、Card 组件实现、测试、构建与测试配置。
新包 x-markdown 基础结构
packages/x-markdown/*
新增 x-markdown 子包,包含 package.json、tsconfig、构建与测试配置、脚本、mako 配置、动画节点组件实现及测试。

Sequence Diagram(s)

sequenceDiagram
  participant 开发者 as Developer
  participant Monorepo as Monorepo
  participant x-card as x-card
  participant x-markdown as x-markdown

  开发者->>Monorepo: 执行构建/测试脚本
  Monorepo->>x-card: 调用 workspace 脚本(build/test/lint)
  Monorepo->>x-markdown: 调用 workspace 脚本(build/test/lint)
  x-card->>x-card: 独立编译、测试、生成产物
  x-markdown->>x-markdown: 独立编译、测试、生成产物
  x-card-->>Monorepo: 返回结果
  x-markdown-->>Monorepo: 返回结果
  Monorepo-->>开发者: 汇总输出/报告
Loading

Estimated code review effort

🎯 5 (Critical) | ⏱️ ~90+ minutes

Possibly related PRs

Suggested labels

documentation, lgtm

Suggested reviewers

  • kimteayon

Poem

🐰

Monorepo 兔子跳,
旧组件挥手道。
新包初登场,
测试脚本齐上道。
结构焕然一新貌,
代码田野任我跑!

⬜️🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature_bubble_xmarkdown

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Aug 2, 2025
Copy link

codecov bot commented Aug 2, 2025

Bundle Report

Changes will increase total bundle size by 4.98kB (0.13%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antdx-array-push 240.28kB 4.98kB (2.11%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: antdx-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
antdx.min.js 4.98kB 240.28kB 2.11%

@Div627 Div627 changed the base branch from main to feat/bubble August 2, 2025 13:13
Copy link

Deploying ant-design-x with  Cloudflare Pages  Cloudflare Pages

Latest commit: eec9303
Status: ✅  Deploy successful!
Preview URL: https://837755b2.ant-design-x.pages.dev
Branch Preview URL: https://feature-bubble-xmarkdown.ant-design-x.pages.dev

View logs

Copy link

codecov bot commented Aug 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.67%. Comparing base (5ea0d33) to head (eec9303).

Additional details and impacted files
@@             Coverage Diff              @@
##           feat/bubble    #1089   +/-   ##
============================================
  Coverage        93.67%   93.67%           
============================================
  Files              113      113           
  Lines             2749     2749           
  Branches           788      788           
============================================
  Hits              2575     2575           
  Misses             172      172           
  Partials             2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 3, 2025
@kimteayon kimteayon merged commit c2a48fc into feat/bubble Aug 3, 2025
15 checks passed
@kimteayon kimteayon deleted the feature_bubble_xmarkdown branch August 3, 2025 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants