Xcode代碼規(guī)范之SwiftLint配置

Xcode代碼規(guī)范之SwiftLint配置

前言

  • 最近公司大佬考慮將項目代碼規(guī)范化, 然而自Xcode9之后,Xcode的插件基本處于廢棄的狀態(tài)大部分插件都是在一年前就停止更新了;
  • 于是在谷歌找到了一款強大的代碼規(guī)范工具SwiftLint
  • SwiftLint是 Realm 推出的一款 Swift 代碼規(guī)范檢查工具, SwiftLint 基于 Github 公布的 Swift 代碼規(guī)范進行代碼檢查，并且能夠很好的和 Xcode 整合
  • Github 公布的 Swift 代碼規(guī)范--原文
  • Github 公布的 Swift 代碼規(guī)范--中文
  • 配置好所有的設置之后，在 Xcode 中執(zhí)行編譯時，SwiftLint 會自動運行檢查，不符合規(guī)范的代碼會通過警告或者 紅色錯誤 的形式指示出來
  • 支持自定義規(guī)則,可禁用或者開啟某一些規(guī)則

一. 安裝SwiftLint

  • SwiftLint目前有三種安裝方式可供選擇,可以根據(jù)自己的項目需要自行選擇

1. 安裝全局配置(Homebrew 安裝)

Homebrew

  • Homebrew, Mac系統(tǒng)的包管理器，用于安裝NodeJS和一些其他必需的工具軟件, 輸入以下代碼安裝:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

譯注：在Max OS X 10.11（El Capitan)版本中，homebrew在安裝軟件時可能會碰到/usr/local目錄不可寫的權限問題?？梢允褂孟旅娴拿钚迯停?/p> 

sudo chown -R `whoami` /usr/local
  • Homebrew 會自動安裝最新版本
  • 打開終端輸入以下代碼:
brew install swiftlint

安裝成功,如下圖所示:

Homebrew 安裝

2. 使用 CocoaPods 安裝

  • 這種方式只能針對單個項目有效,如果你想要針對不同的項目使用不同的SwiftLint 版本，這是一種很好的解決方案
  • 需要注意的是使用這種方案會將整個SwiftLint以及他的依賴包的完整資源文件都安裝到 Pods/ 目錄中去，所以在使用版本管理工具比如 git/svn 時要注意設置忽略相關目錄
  • CocosPods安裝和安裝第三方框架一樣
  • 在根目錄創(chuàng)建Podfile 
pod 'SwiftLint'

3. 使用安裝包

SwiftLint 還支持使用 pkg 安裝包進行安裝，在官方的 Github 頁面可以找到最新發(fā)布的安裝包

二. 查看SwiftLint的全部命令

  • 等待安裝完成，在終端輸入 swiftlint help 可以查看所有可用的命令：
SwiftLint的所有命令

各個命令注釋

//查看所有命令
swiftlint help

//忽略空格導致的警告和錯誤
swiftlint autocorrect

//輸出所有的警告和錯誤
swiftlint lint

//查看所有可獲得的規(guī)則以及對應的 ID
swiftlint rules

//產(chǎn)看當前版本號
swiftlint version
  • 我們將目錄切換到工程的根目錄之下，然后敲擊如下命令:
swiftlint autocorrect

然后我們就會發(fā)現(xiàn)，所有的空格符Warning都消失了。這都得益于我們剛剛所進行的命令行操作，它會將已知的能夠自動修復的Error和Warning都自動修復，大大的減輕了我們的工作量。

三. SwiftLint的使用

安裝完成后,需要在Xcode中配置相關設置,才能使 SwiftLint 在 Xcode 中自動檢測代碼規(guī)范。配置也很簡單，只需要在 Xcode 的 Build Phases 中新建一個 Run Script Phase 配置項，在里面添加相關代碼后,編譯即可!

  • 配置代碼添加步驟
  • 需要將相關腳本添加到紅色框內(nèi)
配置代碼添加步驟

1. 全局安裝腳本添加方式

if which swiftlint >/dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

2. CocoaPods安裝腳本添加

"${PODS_ROOT}/SwiftLint/swiftlint"
  • 這里其實是設置了一個自動編譯腳本，每次運行編譯都會自動執(zhí)行這個腳本
  • 如果正確安裝了 SwiftLint，就會執(zhí)行 SwiftLint 中的代碼規(guī)范檢查，如果沒有安裝，腳本會拋出一個沒有安裝 SwiftLint 并提示下載的警告，方便提醒團隊團隊中沒有安裝的成員。
  • 當然，你也可以設置為強制要求安裝，這時如果沒有安裝則無法通過編譯。只需要在腳本中
echo "warning: ..."

之后添加一行代碼：

exit 1
  • 這樣一來，如果沒有安裝 SwiftLint，編譯時會直接拋出一個編譯錯誤而非警告，提示需要安裝 SwiftLint。

3. 配置完成后,command+B編譯

  • 如果你的是正在開發(fā)中的項目, 你可能會發(fā)現(xiàn)你的項目提示999+的黃色警告和999+的紅色錯誤
  • 甚至你會發(fā)現(xiàn)甚至一些空格和一些系統(tǒng)的方法和注釋也會報錯或者警告
  • SwiftLint默認方法名或者注釋不得超過120個字符
測試項目
  • Swift Lint 在完成上述操作之后，便已經(jīng)生效。但是，如果覺得默認的風格過于嚴格，或者項目組有另外的要求，Swift Lint 也可以定制相應的風格，或者禁用某些規(guī)則。
  • SwiftLint 的全部規(guī)則可以在：Source/SwiftLintFramework/Rules 目錄內(nèi)找到

四. 自定義配置

  • 當你編譯過項目后,看到999+的警告和錯誤,是不是第一反應就是要放棄了,其實不然
  • 仔細看一下具體的錯誤，會發(fā)現(xiàn)好多都是第三方庫的代碼規(guī)范問題，而且好多問題的級別被設置成為了 error
  • 第三方庫的代碼規(guī)范問題,這個鍋我們可不能背
  • 這里我們可以做一些配置，讓 SwiftLint 在做代碼規(guī)范檢查的時候自動忽略 CocoaPods、Carthage 等包管理器引入的第三方庫（當然，手動導入的第三方庫也能設置忽略）

1. 創(chuàng)建配置文件

  • 首先需要在項目的根目錄下新建一個名為 .swiftlint.yml 的配置文件
  • 打開終端, cd 到項目根目錄下
  • 輸入: touch .swiftlint.yml
  • 執(zhí)行完該命令后, 在文件夾中你可能找不到該yml格式文件,那是因為文件被隱藏了
  • 關于隱藏/顯示隱藏文件(命令一樣): command + shift + .
  • 下面我們來認識一下主要的幾個配置選項
disabled_rules: # 禁用指定的規(guī)則
  - colon
  - comma
  - control_statement
opt_in_rules: # 啟用指定的規(guī)則
  - empty_count
  - missing_docs
  # 可以通過執(zhí)行如下指令來查找所有可用的規(guī)則:
  # swiftlint rules
included: # 執(zhí)行 linting 時包含的路徑。如果出現(xiàn)這個 `--path` 會被忽略。
  - Source
excluded: # 執(zhí)行 linting 時忽略的路徑。 優(yōu)先級比 `included` 更高。
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

2. 在代碼中關閉某個規(guī)則

可以通過在一個源文件中定義一個如下格式的注釋來關閉某個規(guī)則：

// swiftlint:disable <rule>

在該文件結束之前或者在定義如下格式的匹配注釋之前，這條規(guī)則都會被禁用：

// swiftlint:enable <rule>

例如:

    // swiftlint:disable opening_brace
    func initTakeScreenshot(launchOptions: [AnyHashable: Any]?){
        // swiftlint:enable opening_brace
        if let options = launchOptions {
            let userInfo = options[UIApplicationLaunchOptionsKey.remoteNotification]
            NotificationCenter.default.post(name: Notification.Name.UIApplicationUserDidTakeScreenshot, object: userInfo)
        }
    }

規(guī)則關閉之前

Snip20180207_1.png

規(guī)則關閉之后


Snip20180207_2.png

也可以通過添加 :previous, :this 或者 :next 來使關閉或者打開某條規(guī)則的命令分別應用于前一行，當前或者后一行代碼。

例如:

// swiftlint:disable:next force_cast
let noWarning = NSNumber() as! Int
let hasWarning = NSNumber() as! Int
let noWarning2 = NSNumber() as! Int // swiftlint:disable:this force_cast
let noWarning3 = NSNumber() as! Int
// swiftlint:disable:previous force_cast

3. 忽略引入的第三方庫

  • 1). 忽略CocoaPods導入的第三方庫
excluded: 
  - Pods
  • 2). excluded 配置項用來設置忽略代碼規(guī)范檢查的路徑，可以指定整個文件夾
  • 比如如果你的項目使用 Carthage 管理第三方庫的話，可以將 Carthage 目錄添加到忽略列表：
excluded: 
  - Pods
  - Carthage
  • 3). 指定精確路徑下的文件，通過 - xxxx 的形式列在下面就可以了
excluded: # 執(zhí)行 linting 時忽略的路徑。 優(yōu)先級比 `included` 更高。
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

4. 嵌套配置

SwiftLint 支持通過嵌套配置文件的方式來對代碼分析過程進行更加細致的控制。

  • 在你的根 .swiftlint.yml 文件里設置 use_nested_configs: true 值。
  • 在目錄結構必要的地方引入額外的 .swiftlint.yml 文件。
  • 每個文件被檢查時會使用在文件所在目錄下的或者父目錄的更深層目錄下的配置文件。否則根配置文件將會生效。
  • excluded，included，和 use_nested_configs 在嵌套結構中會被忽略。

5. 自動更正

  • SwiftLint 可以自動修正某些錯誤，磁盤上的文件會被一個修正后的版本覆蓋。
  • 請確保在對文件執(zhí)行 swiftlint autocorrect 之前有對它們做過備份，否則的話有可能導致重要數(shù)據(jù)的丟失。
  • 因為在執(zhí)行自動更正修改某個文件后很有可能導致之前生成的代碼檢查信息無效或者不正確，所以當在執(zhí)行代碼更正時標準的檢查是無法使用的。

五. 最后貼上官方示例

disabled_rules: # 執(zhí)行時排除掉的規(guī)則
  - colon
  - comma
  - control_statement
opt_in_rules: # 一些規(guī)則僅僅是可選的
  - empty_count
  - missing_docs
  # 可以通過執(zhí)行如下指令來查找所有可用的規(guī)則:
  # swiftlint rules
included: # 執(zhí)行 linting 時包含的路徑。如果出現(xiàn)這個 `--path` 會被忽略。
  - Source
excluded: # 執(zhí)行 linting 時忽略的路徑。 優(yōu)先級比 `included` 更高。
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

# 可配置的規(guī)則可以通過這個配置文件來自定義
# 二進制規(guī)則可以設置他們的嚴格程度
force_cast: warning # 隱式
force_try:
  severity: warning # 顯式
# 同時有警告和錯誤等級的規(guī)則，可以只設置它的警告等級
# 隱式
line_length: 110
# 可以通過一個數(shù)組同時進行隱式設置
type_body_length:
  - 300 # warning
  - 400 # error
# 或者也可以同時進行顯式設置
file_length:
  warning: 500
  error: 1200
# 命名規(guī)則可以設置最小長度和最大程度的警告/錯誤
# 此外它們也可以設置排除在外的名字
type_name:
  min_length: 4 # 只是警告
  max_length: # 警告和錯誤
    warning: 40
    error: 50
  excluded: iPhone # 排除某個名字
variable_name:
  min_length: # 只有最小長度
    error: 4 # 只有錯誤
  excluded: # 排除某些名字
    - id
    - URL
    - GlobalAPIKey
reporter: "xcode" # 報告類型 (xcode, json, csv, checkstyle)

附錄:

原文鏈接：https://github.com/realm/SwiftLint/blob/master/README.md
譯文鏈接：https://github.com/realm/SwiftLint/blob/master/README_CN.md

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

  • 所有文章已搬遷到個人站點：me.harley-xk.studio，歡迎訪問留言 原由 最近跟著公司大佬在做 Lar...
    群星隕落閱讀 8,814評論 12贊 40
  • 高一時，我通過網(wǎng)絡遇到了我的初戀，初嘗愛情的我愛他愛的轟轟烈烈如癡如醉，盡管我從未見過他，甚至連一張真實的照片也不...
    不得意也須盡歡閱讀 378評論 0贊 0
  • 深圳有句著名的話叫：來了就是深圳人！然而有許多人也同樣認可這句話：你在這里買房定居了，才真的是深圳人，不然就是一個...
    落腳山下閱讀 386評論 0贊 0
  • 自從玩起了公眾號，簡書就處于半遺棄狀態(tài) 我不得不承認，喜新厭舊這件事兒，嗯，屢試不爽 始終不相信這個世界上會有別人...
    你說我聽好么閱讀 185評論 0贊 0
  • 我想能夠敢于說出這句話的人都是灑脫的，但是辭職后的狀態(tài)又都是焦慮的，除非你是富二代，不然誰都會馬上要面臨一個問題：...
    劉小松閱讀 1,307評論 3贊 6

友情鏈接更多精彩內(nèi)容