git commit 格式化代码

团队合作项目,使用git时会发生这种情况 : 每个人的代码格式不同,对比工具再做对比的时候常常会当作冲突来处理,虽然有些工具会有明显的提示,但还是会占用自己太多时间。同时,一个团队保持一致的代码风格和规范,甚至是工具,都是有必要的。

经过一顿 google 之后, 发现git 的 hook pre-commit这个脚本可以指定,再commit之前插入一些脚本执行,要是再这个脚本中加上对代码的格式化,就解决了这个问题。

1、代码的格式化工具我选择了google提供的代码格式化工具。
项目地址在这里 https://github.com/google/google-java-format
通过文档给的方式,在android studio下载一个插件

Paste_Image.png

再设置中配置,这里的style我选的是 aosp 的style,因为是android 项目,并没有直接使用默认的。配置好之后,我再对代码进行格式化的时候,就使用了google-java-format,不再是之前再ide中配置的那个了。

Paste_Image.png

2、接下来写shell
我们在项目根目录中可以找到.git 下的hooks文件夹。里面存在一堆文件,就像这样。


Paste_Image.png

可以创建一个空文件,名字为pre-commit。这里我直接贴上一段代码

#!/bin/bash
#
array=`git diff-index --name-only HEAD`

for name in ${array}
do
    extension=${name##*.}
    if [[ ${extension} == "java" || ${extension} == "xml" || ${extension} == "kt" ]];then
      D:\\Applications\\tiny-tool\\formatjava.cmd ${name}
      if [ $? -eq 0 ]; then
      echo "format ok" ${name}
      else exit 1
      fi
    fi
done

exec git add ./

大兄弟,别的都好说, D:\\Applications\\tiny-tool\\formatjava.cmd ${name}有点看不明白,那是因为还差一个文件没有贴上来。就是formatjava.cmd这个文件

@ECHO OFF
java -jar D:\Applications\tiny-tool\google-java-format-1.3-all-deps.jar --replace %*
@ECHO ON

看这个工具还挺好用,可以直接格式化java代码,直接写一个cmd放到系统path中去,平时也能使用。

这样,再git commit 之后,会自动将提交的java文件进行格式化。这样就在本地和远程都使用同一套代码规范了。

ps:有个问题,google-java-format-1.3-all-deps.jar这个版本的会把java doc 也格式化了, 蛋疼, 还好有广大网友的帮助
https://github.com/Kurt-Bonatz/google-java-format/tree/skip_javadoc_formatting
这个提交已经添加到了google的代码中了, 就等着google更新, 或者直接把代码撸下来编译

c2adb464jw1edbze0mbitg2064064kjb.gif
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容