https://twitter.com/ethanhuang13/status/1318745438728515584?s=20

SwiftFormat 是自動化的 Swift 程式碼排版工具。可以依照指定的規則把 Swift 檔案修改成想要的格式，例如調整縮排、去除多餘的空行空格（全部規則請看官網）。對於統一團隊專案的 coding style 很有幫助，個人開發者也可以省下手工調整排版的力氣。

我使用它的時機有三個：

• 取代 Xcode 的排版功能，在寫程式的時候按快速鍵排版目前的 Swift 檔
• 在 pre-build 階段執行，自動排版專案內的所有 Swift 檔
• 在 pre-commit 時執行，自動排版已 stage 的 Swift 檔行數

安裝方式

請參考官方文件。我個人偏好用 Mint 來管理。

規則

全部規則請參考官方文件，這裡只列出一部分我個人覺得實用的規則：

• indent 指定縮排規則
• markTypes 整理所有 // MARK
• modifierOrder 是 public static var 還是 static public var ？就用它來自動統一
• organizeDeclarations 很厲害，整個 type 裡面的宣告順序都照特定順序排列
• redundant 系列 多寫的東西都自動去掉，包括 self.
• sortedImports 強迫症福音
• space 系列 不用再傷腦筋什麼時候要加空格

第一次嘗試

我會建議第一次使用時，先確定 git status clean，然後在專案根目錄下指令 swiftFormat . 看看原汁原味的 SwiftFormat 會帶來什麼樣的感受。