Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.14 KB

development.md

File metadata and controls

81 lines (59 loc) · 3.14 KB

开发指引

本文档面向希望为项目做贡献或了解项目结构的开发者。

技术栈

项目结构

zentao-cli/
├── src/
│   ├── commands/           # 命令实现
│   ├── api/                # API 客户端(HTTP 请求封装、Token 管理)
│   ├── auth/               # 认证逻辑
│   ├── utils/              # 工具函数
│   ├── config/             # 配置管理
│   ├── types/              # TypeScript 类型定义
│   └── index.ts            # 入口文件
├── tests/                  # 测试
├── bin/                    # CLI 入口
├── docs/                   # 文档
├── scripts/                # 脚本
└── package.json

测试

使用 bun 的测试框架 bun:test 编写测试用例。

# 运行所有测试
bun test

# 运行指定测试文件
bun test tests/module-handler.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

# 生成 WorkBuddy 的 CLI + Skill 连接器资源包
bun run build:workbuddy

WorkBuddy 连接器的浏览器登录、本地预览与发布前校验见 连接器说明。

更多技术文档

完整的用户命令参考提供 Markdown 版本 和 可搜索的 HTML 版本。HTML 是单文件页面,可直接用浏览器打开,无需启动服务。更新命令或升级 zentao-api 后,运行以下命令同时同步两种格式,并检查文档是否过期:

bun run scripts/generate-command-reference.ts
bun run scripts/generate-command-reference.ts --check

用法与场景示例维护在 docs/command-guide.md;生成标记之后的内容来自共享命令契约与实际 Commander 命令树。HTML 页面模板位于 scripts/command-reference.template.html,与 Markdown 共用同一份正文。生成过程只读取离线帮助,不访问禅道服务。