本文档面向希望为项目做贡献或了解项目结构的开发者。
- 使用 Bun + TypeScript 开发，构建为 Node.js 兼容产物，通过 npm 发布，用户无需安装 Bun
- 用户配置存储：configstore
- 终端开发辅助库：commander.js
- 对象嵌套属性访问：dot-prop
- HTML 转 Markdown：turndown
- Node.js CLI 应用程序最佳实践
zentao-cli/
├── src/
│ ├── commands/ # 命令实现
│ ├── api/ # API 客户端（HTTP 请求封装、Token 管理）
│ ├── auth/ # 认证逻辑
│ ├── utils/ # 工具函数
│ ├── config/ # 配置管理
│ ├── types/ # TypeScript 类型定义
│ └── index.ts # 入口文件
├── tests/ # 测试
├── bin/ # CLI 入口
├── docs/ # 文档
├── scripts/ # 脚本
├── data/ # 数据文件
│ └── zentao-openapi.json # 禅道 API 2.0 规范
└── package.json使用 bun 的测试框架 bun:test 编写测试用例。
# 运行所有测试
bun test
# 运行指定测试文件
bun test tests/zentao.test.ts# 构建 npm 发布产物
bun run build
# 构建当前操作系统所属平台的单文件版本，输出到 release/
bun run build:sf
# 构建所有主流平台的单文件版本，输出到 release/
bun run build:sf -- --targets=all
# 指定目标平台和输出目录
bun run build:sf -- --targets=linux-x64,darwin-arm64 --outdir ./artifacts
# 单目标构建时指定完整输出文件
bun run build:sf -- --targets=linux-x64 --outfile ./release/zentao- 技术方案与实现细节 - 详解内部接口调用规则、验证机制与持久化配置
- 常见错误排查与参考手册 - 使用命令遇到错误（格式：Exxxx）时进行查阅
- 后续计划 - 待实现的功能和改进计划