git-msg

提交消息

从暂存的更改（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 以避免末尾换行

项目规范自动检测

重要: 如果存在项目特有的规范，将优先使用。

1. CommitLint 配置检查

从以下文件自动检测配置：

• commitlint.config.js
• commitlint.config.mjs
• commitlint.config.cjs
• commitlint.config.ts
• .commitlintrc.js
• .commitlintrc.json
• .commitlintrc.yml
• .commitlintrc.yaml
• package.json 的 commitlint 部分

# 搜索配置文件
find . -name "commitlint.config.*" -o -name ".commitlintrc.*" | head -1

2. 自定义类型检测

项目特有类型示例：

// 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'    // 配置更改
      ]
    ]
  }
}

3. 语言设置检测

// 项目使用中文消息时
export default {
  rules: {
    'subject-case': [0],  // 为支持中文而禁用
    'subject-max-length': [2, 'always', 72]  // 为中文调整字符数限制
  }
}

4. 现有提交历史分析

# 从最近的提交学习使用模式
git log --oneline -50 --pretty=format:"%s"

# 使用类型统计
git log --oneline -100 --pretty=format:"%s" | \
grep -oE '^[a-z]+(\([^)]+\))?' | \
sort | uniq -c | sort -nr

语言自动判定

根据以下条件自动切换中文/英文：

1. CommitLint 配置中的语言设置
2. git log 分析的自动判定
3. 项目文件的语言设置
4. 更改文件中的注释和字符串分析