$3
对提交的comment做检查,有对应的issue或符合规则才能提交。
参阅
comment规范
$3
#### install
全局安装
``
shell
npm install -g git-commit-hook
`
项目中安装
`
shell
npm install git-commit-hook
`
#### 用途
全局安装之后,能够使用precommit
命令。下面这个命令将会获取gitlab上这个项目的id,并自动填充到package.json的字段中,首先要在项目中安装此包。
`
获取项目id
precommit get-id [reponame]
生成issue标签
precommit create-label
`
#### configuration
在package.json中配置pre-commit
, 示例:
`
json
"pre-commit": {
"git": {
"id": "576",
"private-token": "xw3di64ztryRVizzVG6A",
"namespace": "yypt-group"
},
"pass": ["^merge"],
"scripts": {
"postcommit": "node ./valiate.js",
"precommit": "node ./validate.js"
}
}
`
##### git
- private-token
必须, profile account页面中的Private token
,用于调用gitlab的api授权使用。
- id
必须,初次构件项目时,可以通过precommit get-id projectName
命令自动填充,同时token
将会加密。
- namespace
可选,用于匹配项目所属group
- label
issue的标签
##### pass
数组类型,不需要进行校验的正则匹配,将会直接通过。
##### scripts
- precommit
pre-commit执行之前,执行指定的命令
- postcommit` pre-commit执行通过之后,执行指定的命令