ac-checker
v1.0.0
Published
A Git commit hook tool for checking if commit content meets Jira Acceptance Criteria using Chinese LLMs
Downloads
14
Maintainers
Readme
AC Checker
一个配合 husky 使用的 git 提交检测工具,用于检查提交内容是否符合 Jira 卡片的验收标准(AC),支持大模型智能检测。
功能特点
- 检测 git commit message 是否符合自定义格式(默认:
feat(#jira-卡号)或feature(#jira-卡号)) - 自动从 Jira 获取对应卡片的验收标准(AC)
- 使用大模型(DeepSeek/豆包/通义千问)智能检测提交内容是否符合验收标准
- 在控制台输出详细的检测结果和分析
安装
在项目中安装
# 使用 pnpm
pnpm add ac-checker -D
# 使用 npm
npm install ac-checker --save-dev
# 使用 yarn
yarn add ac-checker --dev全局安装
# 使用 pnpm
pnpm add ac-checker -g
# 使用 npm
npm install ac-checker -g
# 使用 yarn
yarn add ac-checker -g配置
1. 复制配置文件示例(第三方项目中)
在使用 ac-checker 的项目中,你需要先创建配置文件:
# 从包中复制配置文件示例
cp node_modules/ac-checker/ac-checker.config.json.example ac-checker.config.json
# 或者手动创建
cat > ac-checker.config.json << 'EOF'
{
"jira": {
"baseUrl": "https://your-jira-instance.atlassian.net",
"cookie": "JSESSIONID=3462D9E4E1723AEB530063809FC58FB1"
},
"ai": {
"baseUrl": "https://api.siliconflow.cn/v1",
"apiKey": "your-api-key",
"model": "Qwen/Qwen3-8B", // 根据提供商选择合适的模型
"temperature": 0.3
},
"commit": {
"triggerTypes": ["feat", "feature"] // 自定义触发 AC 检测的提交类型
}
}
EOF使用方法
当你执行 git commit 命令时,如果:
- 项目中存在
ac-checker.config.json配置文件 - commit message 符合配置的触发格式
工具会自动:
- 从 Jira 获取对应卡片的验收标准
- 获取本次提交的修改内容
- 使用大模型智能分析提交内容是否符合验收标准
- 在控制台输出详细的检测结果
如果项目中没有 ac-checker.config.json 配置文件,工具会自动跳过检测,不会影响提交流程。
示例
git commit -m "feature(#DFIQ-1110) 实现用户登录功能"