| name | msg |
| description | 根据 git 缓存区(staged)内容生成中文提交消息草稿。无参数时只看缓存区、不执行 git add;带参数 `/msg X` 时先把与 X 相关的改动 `git add` 到缓存区,再生成消息草稿。始终不执行 git commit。 |
/msg — 生成 Git 提交消息草稿
铁律
- 不执行 git commit:只输出消息草稿,等待用户决定是否提交
- 中文:提交消息全程使用中文
- 禁止
git add -A / git add . / git add --all:只按明确的路径列表添加
- 消息文件必须写入
/tmp/:禁止用 Write 工具写入项目目录;必须用 Bash 写入绝对路径 /tmp/gitmsg_*.txt
- 分支模式:
- 无参数
/msg:只分析 git diff --cached,完全忽略未缓存的修改,不执行 git add
- 带参数
/msg X:先把与 X 相关的改动加入缓存区,再按无参数流程生成消息
带参数模式 /msg X 的执行步骤
- 运行
git status --short 查看当前所有未缓存/已缓存的改动
- 解析参数 X,确定要加入缓存区的文件列表:
- X 是存在的文件或目录路径(
ls/test -e 能命中)→ 直接 git add <X>
- X 是主题关键词(如
标注修复、日志、skill)→ 从 git status 的未缓存列表中挑出与主题相关的文件,显式列出每一个路径,再执行 git add <path1> <path2> ...
- 向用户展示:"本次将加入缓存的文件:" + 路径清单
- 执行
git add <明确路径列表>(禁止 -A/./--all)
- 运行
git diff --cached --stat 确认缓存区内容
- 转入"生成消息"步骤(与无参数模式相同)
生成消息步骤(两种模式共用)
- 运行
git diff --cached --stat 查看缓存文件列表
- 运行
git diff --cached 查看具体改动内容
- 运行
git log --oneline -5 了解本项目的 commit message 风格
- 撰写中文提交消息草稿,以代码块形式展示
- 生成唯一临时文件名:
/tmp/gitmsg_<YYYYmmdd_HHMMSS>_<sha6>.txt,其中 sha6 取 git diff --cached 内容的 sha256 前 6 位
- 将消息写入该临时文件
- 输出可直接执行的 git commit 命令
消息格式
首行:一句话总结(≤50字,说明做了什么)
模块A:
- 新增/更新/修复/删除 具体内容
模块B:
- ...
- 首行说"做了什么",不写版本号
- 按目录/模块分组
- 区分"新增"、"更新"、"修复"、"删除"
输出后
- 展示消息草稿(代码块)
- 用 Bash 一步生成文件名并写入(必须用 Bash,禁止用 Write 工具):
python3 - << 'PYEOF'
import hashlib, subprocess, datetime, sys
diff = subprocess.check_output(['git', 'diff', '--cached'])
h = hashlib.sha256(diff).hexdigest()[:6]
ts = datetime.datetime.now().strftime('%Y%m%d_%H%M%S')
path = f'/tmp/gitmsg_{ts}_{h}.txt'
with open(path, 'w') as f:
f.write(sys.stdin.read())
print(path)
PYEOF
实际执行时,将消息正文通过 heredoc 或字符串直接传入,确保路径始终为 /tmp/gitmsg_*.txt。
最简方式:
MSGFILE=/tmp/gitmsg_$(date +%Y%m%d_%H%M%S)_$(git diff --cached | sha256sum | cut -c1-6).txt
cat > "$MSGFILE" << 'EOF'
<消息正文>
EOF
echo "$MSGFILE"
- 输出提交命令供用户一键复制执行:
git commit -F /tmp/gitmsg_<YYYYmmdd_HHMMSS>_<sha6>.txt
(用实际生成的文件名替换占位符)
不主动执行 commit,不主动询问。