自動(dòng)Format
目前, 本人使用的也是Square公司開(kāi)源的"Clang-Format"進(jìn)行代碼規(guī)范. 一直以來(lái)用的都挺好.
但是自從Swift出世后, 問(wèn)題就來(lái)了. Square公司的spacecommander項(xiàng)目不支持Swift文件的處理. 而且Square公司暫時(shí)也沒(méi)有開(kāi)源關(guān)于Swift的Format工具. 所以只能另尋它法.
還好, 這邊有一個(gè)牛人開(kāi)發(fā)了相應(yīng)的Swift格式化工具SwiftFormat. 而且同樣流暢的命令行操作, 可以讓我們的工作變得輕松.
詳細(xì)用法
安裝
支持Homebrew安裝
brew update brew install swiftformat
也支持項(xiàng)目編譯安裝. 這個(gè)比較麻煩, 大伙需要的話就直接去github上看README文檔吧
使用
由于工具開(kāi)發(fā)者本人實(shí)現(xiàn)了XCode 8的Extension, 所以希望使用菜單項(xiàng)或者Hot Key的朋友可以嘗試一下. 文檔已經(jīng)描述的很詳細(xì)了.
本人用的是直接Hooks到倉(cāng)庫(kù)git上, 步驟如下:
進(jìn)入本地項(xiàng)目目錄, 創(chuàng)建或打開(kāi).git/hooks/pre-commit文件
cd *** //***為項(xiàng)目路徑 vi .git/hooks/pre-commit
如果項(xiàng)目文件之前已存在, 則在下方添加以下內(nèi)容(與文檔說(shuō)明略有出入, 考慮到CocoaPods/Carthage問(wèn)題)
git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
swiftformat ${line};
git add $line;
done
如果有童鞋沒(méi)有將.gitignore文件對(duì)Pods或Carthage目錄進(jìn)行過(guò)濾*(雖然一般人都不會(huì)這么做ORZ)*, 那么可以考慮換成以下內(nèi)容
git status --porcelain | grep -v'Pods/'| grep -v'Carthage/'| grep-e'^[AM]\(.*\).swift$'| cut -c 3- |whilereadline;doswiftformat${line};? git add$line;done復(fù)制代碼
如果項(xiàng)目文件之前不存在, 則添加以下內(nèi)容
#!/bin/bashgit status --porcelain | grep-e'^[AM]\(.*\).swift$'| cut -c 3- |whilereadline;doswiftformat${line};? git add$line;done復(fù)制代碼
保存退出, 修改該文件的執(zhí)行權(quán)限. 從此萬(wàn)事大吉
chmod +x .git/hooks/pre-commit
示例
進(jìn)一步的問(wèn)題
ObjectiveC老項(xiàng)目, 添加新的Swift語(yǔ)言進(jìn)行混編時(shí), 如何進(jìn)行代碼自動(dòng)規(guī)范化?
很簡(jiǎn)單, 首先先使用Square公司的spacecommander項(xiàng)目工具腳本setup-repo.sh對(duì)項(xiàng)目進(jìn)行初始化. 這個(gè)腳本會(huì)自動(dòng)幫你在項(xiàng)目的.git/hooks目錄下創(chuàng)建pre-commit文件并填入腳本內(nèi)容.
然后, 在第二行插入以下內(nèi)容(就是上面提及的SwiftFormat腳本):
git?status?--porcelain?|?grep?-e?'^[AM]\(.*\).swift$'?|?cut?-c?3-?|?while?read?line;?do
??swiftformat?${line};
??git?add?$line;
done
考慮到我們團(tuán)隊(duì)可能需要保留未使用的參數(shù), 所以可以修改為以上內(nèi)容為:
git?status?--porcelain?|?grep?-e?'^[AM]\(.*\).swift$'?|?cut?-c?3-?|?while?read?line;?do
??swiftformat?--disable?unusedArguments?${line};
??git?add?$line;
done
保存退出. 從此你就能滿地圖的亂寫(xiě)OC/Swift代碼了。媽媽再也不用擔(dān)心我的格式問(wèn)題了!
代碼格式化規(guī)范如何調(diào)整
目前還真沒(méi)有比較好的辦法. 正如spacecommander項(xiàng)目提及的: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.
如果你們團(tuán)隊(duì)希望使用自己的規(guī)范, 基本只能考慮fork項(xiàng)目, 然后在本地進(jìn)行修改生成新的pods, 再做導(dǎo)出.
而SwiftFormat項(xiàng)目則提供了命令行參數(shù)的方式進(jìn)行部分風(fēng)格設(shè)置項(xiàng):
目前SwiftFormat的版本為0.44.17
官網(wǎng)：https://github.com/nicklockwood/SwiftFormat
