从暂存的更改(git diff --staged)生成合适的提交消息。仅生成消息并复制到剪贴板,不执行 git 命令。
Generates git commit messages from staged changes and copies to clipboard without executing commits.
/plugin marketplace add ysicing/code-pilot/plugin install ysicing-code-pilot@ysicing/code-pilot从暂存的更改(git diff --staged)生成合适的提交消息。仅生成消息并复制到剪贴板,不执行 git 命令。
/git-msg [选项]
--format <格式> : 指定消息格式(conventional, gitmoji, angular)--lang <语言> : 强制指定消息语言(en, ja)--breaking : 检测并记录 Breaking Change# 从暂存的更改生成消息(自动判定语言)
# 主要候选会自动复制到剪贴板
/git-msg
# 强制指定语言
/git-msg --lang ja
/git-msg --lang en
# 检测 Breaking Change
/git-msg --breaking
重要: 此命令仅分析暂存的更改。需要先使用 git add 暂存更改。
# 如果没有暂存更改,会显示警告
$ /git-msg
没有暂存的更改。请先执行 git add。
生成的主要候选会以 git commit -m "消息" 的完整格式自动复制到剪贴板。可以直接在终端粘贴执行。
实现注意事项:
pbcopy 时,应与消息输出分开执行printf 而不是 echo 以避免末尾换行重要: 如果存在项目特有的规范,将优先使用。
从以下文件自动检测配置:
commitlint.config.jscommitlint.config.mjscommitlint.config.cjscommitlint.config.ts.commitlintrc.js.commitlintrc.json.commitlintrc.yml.commitlintrc.yamlpackage.json 的 commitlint 部分# 搜索配置文件
find . -name "commitlint.config.*" -o -name ".commitlintrc.*" | head -1
项目特有类型示例:
// commitlint.config.mjs
export default {
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum': [
2,
'always',
[
'feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore',
'wip', // 进行中
'hotfix', // 紧急修复
'release', // 发布
'deps', // 依赖更新
'config' // 配置更改
]
]
}
}
// 项目使用中文消息时
export default {
rules: {
'subject-case': [0], // 为支持中文而禁用
'subject-max-length': [2, 'always', 72] // 为中文调整字符数限制
}
}
# 从最近的提交学习使用模式
git log --oneline -50 --pretty=format:"%s"
# 使用类型统计
git log --oneline -100 --pretty=format:"%s" | \
grep -oE '^[a-z]+(\([^)]+\))?' | \
sort | uniq -c | sort -nr
根据以下条件自动切换中文/英文:
默认为英文。判定为中文项目时生成中文消息。
<type>: <description>
重要: 必须生成单行提交消息。不生成多行消息。
注意: 如果项目有特有规范,将优先使用。
必须类型:
feat: 新功能(用户可见的功能添加)fix: 缺陷修复可选类型:
build: 构建系统或外部依赖的更改chore: 其他更改(不影响发布)ci: CI 配置文件或脚本的更改docs: 仅文档更改style: 不影响代码含义的更改(空格、格式、分号等)refactor: 既不修复缺陷也不添加功能的代码更改perf: 性能改进test: 添加或修正测试$ /git-msg
📝 提交消息建议
━━━━━━━━━━━━━━━━━━━━━━━━━
✨ 主要候选:
feat: implement JWT-based authentication system
📋 备选方案:
1. feat: add user authentication with JWT tokens
2. fix: resolve token validation error in auth middleware
3. refactor: extract auth logic into separate module
✅ `git commit -m "feat: implement JWT-based authentication system"` 已复制到剪贴板
实现示例(修正版):
# 先将提交命令复制到剪贴板(无换行)
printf 'git commit -m "%s"' "$COMMIT_MESSAGE" | pbcopy
# 然后显示消息
cat << EOF
📝 提交消息建议
━━━━━━━━━━━━━━━━━━━━━━━━━
✨ 主要候选:
$COMMIT_MESSAGE
📋 备选方案:
1. ...
2. ...
3. ...
✅ `git commit -m "$COMMIT_MESSAGE"` 已复制到剪贴板
EOF
$ /git-msg
📝 提交消息建议
━━━━━━━━━━━━━━━━━━━━━━━━━
✨ 主要候选:
feat: 实现 JWT 认证系统
📋 备选方案:
1. feat: 添加基于 JWT 令牌的用户认证
2. fix: 解决认证中间件的令牌验证错误
3. refactor: 将认证逻辑提取到独立模块
✅ `git commit -m "feat: 实现 JWT 认证系统"` 已复制到剪贴板
git diff --staged 的内容注意: 此命令不执行 git add 或 git commit。仅生成提交消息并复制到剪贴板。
featfixtestchoredocs.gitmessage 文件CONTRIBUTING.md 中的规范# 判定基准(优先级)
1. 从 git diff --staged 的内容判定语言
2. 暂存文件的注释分析
3. git log --oneline -20 的语言分析
4. 项目主要语言设置
分析使用的信息(仅读取):
git diff --staged --name-only - 更改文件列表git diff --staged - 实际更改内容git status --porcelain - 文件状态当有 API 破坏性更改时:
英文:
feat!: change user API response format
BREAKING CHANGE: user response now includes additional metadata
或
feat(api)!: change authentication flow
中文:
feat!: 更改用户 API 响应格式
BREAKING CHANGE: 响应现在包含额外的元数据
或
feat(api)!: 更改认证流程
英文:
feat: add user registration endpoint
fix: resolve memory leak in cache manager
docs: update API documentation
中文:
feat: 添加用户注册端点
fix: 解决缓存管理器内存泄漏
docs: 更新 API 文档
# 与暂存更改结合使用
git add -p # 交互式暂存
/git-msg
"生成最优的提交消息"
# 仅暂存特定文件后分析
git add src/auth/*.js
/git-msg --lang en
"为认证相关更改生成合适的消息"
# Breaking Change 检测和应对
git add -A
/git-msg --breaking
"如有破坏性更改请适当标记"
git add 暂存