开发指南

配置开发环境

本项目需要的环境如下

  • Git
  • Node.js v26+
  • pnpm(使用项目根目录 package.json 的 packageManager 指定版本,当前为 11.3.0)
  • Rust, Cargo v1.88+

推荐使用 Zed 或 VSCode 作为代码编辑器,不建议使用 WebStorm 和 RustRover

获取代码和安装依赖

gh repo clone graphif/project-graph
cd project-graph
pnpm install

启动开发环境

pnpm dev

请在项目根目录运行。此命令启动 Tauri 桌面开发环境,并由 Tauri 自动启动 Vite、等待 http://localhost:1420 就绪,无需另开终端启动前端。

如果只需要前端开发服务,可以运行 pnpm --filter @graphif/project-graph dev;本地文件等桌面能力仍需要 Tauri 环境。

按 Ctrl + Shift + I 可以打开开发者工具

验证更改

pnpm --filter @graphif/project-graph type-check
pnpm lint
pnpm test

日常验证使用类型检查及相关 lint、测试,无需构建安装包。

提交更改

Commit message 需遵守 Conventional Commits 规范,可用的 type 有:

  • feat: 加入新功能
  • fix: 修复 bug
  • docs: 文档更改
  • chore: 其他所有用户感知不到的更改

Git 合并分支规范

  1. 确保本地 master 和远端 master 一致。
  2. 在自己分支 feat/example 执行 git rebase master
  3. git push --force
  4. git checkout master
  5. 若此时远端 master 更新了,执行 git pull --rebase
  6. git merge --ff-only feat/example
  7. git push

On this page