跳转到主要内容
公共包源码与发包流程在 magic-resume-kit。本页中的 schema、模板、设计系统、图标、utils 和 MCP 源码路径及构建命令均相对此仓库;应用通过 npm 使用 @magic-resume-kit/*,不再包含这些工作区。 克隆 Magic-Resume 仓库并运行 pnpm install 后,在仓库根目录跑 pnpm run dev 会通过 Turbo 并行启动每个 workspace 的 dev。完整的质量检查使用 pnpm run lint 和 pnpm run test。 还没装好的话,从 自托管 开始。

仓库目录是什么结构?

怎么配置开发编辑器?

整个仓库是 TypeScript。推荐的编辑器组合:
  • VS Code + ESLint + TypeScript Nightly,或
  • Cursor / Windsurf / Claude Code —— 三者都会读取 CLAUDE.md 和 workspace 的 TS 配置。
pnpm-workspace.yaml 和 packages/tsconfig 一起让跨 workspace 的类型推导开箱即用。如果编辑器找不到类型,重启 TS 服务器。

跨 workspace 的热更新如何工作?

仓库根目录跑 pnpm run dev 会通过 Turbo 并行启动每个 workspace 的 dev。多数 workspace 用 watch 模式: 公共包改动需要在 magic-resume-kit 构建、发布后更新本仓库的固定版本;不再通过本地 workspace link 自动更新。
Next.js 16 的 dev 默认使用 Turbopack;需要 Webpack 时运行 pnpm --filter @magic-resume/web dev:webpack。

提交前怎么运行 lint 和测试?

lint-staged(在根 package.json 配置,由 Husky 触发)会对暂存文件跑一部分检查。完整的扫一遍:
apps/web workspace 有个 i18n 检查会在暂存 .tsx/.ts 时触发:
它确保每个新增的翻译 key 都同时存在于每种语言里。en.json 加了 key 但 zh-CN.json 没加,会让 pre-commit hook 失败。

分支和 Commit 有哪些约定?

默认分支是 master。功能分支用 <type>/<short-name>(如 feat/turborepo-mcp-migration-wip)。Commit 遵循 conventional commits 风格 —— 看 git log 就能知道格式。