cz-customizable: 自定义你的Git Commit规范化之旅
目录结构及介绍
当你克隆或下载cz-customizable
项目后, 你会发现如下基本目录结构:
cz-customizable/
│ ├── README.md # 项目的说明文档
│ ├── package.json # Node.js项目的配置文件, 包含各种依赖和脚本
│ ├── node_modules/ # 项目的所有npm包依赖存放在此文件夹内
│ ├── lib/ # 项目的源代码文件夹
│ │ └── index.js # cz-customizable的主要逻辑入口文件
│ ├── tests/ # 测试文件存放的位置
│ ├── .cz-config.js # cz-customizable的配置文件, 可以自定义Git Commit的类型、作用域以及字段规则
│ ├── CHANGELOG.md # 项目变更日志
│ ├── LICENSE # 许可证信息
│ └── .gitignore # Git忽略规则文件
README.md
: 此处包含了关于项目的基本信息, 包括安装、使用指南以及贡献者的信息.
.cz-config.js
: 这个文件负责设置cz-customizable的行为. 你可以自定义Commit的模板, 提供一套自定义的类型列表以及其他相关信息.
lib/index.js
: 这里是cz-customizable的核心文件, 处理所有有关生成规范化的Commit Message的业务逻辑.
项目的启动文件介绍
通常来说, cz-customizable
并不需要单独的“启动”过程. 它通过集成进commitizen框架成为你的项目的一部分, 或者作为一个独立的命令行工具使用.
然而, 当我们谈论“启动”时, 实际上是在指代将cz-customizable作为commitizen的一个插件进行初始化的过程:
步骤1: 全局安装commitizen(如果尚未完成)
$ npm install -g commitizen
步骤2: 在你的项目中安装cz-customizable
$ cd your-project
$ npm install cz-customizable --save-dev
步骤3: 更新你的package.json
文件, 来指定cz-customizable作为你的默认cz配置:
{
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
},
"scripts": {
"commit": "git-cz"
}
}
这样, 每当你要创建一个新的commit时, 即便使用的是简单的git commit
, cz-customizable
都会自动介入并引导你输入规范化的commit信息.
项目的配置文件介绍
.cz-config.js
是cz-customizable的关键配置文件, 在这里你能够调整规范化的commit模版, 包括设置可用的类型、作用域以及是否启用某些特定的功能.
一份示例配置可能如下所示:
module.exports = {
"types": [
{value: 'feat', name: 'feat: (new feature for the user, involving breaking or non-breaking change)'},
{value: 'fix', name: 'fix: (bug fix for the user, involving breaking or non-breaking change)'}
// 更多类型...
],
"scopes": ["core", "docs", "examples", null], // 可选的作用域, 其中的null表示不选用任何作用域.
"allowCustomScopes": true,
"questions": [
"type",
"scope",
"subject",
"isBreaking",
"body",
"issues",
],
};
在这份配置中, 你可以看到定义了两种不同的类型
("feat" 和 "fix"), 并且提供了多个作用域
如"core","docs","examples". 你还可以控制是否允许自定义作用域(allowCustomScopes
), 并且确定commit过程中询问用户的顺序(questions
).