使用spacecommander 格式化iOS项目代码

这个工具的地址https://github.com/square/spacecommander

使用方法:

1. 下载 spacecommander

这里可以cd 到自己指定的文件夹,使用git命令下载;

git clone https://github.com/square/spacecommander.git

也可以直接下载压缩包,然后解压.

2. 安装 spacecommander 到需要格式化代码的项目中

cd到项目根目录,执行setup-repo.sh脚本(注意脚本需要全路径),执行完后会在项目根目录多一个隐藏文件.clang-format ,这是一个替身文件

执行setup-repo.sh脚本

执行完脚本后,项目个目录会多出隐藏文件

3.修改代码格式规则

打开.clang-format替身,指向Space Commander仓库中的.clang-format原本文件,修改里面默认系列代码规则,改成自己所需要的规则

iOS 的可以参考这个http://clang.llvm.org/docs/ClangFormatStyleOptions.html

例如:我的iOS项目修改了几条的设置

# 基于LLVM格式

BasedOnStyle:  LLVM

# 大括号之前间断方式

BreakBeforeBraces: Attach

# 声明OC属性后有两行空行

ObjCSpaceAfterProperty: true

4.以上配置已经完成,现在开始使用

这里我故意把代码格式改的很乱,来测试一下效果

格式很乱的代码

格式很乱的代码

当执行git commit 命令后,终端会提示有格式问题

根据提示,执行 >"/Users/YannChee_workMac/spacecommander"/format-objc-files.sh -s ,即可格式化代码,再次commit 时就不会提示代码有格式问题了

顺便总结一下,这几个脚本的作用:

setup-repo.sh 初始化

format-objc-file.sh 格式化单个暂存文件

format-objc-files.sh 格式化所有暂存文件

format-objc-files-in-repo.sh 格式化整个仓库

格式后的代码

使用过程中遇到的问题:

有时候代码命名已经格式化成功,但是git commit 终端还是提示 代码格式有问题,这可能是这个工具的bug,需要在git commit 后面加上 --no-verify修饰下,例如

git commit -m "test" --no-verify

或 git commit --no-verify -m "test"

官方参考:https://clang.llvm.org/docs/ClangFormat.html

其他参考链接如下:

https://www.cnblogs.com/liuyunbin/p/11538267.html

https://blog.csdn.net/softimite_zifeng/article/details/78357898

https://github.com/square/spacecommander.git

https://www.jianshu.com/p/baa4693a7adf

https://juejin.im/post/6844903555866820622

https://juejin.im/post/6844903555866820622

https://www.cnblogs.com/__tudou__/p/13322854.html

https://github.com/square/spacecommander.git

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