背景
最近聊到代码格式化的问题,大家一致认为手工代码review的时候去发现这些问题是低效率,而且也不能保证百分百发现问题的,于是想重新启用自动化检测,说到这个检测大家应该都接触过,举例我们之前用的swiftlint工具,工具的官方文档是这么说的:下载安装好之后,在我们项目的build phase中加入一个脚本,然后就可以在每次编译的时候自动检测代码格式,并且还能提供相应的xcode里的报错提示。那么这么做会带来一个问题,就是在大的项目中,每次都去swiftlint整个工程的文件,显然会加长编译时间,而浪费时间就等于谋财害命。所以我们今天来看看如何在git commit的时候再去格式化代码。
基础
git hook
所谓git hook简单来说就是在执行git命令的时候,用一些自定义的脚本执行一些其他的操作,例如,检查一下这次提交有没有写提交信息。
使用
这个是通过在.git/目录下的hooks文件中添加一些自定义的脚本来实现的,而系统为我们默认带了一些简单的例子
从这个图中可以看到有很多类型的hook文件,怎么使用呢?
最简单的方式就是把文件名后边的.sample去掉就可以了。
hook分类
从上文介绍中我们可以看到hooks文件夹下默认是有很多hook的样例文件的,这些文件的功能都体现在了名字上
例如 prepare-commit-msg.sample 这个文件的功能就是在commit的时候检查输入的commit信息是不是符合规范的,而 pre-commit.sample 这个文件的的作用是我们在提交的时候对所提交的内容或者环境做一个额外的操作,比如检查下所使用的库的版本之类的。其余的大家可以自行了解。
自定义hook的位置
当然我们的hook并不是仅仅只能放在这里。实际上,我们可以通过git config来配置我们的hook位置。
当我们执行git config --list的时候就会把我们目前git的一个配置打印出来,我们可以在其中加一行
core.hooksPath="/path/to/hookfolder"
例如,假设我们和./git目录平级的有一个.githooks的文件夹,结构如下:
那么我们就需要在配置中增加如下一行
core.hooksPath=./githooks
格式化工具
因为现在大部分的工程都是swift+OC的混合编译,那么格式化的工具就会有两个swiftlint和oclint。具体怎么用,这个对应的官网都有,就不细说了。但是介绍都是在编译的时候运行这些工具来进行检测,今天我们介绍的是在commit的时候进行检测,所以大家可以先安装好对应的格式化工具,或者等到后边我们使用工具的时候自动会安装这两个工具.
hook管理工具
这个我建议大家使用pre-commit这个工具来管理hook,打个比方,我们工程在执行commit的时候需要运行10个检测工具,那么我们需要安装10个库,然后写10个命令到pre-commit脚本中。这就很考验我们的水平了,但是有了这个工具,我们只需要写一个配置文件,它就会自动管理好这10个库。
官网在https://pre-commit.com/
安装教程也很简单,都有介绍,我就不说了。但是事情总不会像教程介绍的那么顺利,于是,我就遇到了各种问题,接下来就介绍一下。
安装问题及处理办法
- 首先我们在pre-commit-config.yaml中定义了对应的hook之后,当我们执行安装hook的命令的时候,很有可能就会出现等了很久(大概7000多秒的样子)然后报错了,告诉我们有些库拉不下来。那么这个问题就是被墙了,同学们如果会科学上网的话,应该是没有问题,那么如果你发现你能访问github,但是还是报错,这个问题怎么办呢
1.1 首先拿着github的域名找到对应的ip地址,例如我们在网站上查到了对应的地址
1.2 然后修改我们/etc/hosts的文件,在里面增加对应的ip和域名项例如:
xxx.xxx.xxx.xxx github.com
但是不出意外你没有权限修改这个文件,大家可以新建一个hosts的文件,将原来的内容粘贴进去,然后进行修改,之后将文件粘贴回/etc/下并选择替换
1.3 退出并保存,然后重新执行安装。 - 如果你连github都访问不了呢,那么可以用下载好的格式化工具包(组里至少有能访问的同学吧),然后通过本地hook的方式安装:
2.1 首先把对应的hook文件都解压,然后放到pre-commit-config.yaml的同级目录下,或者子目录
2.2 在pre-commit-config.yaml文件中 repo 写为对应的工具包的位置
2.3 执行安装命令,也是可以的。
那么如果还是报错找不到库呢,别急,在控制台输出的错误信息中有一个找不到文件的查找目录,比如.cache/tmp/xxxxx这个时候可以手动将对应的文件导入,例如,将package.swift放到目录下就可以
结语
尽管有了格式化工具,但是还是希望大家多多在平时就注意代码格式,不然你可能都不好意思让别人看你写的代码。