以 commitizen 为中心的 git 提交格式化工具

commitizen，简称 cz，他用于管控我们 git commite 提交。

相关的配置很多，附属插件，依赖也很多。目前（2024-10-23）暂不考虑继续折腾该内容。

最低限度的快速初始化 cz

我手上已经有很多项目了，需要实现最低限度的初始化。

1. 全局安装 commitizen

为提高效率，需要高效率的使用 cz 来快速在命令行内写 commit，全局包才提供这样的功能。故我会全局安装该依赖。

pnpm i -g commitizen

2. 安装依赖

pnpm i -D commitizen cz-git

3. 配置 commitizen 使用的规则

配置规则有两种方式：

推荐方案

在主要的工作目录内新建 .czrc 文件：

{
  "path": "cz-git"
}

并不需要在 git 所在的项目根目录内新建。在嵌套文件夹的情况下，在你的主要工作目录内新建文件即可。

不太推荐

在 package.json 内：

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

之所以不推荐，是因为该写法毕竟要写在 package.json 内，而且是对 git 所在路径硬编码。

贡献者

ruan-cat

页面历史

最后编辑于 19 天前

查看完整历史

c01770f-📃 docs(notes): 记录更好的cz配置方案。

de47900-📃 docs: cz快速初始化。