ObjectiveC老项目, 添加新的Swift语言进行混编时, 如何进行代码自动规范化?

自动Format

目前, 本人使用的也是Square公司开源的"Clang-Format"进行代码规范. 一直以来用的都挺好.

但是自从Swift出世后, 问题就来了. Square公司的spacecommander项目不支持Swift文件的处理. 而且Square公司暂时也没有开源关于Swift的Format工具. 所以只能另寻它法.

还好, 这边有一个牛人开发了相应的Swift格式化工具SwiftFormat. 而且同样流畅的命令行操作, 可以让我们的工作变得轻松.

详细用法

安装

支持Homebrew安装

brew update brew install swiftformat

也支持项目编译安装. 这个比较麻烦, 大伙需要的话就直接去github上看README文档吧

使用

由于工具开发者本人实现了XCode 8的Extension, 所以希望使用菜单项或者Hot Key的朋友可以尝试一下. 文档已经描述的很详细了.

本人用的是直接Hooks到仓库git上, 步骤如下:

进入本地项目目录, 创建或打开.git/hooks/pre-commit文件

cd *** //***为项目路径 vi .git/hooks/pre-commit

如果项目文件之前已存在, 则在下方添加以下内容(与文档说明略有出入, 考虑到CocoaPods/Carthage问题)


git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do

swiftformat ${line};

git add $line;

done

如果有童鞋没有将.gitignore文件对Pods或Carthage目录进行过滤*(虽然一般人都不会这么做ORZ)*, 那么可以考虑换成以下内容

git status --porcelain | grep -v'Pods/'| grep -v'Carthage/'| grep-e'^[AM]\(.*\).swift$'| cut -c 3- |whilereadline;doswiftformat${line};  git add$line;done复制代码

如果项目文件之前不存在, 则添加以下内容

#!/bin/bashgit status --porcelain | grep-e'^[AM]\(.*\).swift$'| cut -c 3- |whilereadline;doswiftformat${line};  git add$line;done复制代码

保存退出, 修改该文件的执行权限. 从此万事大吉

chmod +x .git/hooks/pre-commit

示例


进一步的问题

ObjectiveC老项目, 添加新的Swift语言进行混编时, 如何进行代码自动规范化?

很简单, 首先先使用Square公司的spacecommander项目工具脚本setup-repo.sh对项目进行初始化. 这个脚本会自动帮你在项目的.git/hooks目录下创建pre-commit文件并填入脚本内容.

然后, 在第二行插入以下内容(就是上面提及的SwiftFormat脚本):

git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do

  swiftformat ${line};

  git add $line;

done

考虑到我们团队可能需要保留未使用的参数, 所以可以修改为以上内容为:

git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do

  swiftformat --disable unusedArguments ${line};

  git add $line;

done

保存退出. 从此你就能满地图的乱写OC/Swift代码了。妈妈再也不用担心我的格式问题了!

代码格式化规范如何调整

目前还真没有比较好的办法. 正如spacecommander项目提及的:You may wish to fork [ Space Commander] to apply your team's particular set of formatting rules (more details below), or clone to enjoy Square's flavor of Objective-C formatting.

如果你们团队希望使用自己的规范, 基本只能考虑fork项目, 然后在本地进行修改生成新的pods, 再做导出.

SwiftFormat项目则提供了命令行参数的方式进行部分风格设置项:


目前SwiftFormat的版本为0.44.17


官网:https://github.com/nicklockwood/SwiftFormat

参考链接:http://www.cocoachina.com/articles/22342

https://juejin.im/post/6844903565920567304

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