Cherry Markdown 项目中的 Yarn Monorepo 实践与优化

在 Cherry Markdown 项目中，我们采用 Yarn Monorepo 架构来管理多个相关包，包括核心编辑器、客户端应用、VSCode 插件等。这种架构带来了显著的开发效率提升，同时也引入了一些需要解决的技术挑战。

包管理工具的统一与限制

为了确保开发环境的一致性，我们通过 Corepack 强制使用 Yarn 作为包管理工具。虽然 Corepack 是 Node.js 提供的全局解决方案，但它可能会影响到其他项目。我们正在探索更精细的控制方案，比如通过预提交钩子或自定义脚本来验证包管理工具的使用。

工作区依赖管理

Yarn Workspace 提供了基本的 Monorepo 支持，但在处理本地包依赖时存在局限性。我们通过以下方式优化了依赖关系：

1. 为本地核心包创建软链接，确保开发时能直接引用本地代码
2. 构建时自动加载 dist 目录，保证生产环境的正确引用
3. 统一客户端应用的包管理器配置，全部迁移到 Yarn

自动化工作流改进

我们构建了一套完整的自动化工作流来提升开发体验：

代码提交规范

引入 commitlint 来强制执行统一的提交消息格式，这有助于生成更有意义的变更日志。

变更日志管理

采用 changesets 工具来自动收集和发布变更日志：

• 配置自动化 CI 流程，在发布时生成标准化的 CHANGELOG
• 通过机器人检查 PR 是否包含必要的变更集描述
• 发布时自动同步根目录的 README 等文档到核心包目录
• 对齐历史 CHANGELOG 与 changeset 生成的日志格式

持续集成与部署

重构了 CI 流程以支持：

• 多 Node.js 版本构建测试
• PR 预览环境的自动部署与清理
• 测试版 npm 包的自动发布
• VSCode 插件预览包的生成与发布
• 多平台客户端应用的构建与发布
• 版本发布后的 GitHub Pages 自动部署

开发体验优化

我们针对开发者体验做了多项改进：

• 调整分支策略，使用 dev 作为默认开发分支
• 清理 yarn.lock 文件，移除代理配置
• 重构示例项目，更新 HTML 文件的引用路径
• 补充 React 和 Vue 的示例实现
• 优化 VSCode 插件的 TypeScript 支持

未来规划

虽然当前 Monorepo 架构已经基本完善，我们仍有一些优化方向：

• 实现开发模式下代码热更新，避免手动刷新
• 探索更精细的包管理工具限制方案
• 完善 PR 预览功能
• 优化开发服务器的依赖关系

通过这一系列改进，Cherry Markdown 项目的开发流程变得更加高效和可靠，为后续功能开发和社区贡献奠定了坚实的基础。