根据 git diff 信息 生成符合 Conventional Commits 的提交信息.
npm install @ckpack/ai-commit使用 Codex 根据 git diff 生成符合 Conventional Commits 的提交信息。
- 读取暂存区或工作区 diff(优先暂存区)
- 自动忽略常见锁文件与日志文件
- 生成单行 commit message,长度不超过 50 个字符
- Codex 失败时自动回退为本地摘要
``bash`
pnpm add -D @ckpack/ai-commit
或全局安装:
`bash`
pnpm add -g @ckpack/ai-commit
在包含变更的 git 仓库中运行:
`bash`
ai-commit codex
输出示例:
``
feat: add commit message generator
你也可以直接调用源码(开发时):
`bash`
pnpm dev -- codex
- CODEX_BIN:Codex 可执行文件名,默认 codexCODEX_ARGS
- :传给 Codex 的参数,默认 exec
示例:
`bash`
CODEX_BIN=codex CODEX_ARGS="exec" ai-commit codex
- 优先读取 git diff --staged,为空则读取 git diff/*.log
- 默认忽略:、/pnpm-lock.yaml、/package-lock.json、/yarn.locktype(scope?): description
- 生成的消息需匹配 Conventional Commits:
,描述不超过 50 个字符chore: update
- Codex 返回异常或不符合规范时,回退为
`bash``
pnpm dev # 运行源码
pnpm build # 构建 dist
pnpm typecheck # TS 类型检查
pnpm lint # 修复 lint
MIT