1953 字
10 分钟
使用 ChatGPT 生成 git message
2025-02-22
教程
cz-git
/
git
/
commitizen

介绍#

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

安装#

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

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

在 package.json 中增加:

{
  "config": {
    "commitizen": {
      "path": "node_modules/cz-git"
    }
  }
}

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

import type { UserConfig } from 'cz-git'

const config: UserConfig = {
	extends: ['@commitlint/config-conventional'],
  prompt: {
      alias: { fd: 'docs: fix typos' },
      messages: {
          type: '选择你要提交的类型 :',
          scope: '选择一个提交范围（可选）:',
          customScope: '请输入自定义的提交范围 :',
          subject: '填写简短精炼的变更描述 :\n',
          body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
          breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
          footerPrefixesSelect: '选择关联issue前缀（可选）:',
          customFooterPrefix: '输入自定义issue前缀 :',
          footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
          confirmCommit: '是否提交或修改commit ?',
      },
      types: [
          { value: 'feat', name: 'feat:     新增功能 | A new feature' },
          { value: 'fix', name: 'fix:      修复缺陷 | A bug fix' },
          { value: 'docs', name: 'docs:     文档更新 | Documentation only changes' },
          { value: 'style', name: 'style:    代码格式 | Changes that do not affect the meaning of the code' },
          { value: 'refactor', name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature' },
          { value: 'perf', name: 'perf:     性能提升 | A code change that improves performance' },
          { value: 'test', name: 'test:     测试相关 | Adding missing tests or correcting existing tests' },
          { value: 'build', name: 'build:    构建相关 | Changes that affect the build system or external dependencies' },
          { value: 'ci', name: 'ci:       持续集成 | Changes to our CI configuration files and scripts' },
          { value: 'revert', name: 'revert:   回退代码 | Revert to a commit' },
          { value: 'chore', name: 'chore:    其他修改 | Other changes that do not modify src or test files' },
      ],
      useEmoji: false,
      emojiAlign: 'center',
      useAI: false,
      aiNumber: 1,
      themeColorCode: '',
      scopes: [],
      allowCustomScopes: true,
      allowEmptyScopes: true,
      customScopesAlign: 'bottom',
      customScopesAlias: 'custom',
      emptyScopesAlias: 'empty',
      upperCaseSubject: false,
      markBreakingChangeMode: false,
      allowBreakingChanges: ['feat', 'fix'],
      breaklineNumber: 100,
      breaklineChar: '|',
      skipQuestions: [],
      issuePrefixes: [
      // 如果使用 gitee 作为开发管理
          { value: 'link', name: 'link:     链接 ISSUES 进行中' },
          { value: 'closed', name: 'closed:   标记 ISSUES 已完成' },
      ],
      customIssuePrefixAlign: 'top',
      emptyIssuePrefixAlias: 'skip',
      customIssuePrefixAlias: 'custom',
      allowCustomIssuePrefix: true,
      allowEmptyIssuePrefix: true,
      confirmColorize: true,
      scopeOverrides: undefined,
      defaultBody: '',
      defaultIssues: '',
      defaultScope: '',
      defaultSubject: '',
  },
}

export default config

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

AI 生成提交信息#

WARNING

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

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

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

在 package.json 中增加 cz:

{
  "scripts": {
    "cz": "cross-env NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning' czg"
  }
}
TIP

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

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

import type { UserConfig } from 'cz-git'

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

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

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

我们来尝试一下:

git add -A
pnpm run cz ai

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

###--------------------------------------------------------###
feat: update TypeScript formatter to Prettier and enhance commitlint config
###--------------------------------------------------------###

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

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

import type { UserConfig } from 'cz-git'

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

最后, 我们再次提交:

pnpm run cz ai

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

czg@1.11.0

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

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

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

完结撒花 ❤️

20250-03-09 更新#

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

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

const config = defineConfig({
	extends: ['@commitlint/config-conventional'],
	rules: {
		'type-enum': [
			2,
			'always',
			[
				'build',
				'chore',
				'ci',
				'docs',
				'feat',
				'fix',
				'perf',
				'refactor',
				'revert',
				'style',
				'test',
				'WIP',
			],
		],
		'type-case': [0], // 禁用类型大小写检查
	},
	prompt: {
		alias: { fd: 'docs: fix typos' },
		messages: {
			type: '选择你要提交的类型 :',
			scope: '选择一个提交范围（可选）:',
			customScope: '请输入自定义的提交范围 :',
			subject: '填写简短精炼的变更描述 :\n',
			body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
			breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
			footerPrefixesSelect: '选择关联issue前缀（可选）:',
			customFooterPrefix: '输入自定义issue前缀 :',
			footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
			confirmCommit: '是否提交或修改commit ?',
		},
		types: [
			{ value: 'feat', name: 'feat:     新增功能 | A new feature' },
			{ value: 'fix', name: 'fix:      修复缺陷 | A bug fix' },
			{ value: 'WIP', name: 'WIP:      暂未完成 | Not yet completed' },
			{
				value: 'docs',
				name: 'docs:     文档更新 | Documentation only changes',
			},
			{
				value: 'style',
				name: 'style:    代码格式 | Changes that do not affect the meaning of the code',
			},
			{
				value: 'refactor',
				name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature',
			},
			{
				value: 'perf',
				name: 'perf:     性能提升 | A code change that improves performance',
			},
			{
				value: 'test',
				name: 'test:     测试相关 | Adding missing tests or correcting existing tests',
			},
			{
				value: 'build',
				name: 'build:    构建相关 | Changes that affect the build system or external dependencies',
			},
			{
				value: 'ci',
				name: 'ci:       持续集成 | Changes to our CI configuration files and scripts',
			},
			{ value: 'revert', name: 'revert:   回退代码 | Revert to a commit' },
			{
				value: 'chore',
				name: 'chore:    其他修改 | Other changes that do not modify src or test files',
			},
		],
		useEmoji: false,
		emojiAlign: 'center',
		useAI: true,
		aiNumber: 6,
		aiModel: 'gpt-4o-mini',
		aiQuestionCB({ maxSubjectLength, diff }) {
			return `用完整句子为以下 Git diff 代码写一个有见解并简洁的 Git 中文提交消息，不加任何前缀，并且内容不能超过 ${maxSubjectLength} 个字符: \`\`\`diff\n${diff}\n\`\`\``
		},
		themeColorCode: '',
		scopes: [],
		allowCustomScopes: true,
		allowEmptyScopes: true,
		customScopesAlign: 'bottom',
		customScopesAlias: 'custom',
		emptyScopesAlias: 'empty',
		upperCaseSubject: false,
		markBreakingChangeMode: false,
		allowBreakingChanges: ['feat', 'fix'],
		breaklineNumber: 100,
		breaklineChar: '|',
		skipQuestions: [],
		issuePrefixes: [
			// 如果使用 gitee 作为开发管理
			{ value: 'link', name: 'link:     链接 ISSUES 进行中' },
			{ value: 'closed', name: 'closed:   标记 ISSUES 已完成' },
		],
		customIssuePrefixAlign: 'top',
		emptyIssuePrefixAlias: 'skip',
		customIssuePrefixAlias: 'custom',
		allowCustomIssuePrefix: true,
		allowEmptyIssuePrefix: true,
		confirmColorize: true,
		scopeOverrides: undefined,
		defaultBody: '',
		defaultIssues: '',
		defaultScope: '',
		defaultSubject: '',
	},
})

export default config

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

- "cz": "cross-env NODE_OPTIONS='--experimental-transform-types --disable-warning ExperimentalWarning' czg"
+ "cz": "czg"
pnpm remove cross-env

参考#

使用 ChatGPT 生成 git message
http://blog.xiaban.run/posts/2025/cz-git/
作者
Ryan
发布于
2025-02-22
许可协议
CC BY-NC-SA 4.0
© 2025 Ryan. All Rights Reserved. / RSS / Sitemap
Powered by Astro & Fuwari
鲁公网安备37070302000206号 | 鲁ICP备2025143431号-1