1.安装 Commitizen:
npm install --save-dev commitizen cz-customizable
2.配置 package.json
:
{
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
}
}
3.创建 .cz-config.js
: 在项目根目录下创建一个 .cz-config.js
文件,配置你希望使用的 commit 提交信息格式。例如:
module.exports = {
// 可选类型
types: [
{ value: 'feat', name: 'feat: 新功能' },
{ value: 'fix', name: 'fix: 修复' },
{ value: 'docs', name: 'docs: 文档变更' },
{ value: 'style', name: 'style: 代码格式' },
{ value: 'refactor', name: 'refactor: 重构' },
{ value: 'perf', name: 'perf: 性能优化' },
{ value: 'test', name: 'test: 增加测试' },
{ value: 'chore', name: 'chore: 构建过程或辅助工具的变动' },
{ value: 'revert', name: 'revert: 回退' },
{ value: 'build', name: 'build: 打包' },
],
// 消息步骤
messages: {
type: '请选择提交类型(必填):',
customScope: '请输入修改范围(可选):',
subject: '请简要描述提交(必填):',
body: '请输入详细描述(可选):',
footer: '请输入要关闭的issue(可选):',
confirmCommit: '确认使用以上信息提交?(y/n/e/h)',
},
// 跳过问题
skipQuestions: ['customScope', 'body', 'footer'],
// subject文字长度默认是72
subjectLimit: 72,
}
4.更新 npm
脚本: 为了便于使用,可以在 package.json
的 scripts
中添加一个命令来使用 Commitizen:
"scripts": {
"commit": "cz"
}
5.使用 Commitizen: 现在你可以使用 npm run commit
命令来提交代码
记得把package.json的type: 'module'去掉