使用git-hook禁止本地提交大图

缘由

出于瘦身的目的，现在制定规范，避免客户端开发同学偷懒，直接把某些大图放在本地，于是希望在commit的时候，就中止 commit并提示开发同学某张图片超过 50 k。

git hook 相关知识

https://git-scm.com/book/zh/v2/%E8%87%AA%E5%AE%9A%E4%B9%89-Git-Git-%E9%92%A9%E5%AD%90#r_email_hooks

脚本源码

先简单介绍下脚本的原理，使用 git status 查看当前新增文件有哪些，然后获取新增文件大小，如果超过指定范围，直接通过 exit 1 终止 commit 即可。

1\在工程目录下找到 .git/hook文件夹
2\新建文件 pre-commit ( 或者直接rename git 自带的 pre-commit.sample )
3\执行 chmod 777 pre-commit
4\输入以下内容即可

#!/bin/sh

# 脚本用于commit之前检查大图片，如果新增单张图片超过50k,则commit失败

# 新增图片后，使用 git status可以看到类似结果：  new file:   QQNews/asset/bundles/listenNews.bundle/image/WechatIMG49.png

file_max_size=50
git status | grep "new file" | while read line;
do

    # 截取文件名
    file_name=`echo $line | awk '{print $3 }' `

    file_size=`stat -f %z $file_name`
    # 把图片大小转换成kb,保留2位小数点
    sizekb=`echo "$file_size 1024" | awk '{printf "%i", $1 / $2}'`

    if [ $sizekb -gt  $file_max_size ]
    then
        echo "Sorry ! File more than $file_max_size K is forbidden :"
        echo
        echo "$file_name is $sizekb K"
        # 中止 commit 
        exit 1
    fi

done

但是由于git 不支持把 .git/hook 下脚本push到仓库进去，且 clone 的时候不会把这个目录下的脚本 checkout 下来，

所以我们可以把 pre-commit 文件放在仓库中别的地方，然后我们需要单独追加一个脚本，这个脚本的功能是把 pre-commit 文件 拷贝到 .git/hooks目录下。

现在我们追加一张超过50k的图片到项目中，执行 git commit 之后看看效果：

➜  QQNews git:(feature/zhiyunyu_pre_commit_file_size) ✗ g commit
Sorry ! File more than 50K is forbidden :

QQNews/asset/bundles/listenNews.bundle/image/recommend_mini_beauty.png is 70 K

的确达到目的了。