用途:分析已暂存的 git 变更,生成符合 Conventional Commits 1.0.0 规范的提交信息,自动完成类型分类、范围识别与破坏性变更标注。
主要能力:支持 feat、fix、docs、style、refactor、test、chore、perf、ci、build 类型;通过暂存文件与代码差异推断 scope(如 auth、api、cli、db);检测破坏性变更(公共 API 移除、函数签名变更、导出重命名、schema 迁移);并可参考近期提交历史匹配项目风格。
使用方式:先运行 git diff --cached --stat 查看变更概览,再运行 git diff --cached 查看具体改动;按变更性质分类类型,确定 scope,检查破坏性变更(可用 git log --oneline -10 比对历史风格),最后按 type(scope): 祈使句描述(72 字符以内)格式构造信息,必要时补充说明 why 的正文与 BREAKING CHANGE 页脚。触发语句如“create commit message”“generate smart commit”“分析暂存改动并生成规范提交信息”。
适用场景:需要统一提交信息风格的仓库、生成语义化版本发布记录、审查 API 破坏性变更时。
限制与前提:需已初始化 git 仓库、至少暂存一个文件、配置 user.name 与 user.email,并了解项目既有提交约定。常见问题:无暂存变更需先 git add;非 git 仓库需 git init 或进入仓库根目录;变更跨多类别时建议拆分提交或以主要意图归类;scope 不明时可省略;描述超长时精简并移入正文。具体支持的命令参数与自动化程度暂未提供。