检测commit提交格式,强制统一commit格式,不符合规定格式commit提交失败
$ npm install -g unity-git-commit
$ npm install --save-dev husky
- 在当前项目的
package.json
scripts字段增加一行 "commitmsg": "node ./git-bash/commit-msg.js" - 执行命令hook,生成git-bash/commit-msg.js文件
message -> desc | kws
desc -> line + EOL + line...
line -> 【 + tag + 】 + txt
tag -> txt + postfix
postfix -> {'页'|'模块'...}
kws -> {'build'|'release','merge'...}
txt -> {^【,^】}
备注:
-
txt是由非【、】字符组成的字符串,其中首字符不能是空白字符,如果txt中需要出现【或】,需要转义
-
【、】转义规则:两侧用引号包裹,如“【”或‘【’或'【'或"【"
-
postfix和kws是可以拓展的,系统支持传入自定义数值。
- 【测试页】描述修改内容
- 【测试模块】描述修改内容
- build
- merge
- release
自动检测,会自动设置好exitCode,如果message不符合要求,会自动在程序执行完后终止commit,底层封装了checker
-
customKeywords[array]:自定义关键词,系统自带的有build、Build、release、Release、merge、Merge,其中对乌龟Git自动merge生成的message做了兼容处理。用户可以自己传入关键词,进行拓展。
-
custormPostfixes[array]:自定义后缀,系统自带的后缀有“页”和“模块”,也就是【xx页|模块】,如果想要拓展,可以自己传参,例如支持【xx组件】,只需将custormPostfixes设为['组件']即可。
返回值:undefined
只进行检测,返回状态码,不设置exitCode**(exitCode非0都会导致commit终止)**
返回值:{status:string:}
返回值:{status:number:desc:string}
安装完unity-git-commit之后,执行npm link unity-git-commit,自动关联全局node_modules包