版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
第一步:配置JDK
Groovy是依赖于Java的,所以首先要配置好JDK。
1、下载jdk
通过JDK官网获取jdk安装包,由于本人电脑是MAC,所以这里获取的是MAC版本的JDK
2、安装jdk
下载完成后,双击.dmg文件,按提示一路继续下去即可完成指引安装。
3、配置环境变量
打开cmd命令行,在命令行中输入
open .bash_profile
命令来打开.bash_profile文件并对其进行编辑,在里面添加JDK的环境变量
4、检测刚才关于Jdk的操作是否成功
在命令行中输入
java -version
命令行,如果能成功看到类似下面的结果则证明Jdk配置成功
第二步:下载Groovy
1、通过Groovy官网下载Groovy安装包
2、把Groovy的包文件拷贝到某个指定的文件夹
我这里拷贝到了个人目录下面的Library文件夹中
/Users/shilei/Library/
3、配置Groovy环境变量
重新打开.bash_profile文件,在里面添加groovy的环境变量
4、检测刚才关于groovy的操作是否成功
在命令行中输入
groovy -v
命令行,如果能成功看到类似下面的结果则证明Groovy环境变量配置成功
第三步:修改Git的配置文件,为其添加提交约束语法
1、修改commit-msg文件
打开git的配置文件目录(默认是隐藏文件,需要让系统显示隐藏文件),里面会有一个hooks文件夹,在hooks文件夹中有一个commit-msg.sample文件
打开这个文件,默认的文件内容如下
我们清空这个文件的内容,并重新添加如下所示的约束语法,记得去掉文件后缀名!!
#!/usr/bin/env groovy
import static java.lang.System.exit
//要提交的信息保存在该文件里
def commitMsgFileName = args[0]
def msgFile = new File(commitMsgFileName)
//读出里面的提交信息
def commitMsg = msgFile.text
//对要提交的信息做校验,如果不符合要求的,不允许提交
def reg = ~"^(fix:|add:|update:|refactor:|perf:|style:|test:|docs:|revert:|build:)[\\w\\W]{5,100}"
if (!commitMsg.matches(reg)) {
StringBuilder sb = new StringBuilder()
sb.append("================= Commit Error =================\n")
sb.append("===>Commit 信息不规范,描述信息字数范围为[5, 100],具体格式请按照以下规范:\n")
sb.append(" fix: 修复某某bug\n")
sb.append(" add: 增加了新功能\n")
sb.append(" update: 更新某某功能\n")
sb.append(" refactor: 某个已有功能重构\n")
sb.append(" perf: 性能优化\n")
sb.append(" style: 代码格式改变\n")
sb.append(" test: 增加测试代码\n")
sb.append(" docs: 文档改变\n")
sb.append(" revert: 撤销上一次的commit\n")
sb.append(" build: 构建工具或构建过程等的变动\n")
sb.append("================================================")
println(sb.toString())
exit(1)
}
exit(0)
记得去掉文件后缀名!!
2、校验结果
到这里,我们已经成功为Git添加了简单的代码提交约束规范,来测试一下效果
可以发现,如果我们还是像平常一样,使用git commit -m “添加约束”,会提示信息不规范,我们必须提交符合约束规范的描述信息,才能成功提交代码。