SuperAPI AI 工具集

conventional-commit-gen

编程与开发

查看项目

更新于 11-06 16:19

技能介绍

用途

Conventional Commit Gen 用于分析当前 git diff,并自动生成符合 Conventional Commits 规范的提交信息,支持智能范围(scope)检测与提交类型推断,适合需要规范提交记录的开发工作流。

主要能力

  • 分析未暂存或已暂存的变更,生成提交信息。
  • 根据文件路径自动检测 scope(如 auth、api、ui)。
  • 根据文件路径与变更统计推断提交类型,涵盖 feat、fix、docs、style、refactor、test、chore、perf、ci、build。
  • 输出 type、scope、description 与完整 commit_message,可选用 text 或 json 格式。
  • 支持通过参数手动覆盖 type 和 scope。
  • 支持指定仓库路径。

使用方式

快速开始:

python3 scripts/analyze_diff.py
python3 scripts/analyze_diff.py --staged
python3 scripts/analyze_diff.py --repo /path/to/repo
python3 scripts/analyze_diff.py --staged --format json
python3 scripts/analyze_diff.py --staged --type-override feat --scope-override auth

参数包括:--repo(仓库路径,默认 .)、--staged(仅分析已暂存变更)、--format(text 或 json,默认 text)、--type-override(手动指定类型)、--scope-override(手动指定范围)。

建议流程:先运行脚本获取自动分析结果,再检查并调整;若类型不准确可用 --type-override 覆盖,范围不合适可用 --scope-override 覆盖;描述最好结合实际变更手写,脚本输出可作为起点。对于源码文件修改中 feat、fix、refactor 的区分,建议阅读 diff 内容后做最终判断。

提交信息格式为:<type>(<scope>): <description>,可选 body 与 footer;破坏性变更在类型后加 !,例如 feat(api)!: change authentication endpoint response format。

适用场景

适用于在 git 仓库中提交前快速生成规范提交信息,或通过 JSON 输出集成到程序化流程中。

限制

需要 Python 3.6+,且 git 已安装并可在 PATH 中调用;当前目录或 --repo 必须指向有效的 git 仓库。类型自动检测基于文件路径与变更统计,对源码文件修改的类型判断可能不准确,需人工复核。