使用 ChatGPT 生成 git message

介绍#

cz-git 是一个基于 commitlint 的交互式 git 提交命令行工具, 支持利用 AI 🤖 辅助生成提交信息

安装#

1
pnpm i -g commitizen # 全局安装 commitizen
2
pnpm i -D cz-git @commitlint/{cli,config-conventional} # 在项目中安装 cz-git / commitlint

TIP
也可全局安装 cz-git, 参考全局安装

在 package.json 中增加:

1
{
2
  "config": {
3
    "commitizen": {
4
      "path": "node_modules/cz-git"
5
    }
6
  }
7
}

创建 commitlint 的配置文件 commitlint.config.ts:

1
import type { UserConfig } from 'cz-git'
2

3
const config: UserConfig = {
4
  extends: ['@commitlint/config-conventional'],
5
  prompt: {
6
      alias: { fd: 'docs: fix typos' },
7
      messages: {
8
          type: '选择你要提交的类型 :',
9
          scope: '选择一个提交范围（可选）:',
10
          customScope: '请输入自定义的提交范围 :',
11
          subject: '填写简短精炼的变更描述 :\n',
12
          body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
13
          breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
14
          footerPrefixesSelect: '选择关联issue前缀（可选）:',
15
          customFooterPrefix: '输入自定义issue前缀 :',
16
          footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
17
          confirmCommit: '是否提交或修改commit ?',
18
      },
19
      types: [
20
          { value: 'feat', name: 'feat:     新增功能 | A new feature' },
21
          { value: 'fix', name: 'fix:      修复缺陷 | A bug fix' },
22
          { value: 'docs', name: 'docs:     文档更新 | Documentation only changes' },
23
          { value: 'style', name: 'style:    代码格式 | Changes that do not affect the meaning of the code' },
24
          { value: 'refactor', name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature' },
25
          { value: 'perf', name: 'perf:     性能提升 | A code change that improves performance' },
26
          { value: 'test', name: 'test:     测试相关 | Adding missing tests or correcting existing tests' },
27
          { value: 'build', name: 'build:    构建相关 | Changes that affect the build system or external dependencies' },
28
          { value: 'ci', name: 'ci:       持续集成 | Changes to our CI configuration files and scripts' },
29
          { value: 'revert', name: 'revert:   回退代码 | Revert to a commit' },
30
          { value: 'chore', name: 'chore:    其他修改 | Other changes that do not modify src or test files' },
31
      ],
32
      useEmoji: false,
33
      emojiAlign: 'center',
34
      useAI: false,
35
      aiNumber: 1,
36
      themeColorCode: '',
37
      scopes: [],
38
      allowCustomScopes: true,
39
      allowEmptyScopes: true,
40
      customScopesAlign: 'bottom',
41
      customScopesAlias: 'custom',
42
      emptyScopesAlias: 'empty',
43
      upperCaseSubject: false,
44
      markBreakingChangeMode: false,
45
      allowBreakingChanges: ['feat', 'fix'],
46
      breaklineNumber: 100,
47
      breaklineChar: '|',
48
      skipQuestions: [],
49
      issuePrefixes: [
50
      // 如果使用 gitee 作为开发管理
51
          { value: 'link', name: 'link:     链接 ISSUES 进行中' },
52
          { value: 'closed', name: 'closed:   标记 ISSUES 已完成' },
53
      ],
54
      customIssuePrefixAlign: 'top',
55
      emptyIssuePrefixAlias: 'skip',
56
      customIssuePrefixAlias: 'custom',
57
      allowCustomIssuePrefix: true,
58
      allowEmptyIssuePrefix: true,
59
      confirmColorize: true,
60
      scopeOverrides: undefined,
61
      defaultBody: '',
62
      defaultIssues: '',
63
      defaultScope: '',
64
      defaultSubject: '',
65
  },
66
}
67

68
export default config

更多配置规则可参考配置文件 - commitlint

AI 生成提交信息#

WARNING
涉密项目建议使用本地或内部大模型, 防止源码泄露

cz-git 支持 OpenAI 或与 OpenAI 兼容的 API

1
pnpm i -D cross-env czg # 建议作为项目依赖使用, 同样是为了防止源码泄露

在 package.json 中增加 cz:

1
{
2
  "scripts": {
3
    "cz": "cross-env NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning' czg"
4
  }
5
}

TIP
由于我们的配置文件(commitlint.config.ts), 所以需要加入 实验性参数, 详见 TypeScript 模板

修改配置文件 commitlint.config.ts 以启用 AI 生成功能:

1
import type { UserConfig } from 'cz-git'
2

3
const config: UserConfig = {
4
  // ...
5
  useAI: true,
6
  aiModel: 'gpt-4o-mini',
7
  aiNumber: 6, // 生成 6 条信息提供给我们选择
8
}

设置好 API 地址和 API key, 设置好后会写入 ~/.czrc 文件中

1
pnpm run cz ai --api-endpoint=https://<your-path>/v1
2
pnpm run cz ai --api-key=<your-api-key>

我们来尝试一下:

1
git add -A
2
pnpm run cz ai
3

4
? 选择你要提交的类型 : feat:     新增功能 | A new feature
5
ℹ Generating your AI commit subject...
6
? Select suitable subject by AI generated: update TypeScript formatter to Prettier and enhance commitlint config
7

8
###--------------------------------------------------------###
9
feat: update TypeScript formatter to Prettier and enhance commitlint config
10
###--------------------------------------------------------###
11

12
? 是否提交或修改commit ? Modify and additional message with prompt

默认输出的是英文, 我们可以在 commitlint.config.ts 添加 prompt 来约束生成的提交信息:

1
import type { UserConfig } from 'cz-git'
2

3
const config: UserConfig = {
4
  // ...
5
  useAI: true,
6
  aiModel: 'gpt-4o-mini',
7
  aiNumber: 6,
8
  aiQuestionCB({ maxSubjectLength, diff }) {
9
    return `用完整句子为以下 Git diff 代码写一个有见解并简洁的 Git 中文提交消息，不加任何前缀，并且内容不能超过 ${maxSubjectLength} 个字符: \`\`\`diff\n${diff}\n\`\`\``
10
  },
11
}

最后, 我们再次提交:

1
pnpm run cz ai
2

3
> fuwari@0.0.1 cz /Users/xxx/projects/blog.xiaban.run
4
> cross-env NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning' czg "ai"
5

6
czg@1.11.0
7

8
? 选择你要提交的类型 : feat:     新增功能 | A new feature
9
ℹ Generating your AI commit subject...
10
? Select suitable subject by AI generated: Use arrow keys or type to search
11
❯ 更新 TypeScript 的默认格式化工具为 Prettier，并调整 commitlint 配置以增强提交提示信息，同时添加 cross-env 和 czg 依赖
12
  更新 VSCode TypeScript 格式化工具为 Prettier，调整 commitlint 配置以支持更多提交类型，并添加 cross-env 依赖，优化项目构建配置
13
  更新 TypeScript 格式化工具为 Prettier，调整 commitlint 配置以支持更多类型，并添加 cross-env 依赖以优化环境变量设置
14
  更新 VSCode 配置以使用 Prettier 作为 TypeScript 的默认格式化工具，同时优化 commitlint 配置，新增支持的提交类型和依赖项
15
  更新 Visual Studio Code 的 TypeScript 格式化工具为 Prettier，并优化 commitlint 配置，增加对自定义问题前缀的支持
16
  修改了 VSCode 的 TypeScript 默认格式化工具为 Prettier，并更新了 commitlint 配置以支持更多提交类型，同时添加了 cross-env 和 czg 依赖
17

18
###--------------------------------------------------------###
19
feat: 更新 TypeScript 的默认格式化工具为 Prettier，并调整 commitlint 配置以增强提交提示信息，同时添加 cross-env 和 czg 依赖
20
###--------------------------------------------------------###
21

22
? 是否提交或修改commit ? Yes
23
[main cacbaf8] feat: 更新 TypeScript 的默认格式化工具为 Prettier，并调整 commitlint 配置以增强提交提示信息，同时添加 cross-env 和 czg 依赖
24
 8 files changed, 248 insertions(+), 61 deletions(-)
25
 create mode 100644 src/content/posts/2025/assets/images/cz-git-openai.gif
26
 create mode 100644 src/content/posts/2025/assets/images/cz-git-screenshot.gif

完结撒花 ❤️

20250-03-09 更新#

commitlint 对于 ts 文件的支持不太行 😡, 所以将文件名改回了 commitlint.config.mjs, 又加入了自定义的 tag WIP, 完整代码如下:

1
// import { RuleConfigSeverity } from 'commitlint'
2
import { defineConfig } from 'cz-git'
3

4
const config = defineConfig({
5
  extends: ['@commitlint/config-conventional'],
6
  rules: {
7
    'type-enum': [
8
      2,
9
      'always',
10
      [
11
        'build',
12
        'chore',
13
        'ci',
14
        'docs',
15
        'feat',
16
        'fix',
17
        'perf',
18
        'refactor',
19
        'revert',
20
        'style',
21
        'test',
22
        'WIP',
23
      ],
24
    ],
25
    'type-case': [0], // 禁用类型大小写检查
26
  },
27
  prompt: {
28
    alias: { fd: 'docs: fix typos' },
29
    messages: {
30
      type: '选择你要提交的类型 :',
31
      scope: '选择一个提交范围（可选）:',
32
      customScope: '请输入自定义的提交范围 :',
33
      subject: '填写简短精炼的变更描述 :\n',
34
      body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
35
      breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
36
      footerPrefixesSelect: '选择关联issue前缀（可选）:',
37
      customFooterPrefix: '输入自定义issue前缀 :',
38
      footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
39
      confirmCommit: '是否提交或修改commit ?',
40
    },
41
    types: [
42
      { value: 'feat', name: 'feat:     新增功能 | A new feature' },
43
      { value: 'fix', name: 'fix:      修复缺陷 | A bug fix' },
44
      { value: 'WIP', name: 'WIP:      暂未完成 | Not yet completed' },
45
      {
46
        value: 'docs',
47
        name: 'docs:     文档更新 | Documentation only changes',
48
      },
49
      {
50
        value: 'style',
51
        name: 'style:    代码格式 | Changes that do not affect the meaning of the code',
52
      },
53
      {
54
        value: 'refactor',
55
        name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature',
56
      },
57
      {
58
        value: 'perf',
59
        name: 'perf:     性能提升 | A code change that improves performance',
60
      },
61
      {
62
        value: 'test',
63
        name: 'test:     测试相关 | Adding missing tests or correcting existing tests',
64
      },
65
      {
66
        value: 'build',
67
        name: 'build:    构建相关 | Changes that affect the build system or external dependencies',
68
      },
69
      {
70
        value: 'ci',
71
        name: 'ci:       持续集成 | Changes to our CI configuration files and scripts',
72
      },
73
      { value: 'revert', name: 'revert:   回退代码 | Revert to a commit' },
74
      {
75
        value: 'chore',
76
        name: 'chore:    其他修改 | Other changes that do not modify src or test files',
77
      },
78
    ],
79
    useEmoji: false,
80
    emojiAlign: 'center',
81
    useAI: true,
82
    aiNumber: 6,
83
    aiModel: 'gpt-4o-mini',
84
    aiQuestionCB({ maxSubjectLength, diff }) {
85
      return `用完整句子为以下 Git diff 代码写一个有见解并简洁的 Git 中文提交消息，不加任何前缀，并且内容不能超过 ${maxSubjectLength} 个字符: \`\`\`diff\n${diff}\n\`\`\``
86
    },
87
    themeColorCode: '',
88
    scopes: [],
89
    allowCustomScopes: true,
90
    allowEmptyScopes: true,
91
    customScopesAlign: 'bottom',
92
    customScopesAlias: 'custom',
93
    emptyScopesAlias: 'empty',
94
    upperCaseSubject: false,
95
    markBreakingChangeMode: false,
96
    allowBreakingChanges: ['feat', 'fix'],
97
    breaklineNumber: 100,
98
    breaklineChar: '|',
99
    skipQuestions: [],
100
    issuePrefixes: [
101
      // 如果使用 gitee 作为开发管理
102
      { value: 'link', name: 'link:     链接 ISSUES 进行中' },
103
      { value: 'closed', name: 'closed:   标记 ISSUES 已完成' },
104
    ],
105
    customIssuePrefixAlign: 'top',
106
    emptyIssuePrefixAlias: 'skip',
107
    customIssuePrefixAlias: 'custom',
108
    allowCustomIssuePrefix: true,
109
    allowEmptyIssuePrefix: true,
110
    confirmColorize: true,
111
    scopeOverrides: undefined,
112
    defaultBody: '',
113
    defaultIssues: '',
114
    defaultScope: '',
115
    defaultSubject: '',
116
  },
117
})
118

119
export default config

然后将 package.json 中的 scripts 修改为 "cz": "czg":

1
"cz": "cross-env NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning' czg"
2
"cz": "czg"

1
pnpm remove cross-env

介绍#

安装#

AI 生成提交信息#

20250-03-09 更新#

参考#