Appearance
代码提交规范
安装commitizen和cz-customizable
npm install -g commitizen
npm i cz-customizable --save-dev
npm install -g commitizen
npm i cz-customizable --save-dev
package.json
文件
json
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
}
},
"cz-customizable": {
"config": ".cz-config.js"
}
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
}
},
"cz-customizable": {
"config": ".cz-config.js"
}
根目录新建文件 cz-config.js
文件
js
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: 代码回退' },
],
// 消息步骤
messages: {
type: '请选择提交类型:',
customScope: '请输入修改范围(可选):',
subject: '请简要描述提交(必填):',
body: '请输入详细描述(可选):',
footer: '请输入要关闭的issue(可选):',
confirmCommit: '确认使用以上信息提交?(y/n/e/h)'
},
// 跳过问题
skipQuestions: ['body', 'footer'],
// subject文字长度默认是72
subjectLimit: 72
}
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: 代码回退' },
],
// 消息步骤
messages: {
type: '请选择提交类型:',
customScope: '请输入修改范围(可选):',
subject: '请简要描述提交(必填):',
body: '请输入详细描述(可选):',
footer: '请输入要关闭的issue(可选):',
confirmCommit: '确认使用以上信息提交?(y/n/e/h)'
},
// 跳过问题
skipQuestions: ['body', 'footer'],
// subject文字长度默认是72
subjectLimit: 72
}
执行git命令
git add .
git cz
git add .
git cz
就会这样: