[TOC]
## 1. 编译检测工具
## 2. git 规范信息提交工具
>[success] 由来: 在多人合作项目中,合并代码时会因为不规范的信息提交而导致不清楚具体修改的模块,从而耗时去查找代码修改源
### 安装相关依赖
~~~
$ npm install git-cz -g
// ...
$ npm install commitizen cz-customizable --dev
~~~
### 在`package.json`配置快捷脚本
> tips: 可配置可不配,配置后使用`yarn commit`命令即可,不配置使用`git-cz`亦可
> 当项目在硬盘中位置过深时,可能会遇到 `git-cz`报错找不到 `node_modules/cz-customizable` ,这时只能手动输入文件目录
~~~
{
"scripts": {
// ...
"commit": "git-cz"
}
// ...
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
}
}
}
~~~
### 配置`.cz-config.js`文件,制定`commit`可选择信息
~~~
/*
* @describe: commit可选择信息配置
*/
'use strict'
module.exports = {
// 可供选择类型
types: [
{
value: 'add',
name: 'add: A new feature'
}, {
value: 'fix',
name: 'fix: A bug fix'
},
// ...
],
// 可供选择模块区域
scopes: [
'公共模块',
'全局组件',
'解决冲突',
'更新版本',
// ...
],
// 允许自定义范围
// allowCustomScopes: true,
// 允许中断更改
allowBreakingChanges: ['add', 'fix']
}
~~~
### 使用
~~~
$ git checkout
M projectConfig/package.json
M projectConfig/.cz-config.js
$ git add .
// ...
$ yarn commit
// 或者使用 git-cz
// ... 一路选择或输入即可
$ git push origin test
~~~