SuperAPI AI 工具集

smart-git-commit

通用与其它

查看项目

更新于 10-16 05:43

技能介绍

用途:Smart Git Commit 用于创建格式规范的 git 提交,提交信息采用 conventional commit 格式并带 emoji,同时可在提交前自动运行代码检查。

主要能力:默认先运行预提交检查,包括 pnpm lint(代码质量)、pnpm build(验证构建成功)、pnpm generate:docs(更新文档),检查失败会询问是继续还是先修复。随后分析暂存状态:已有暂存文件时只提交这些文件,没有暂存文件时自动暂存所有修改和新增文件。再通过 git diff --cached 分析改动,判断提交类型(feat、fix、docs、refactor 等)以及是否包含多个独立改动,并在合适时建议拆分提交。提交信息格式为 <emoji> <type>: <description>。

使用方式:基本调用 /smart-git-commit 自动生成信息;/smart-git-commit "add user authentication" 提供自定义描述;/smart-git-commit --no-verify 跳过预提交检查;/smart-git-commit --amend 修订上一次提交。

提交类型示例:feat ✨ 新功能、fix 🐛 修复、docs 📝 文档、style 💄 格式、refactor ♻️ 重构、perf ⚡️ 性能、test ✅ 测试、chore 🔧 工具配置、ci 🚀 CI/CD。

拆分建议:当改动涉及不同关注点、不同提交类型、源码与文档与测试混杂、或改动规模过大时,考虑拆分为多个提交。

最佳实践:每个提交只做一件事;使用现在时(如 add feature);首行不超过 72 字符;提交前核对 diff 与信息是否一致。

限制:资料未说明具体支持哪些平台或运行时环境;预提交命令为 pnpm 脚本,若项目未提供相应脚本可能无法执行。详细 emoji/类型参考见 commit-types.md,拆分示例见 examples.md。