SwiftFormat簡介

SwiftFormat可以幫助開發者自動的糾正一些代碼規范問題,并且可以一定程度的幫助我們優化代碼、統一代碼風格。比如,幫助我們調整空格、縮緊,移除隱式的self調用等等。更加詳細的規則可以參考這里

一、可以通過以下幾種方式進行安裝

1.1、命令行工具
可以通過HomeBrew來安裝

brew install swiftformat

也可以通過Mint來安裝運行

mint install nicklockwood/SwiftFormat
mint run swiftformat

當然,也可以通過clone代碼,然后手動編譯

git clone https://github.com/nicklockwood/SwiftFormat
cd SwiftFormat
swift build -c release

通過上述方法安裝完成后,進入項目文件夾根目錄,執行命令行:

swiftformat .

那么會重新編排該目錄下的所有文件。當然,更為穩妥的方式是進入需要編排的文件目錄并執行命令。

1.2、擴展Xcode的source editor
通過HomeBrew執行命令:

brew install --cask swiftformat-for-xcode

通過這種方式可以講swiftformat擴展為Xcode的一項功能,可以在Xcode Editor menu中找到并運行。

1.3、通過為Xcode添加運行腳本
通過homebrew安裝了swiftformat后,在Xcode的 Run Script build phase添加以下腳本

if which swiftformat >/dev/null; then
swiftformat .
else
echo "warning: SwiftFormat not installed, download from https://github.com/nicklockwood/SwiftFormat"
fi

或者也可通過Cocoapods進行安裝并添加依賴腳本

“${PODS_ROOT}/SwiftFormat/CommandLineTool/swiftformat” "$SRCROOT"
二、規則添加

同樣的,我們也可以對規則進行添加和修改,通過 --disable--enable 標識。
例如:

--disable redundantSelf,trailingClosures
--enable isEmpty

或者針對多條規則:

--disable indent
--disable linebreaks
--disable redundantSelf

可以這樣表示:

--disable          \
    indent,        \
    linebreaks,    \
    redundantSelf

或者有時我們只需要支持某些rules時:

--rules indent,linebreaks

除此之外,如果在代碼中需要某些規則不對某段代碼生效的話,可以做如下注釋:

// swiftformat:disable <rule1> [<rule2> [rule<3> ...]]
三、規則自定義配置文件

通過上面介紹的規則,我們可以實現自定義的需求,但是更為方便的辦法是通過一個配置文件來統一管理我們的自定義規則。
通過創建一個隱式文件 .swiftformat ,可以在里面根據需求自定義規則。
注意:該文件的位置,一般建議放到項目文件夾的根目錄。因為.swiftformat文件有相應的作用區間,如果未特別指明path時,則默認作用在當前父目錄下的所有swift文件

# format options
--allman true
--indent tab # tabs FTW!

# file options
--exclude Pods

# rules
--disable elseOnSameLine,semicolons
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,001評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,786評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,986評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,204評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,964評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,354評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,410評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,554評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,106評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,918評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,093評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,648評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,342評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,755評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,009評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,839評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,107評論 2 375

推薦閱讀更多精彩內容