smart-commit-gen 是一个 Git 提交信息辅助工具,核心目标是分析当前 git diff,自动生成符合 Conventional Commits 规范的 commit message,并智能检测 scope。
用途与主要能力: 工具会从改动中推断提交类型(feat / fix / docs / style / refactor / test / chore / perf / ci / build)、从文件路径检测作用域(如 auth、api、ui 等),并基于变更统计生成简要描述,最终组装成完整 commit message。脚本对 test、docs、ci、build 等类型的检测较准确;对于修改已有源代码文件的情况(feat、fix、refactor 之间的区分),需要用户阅读 diff 内容后自行判断。输出结果可审查后通过参数覆盖类型或作用域,描述建议根据实际改动手写。
使用方式: 在 git 仓库中运行脚本,常用命令包括:
- 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(JSON 输出,便于程序集成)
- python3 scripts/analyze_diff.py --staged --type-override feat --scope-override auth(手动覆盖 type 或 scope)
参数方面:--repo 指定 Git 仓库路径,默认当前目录;--staged 仅分析已暂存改动,默认否;--format 可选 text 或 json,默认 text;--type-override 和 --scope-override 用于手动指定,跳过自动检测。
规范参考: 生成的提交信息遵循 <type>(<scope>): <description> 格式,可附加 body 和 footer。若包含不兼容变更,在 type 后加 !,例如 feat(api)!: change authentication endpoint response format。
适用场景与限制: 适合需要统一提交信息风格、快速生成规范 commit message 的开发者,也可通过 JSON 输出集成到自动化流程中。使用前置条件为 Python 3.6+、已安装 git 并在 PATH 中,当前目录或 --repo 需指向有效的 git 仓库。自动推断的类型和描述仅作参考,最终提交信息需结合 diff 实际语义审查调整。