cz-conventional-changelog 使用教程
1. 项目的目录结构及介绍
cz-conventional-changelog/
├── LICENSE
├── README.md
├── index.js
├── package.json
└── test/
├── fixtures/
│ └── commit-message.txt
└── index.js
LICENSE
: 项目许可证文件。README.md
: 项目说明文档。index.js
: 项目的主入口文件。package.json
: 项目的依赖和配置文件。test/
: 项目的测试目录。fixtures/
: 测试用例的固定数据。index.js
: 测试文件。
2. 项目的启动文件介绍
index.js
是项目的主入口文件,负责初始化和配置 cz-conventional-changelog
插件。该文件主要包含以下内容:
module.exports = {
prompter: function (cz, commit) {
// 代码逻辑
}
};
该文件定义了一个 prompter
函数,用于与用户交互并生成符合规范的提交信息。
3. 项目的配置文件介绍
package.json
是项目的依赖和配置文件,其中包含了一些关键配置项:
{
"name": "cz-conventional-changelog",
"version": "3.3.0",
"description": "Commitizen adapter following the conventional-changelog format.",
"main": "index.js",
"scripts": {
"test": "mocha --reporter spec"
},
"config": {
"commitizen": {
"path": "./index.js"
}
}
}
name
: 项目名称。version
: 项目版本。description
: 项目描述。main
: 项目的主入口文件。scripts
: 项目的脚本命令。config.commitizen.path
: 指定commitizen
使用的适配器路径。
通过这些配置,可以确保 commitizen
使用 cz-conventional-changelog
插件来生成符合规范的提交信息。