簡(jiǎn)介

SwiftLint 是 realm 公司開(kāi)發(fā)的一個(gè)插件，用于強(qiáng)制檢查 Swift 代碼風(fēng)格和規(guī)則的一個(gè)工具。
SwiftLint 的工作原理是檢查 Swift 代碼編譯過(guò)程中的 AST 和 SourceKit 環(huán)節(jié)，從而可以擺脫不同版本 Swift 語(yǔ)法變化的影響。AST 是編譯前端形成的抽象語(yǔ)法樹(shù)（Abstract Symbolic Tree）， SourceKit 過(guò)程用來(lái)對(duì) AST 進(jìn)行代碼優(yōu)化，減少內(nèi)存開(kāi)銷(xiāo)，提高執(zhí)行效率。

安裝

1. 使用 Homebrew:
brew install swiftlint

2. 使用 CocoaPods:
將如下代碼添加到你的 Podfile 即可：
pod 'SwiftLint'

3. 使用安裝包:
通過(guò)從 最新的 GitHub 發(fā)布地址 下載 SwiftLint.pkg 然后執(zhí)行的方式安裝 SwiftLint。

用法

1. Xcode:
在 Xcode-Project-Build Phases-+(New Run Script Phase) 中添加一個(gè)新的 Script Phase 并且包含如下代碼即可：

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

swiftlintScript.png

2. 命令行:
在有需要執(zhí)行代碼分析的 Swift 源碼文件的目錄下執(zhí)行 swiftlint 命令，會(huì)對(duì)目錄遞歸查找。

$ swiftlint help
   autocorrect  Automatically correct warnings and errors
   help         Display general or command-specific help
   lint         Print lint warnings and errors for the Swift files in the current directory (default command)
   rules        Display the list of rules and their identifiers
   version      Display the current version of SwiftLint

規(guī)則

1. 終端執(zhí)行命令: swiftlint rules 或者 官方文檔: rule-directory

opt-in:  為 yes 時(shí)，規(guī)則默認(rèn)不生效，需要添加進(jìn)配置的 opt_in_rules 時(shí)生效
correctable: 為 yes 時(shí)，執(zhí)行 swiftlint autocorrect 命令，會(huì)自動(dòng)修改代碼格式為正確的格式
enabled in your config: 為 yes 時(shí)，規(guī)則默認(rèn)生效，不需要額外配置
kind: 規(guī)則類(lèi)型，僅用于規(guī)則的分類(lèi) 
analyzer: 為 yes 時(shí)，可在 Xcode 的 Analyze 生效
configuration: 支持配置的屬性默認(rèn)值。例： warning 代表不符合代碼規(guī)則時(shí)，編譯器會(huì)警告。可在配置文件中改成 error，編譯器會(huì)報(bào)錯(cuò)

rules 列表詳見(jiàn)文章底部 附錄 1. swiftlint rules

2. 規(guī)則開(kāi)啟與關(guān)閉
可以通過(guò)在一個(gè)源文件中定義一個(gè)如下格式的注釋來(lái)關(guān)閉某個(gè)規(guī)則：
// swiftlint:disable <rule>
在該文件結(jié)束之前或者在定義如下格式的匹配注釋之前，這條規(guī)則都會(huì)被禁用：
// swiftlint:enable <rule>
也可以通過(guò)添加 :previous, :this 或者 :next 來(lái)使關(guān)閉或者打開(kāi)某條規(guī)則的命令分別應(yīng)用于前一行，當(dāng)前或者后一行代碼。

// 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

配置

在需要執(zhí)行 SwiftLint 的目錄下添加一個(gè) .swiftlint.yml 文件的方式來(lái)配置 SwiftLint?？梢员慌渲玫膮?shù)有：

• disabled_rules: 關(guān)閉某些默認(rèn)開(kāi)啟的規(guī)則。
• opt_in_rules: 一些規(guī)則是可選的，添加到這里才會(huì)生效。
• only_rules: 不可以和 disabled_rules 或者 opt_in_rules 并列。類(lèi)似一個(gè)白名單，只有在這個(gè)列表中的規(guī)則才是開(kāi)啟的。

disabled_rules: # 執(zhí)行時(shí)排除掉的規(guī)則
  - colon
opt_in_rules: # 一些規(guī)則僅僅是可選的
  - empty_count
included: # 執(zhí)行 linting 時(shí)包含的路徑。
  - Source
excluded: # 執(zhí)行 linting 時(shí)忽略的路徑。 優(yōu)先級(jí)比 `included` 更高。
  - Carthage
force_cast: warning # 隱式
force_try:
  severity: warning # 顯式
type_body_length: # 可以通過(guò)一個(gè)數(shù)組同時(shí)進(jìn)行隱式設(shè)置
  - 300 # warning
  - 400 # error
file_length: # 或者也可以同時(shí)進(jìn)行顯式設(shè)置
  warning: 500
  error: 1200

reporter: "xcode" # 報(bào)告類(lèi)型 (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging)

自定義規(guī)則

在配置文件 .swiftlint.yml 里定義基于正則表達(dá)式的自定義規(guī)則：

custom_rules:
  pirates_beat_ninjas: # 規(guī)則標(biāo)識(shí)符
    name: "Pirates Beat Ninjas" # 規(guī)則名稱(chēng)，可選
    regex: "([nN]inja)" # 匹配的模式
    match_kinds: # 需要匹配的語(yǔ)法類(lèi)型，可選
      - comment
      - identifier
    message: "Pirates are better than ninjas." # 提示信息，可選
    severity: error # 提示的級(jí)別，可選
  no_hiding_in_strings:
    regex: "([nN]inja)"
    match_kinds: string

輸出大概可能是這個(gè)樣子的：

custom_rules

嵌套配置

SwiftLint 支持通過(guò)嵌套配置文件的方式來(lái)對(duì)代碼分析過(guò)程進(jìn)行更加細(xì)致的控制。

1. 在你需要的目錄引入 .swiftlint.yml。
2. 在目錄結(jié)構(gòu)必要的地方引入額外的 .swiftlint.yml 文件。
3. 每個(gè)文件被檢查時(shí)會(huì)使用在文件所在目錄下的或者父目錄的更深層目錄下的配置文件。否則根配置文件將會(huì)生效。
4. excluded 和 included 在嵌套結(jié)構(gòu)中會(huì)被忽略。

自動(dòng)更正

SwiftLint 可以自動(dòng)修正某些錯(cuò)誤，磁盤(pán)上的文件會(huì)被一個(gè)修正后的版本覆蓋。
請(qǐng)確保在對(duì)文件執(zhí)行 swiftlint autocorrect 之前有對(duì)它們做過(guò)備份，否則的話(huà)有可能導(dǎo)致重要數(shù)據(jù)的丟失。
因?yàn)樵趫?zhí)行自動(dòng)更正修改某個(gè)文件后很有可能導(dǎo)致之前生成的代碼檢查信息無(wú)效或者不正確，所以當(dāng)在執(zhí)行代碼更正時(shí)標(biāo)準(zhǔn)的檢查是無(wú)法使用的。

SwiftLint rules 原理

SwiftLint rules 的源碼在 Source/SwiftLintFramework/Rules 目錄下，以 OverriddenSuperCallRule(方法需要調(diào)用 super method) 為例解讀源碼，路徑為：/Source/SwiftLintFramework/Rules/Lint/OverriddenSuperCallRule.swift。
| overridden_super_call | yes | no | no | lint | no | warning, excluded: [], included: [“*"] |
主要看 validate(file:kind:dictionary:) 方法，在方法中使用了 configuration、SourceKittenDictionary。
configuration: OverriddenSuperCallConfiguration

public struct OverriddenSuperCallConfiguration: RuleConfiguration, Equatable {
    private let defaultIncluded = [
        "addChildViewController(_:)",
        "didReceiveMemoryWarning()",
        "removeFromParentViewController()",
        "viewDidAppear(_:)",
        "viewDidDisappear(_:)",
        "viewDidLoad()",
        "viewWillAppear(_:)",
        "viewWillDisappear(_:)",
        ...
    ]
    var severityConfiguration = SeverityConfiguration(.warning)
    var excluded: [String] = []
    var included: [String] = ["*"]
    public private(set) var resolvedMethodNames: [String]
    init() {
        resolvedMethodNames = defaultIncluded
    }
    public var consoleDescription: String {
        return severityConfiguration.consoleDescription +
            ", excluded: \(excluded)" +
            ", included: \(included)"
    }
    public mutating func apply(configuration: Any) throws {
        guard let configuration = configuration as? [String: Any] else {
            throw ConfigurationError.unknownConfiguration
        }
        if let severityString = configuration["severity"] as? String {
            try severityConfiguration.apply(configuration: severityString)
        }
        if let excluded = [String].array(of: configuration["excluded"]) {
            self.excluded = excluded
        }
        if let included = [String].array(of: configuration["included"]) {
            self.included = included
        }
        resolvedMethodNames = calculateResolvedMethodNames()
    }
    public var severity: ViolationSeverity {
        return severityConfiguration.severity
    }
    private func calculateResolvedMethodNames() -> [String] {
        var names: [String] = []
        if included.contains("*") && !excluded.contains("*") {
            names += defaultIncluded
        }
        names += included.filter({ $0 != "*" })
        names = names.filter { !excluded.contains($0) }
        return names
    }
}

• defaultIncluded: 默認(rèn)的配置，里面有一些方法名。
• severityConfiguration: 規(guī)則沖突提示級(jí)別
• excluded: 需要排除的方法
• included：需要包含的方法
• func apply(configuration: Any): 應(yīng)用自定義的配置
• calculateResolvedMethodNames(): 綜合配置

SourceKittenDictionary 使用 [String: SourceKitRepresentable] 初始化。
[String: SourceKitRepresentable] 是 sourcekitten structure --file SourcekittenDemoViewController.swift 命令生成的 json 對(duì)象。詳看: sourcekitten_structure.json
SourceKittenDictionary

public struct SourceKittenDictionary {
   init(_ value: [String: SourceKitRepresentable]) {…}
…

以 SourcekittenDemoViewController.swift 為例：

class SourcekittenDemoViewController: UIViewController {
    private var testVar: String?
    override func viewDidLoad() {
        super.viewDidLoad()
        self.view.backgroundColor = UIColor.lightGray
        testVar = "i am testVar"
    }
}

sourcekitten_structure.json

{
  "key.diagnostic_stage" : "source.diagnostic.stage.swift.parse",
  "key.length" : 414,
  "key.offset" : 0,
  "key.substructure" : [
    {
      "key.accessibility" : "source.lang.swift.accessibility.internal",
      "key.bodylength" : 189,
      "key.bodyoffset" : 223,
      "key.elements" : [
        {
          "key.kind" : "source.lang.swift.structure.elem.typeref",
          "key.length" : 16,
          "key.offset" : 205
        }
      ],
      "key.inheritedtypes" : [
        {
          "key.name" : "UIViewController"
        }
      ],
      "key.kind" : "source.lang.swift.decl.class",
      "key.length" : 246,
      "key.name" : "SourcekittenDemoViewController",
      "key.namelength" : 30,
      "key.nameoffset" : 173,
      "key.offset" : 167,
      "key.substructure" : [
        {
          "key.accessibility" : "source.lang.swift.accessibility.private",
          "key.attributes" : [
            {
              "key.attribute" : "source.decl.attribute.private",
              "key.length" : 7,
              "key.offset" : 228
            }
          ],
          "key.kind" : "source.lang.swift.decl.var.instance",
          "key.length" : 20,
          "key.name" : "testVar",
          "key.namelength" : 7,
          "key.nameoffset" : 240,
          "key.offset" : 236,
          "key.setter_accessibility" : "source.lang.swift.accessibility.private",
          "key.typename" : "String?"
        },
        {
          "key.accessibility" : "source.lang.swift.accessibility.internal",
          "key.attributes" : [
            {
              "key.attribute" : "source.decl.attribute.override",
              "key.length" : 8,
              "key.offset" : 261
            }
          ],
          "key.bodylength" : 120,
          "key.bodyoffset" : 290,
          "key.kind" : "source.lang.swift.decl.function.method.instance",
          "key.length" : 141,
          "key.name" : "viewDidLoad()",
          "key.namelength" : 13,
          "key.nameoffset" : 275,
          "key.offset" : 270,
          "key.substructure" : [
            {
              "key.bodylength" : 0,
              "key.bodyoffset" : 317,
              "key.kind" : "source.lang.swift.expr.call",
              "key.length" : 19,
              "key.name" : "super.viewDidLoad",
              "key.namelength" : 17,
              "key.nameoffset" : 299,
              "key.offset" : 299
            }
          ]
        }
      ]
    }
  ]
}

validate(file:kind:dictionary:)

func validate(file: SwiftLintFile, kind: SwiftDeclarationKind,
          dictionary: SourceKittenDictionary) -> [StyleViolation] {
             guard let offset = dictionary.bodyOffset,
                       let name = dictionary.name,
                   kind == .functionMethodInstance,
                       configuration.resolvedMethodNames.contains(name),
                   dictionary.enclosedSwiftAttributes.contains(.override)
       else { return [] }
              let callsToSuper = dictionary.extractCallsToSuper(methodName: name)
              if callsToSuper.isEmpty {
                 …
                 "Method '\(name)' should call to super function"
              } else if callsToSuper.count > 1 {
                 ...
                 "Method '\(name)' should call to super only once"
              }
              return []
}

public struct SourceKittenDictionary {
…
internal func extractCallsToSuper(methodName: String) -> [String] {
    guard let methodNameWithoutArguments = methodName.split(
separator: "(").first else { return [] }
    let superCall = “super.\(methodNameWithoutArguments)"
    return substructure.flatMap { elems -> [String] in
        guard let type = elems.expressionKind,
        let name = elems.name,
        type == .call && superCall == name else {
            return elems.extractCallsToSuper(
methodName: methodName)}
        return [name]}}
}

validate(file:kind:dictionary:) 通過(guò)判斷：

方法 == 含有 .override 屬性的實(shí)例方法 && 
methodName 在配置列表中 &&
Substructure 中表達(dá)式類(lèi)型是 .call && 
Substructure 中方法調(diào)用名稱(chēng) == super.{methodName}

滿(mǎn)足上述條件的方法內(nèi)若沒(méi)有調(diào)用對(duì)應(yīng)的 super 方法，或者
調(diào)用了多次對(duì)應(yīng)的 super 方法，就會(huì)提示規(guī)則沖突。

問(wèn)：sourcekitten 是什么？
答：SourceKitten 是基于 Apple 的 SourceKit 封裝的命令行工具，SourceKitten 鏈接并與 sourcekitd.framework 通信以解析 Swift AST，最終提取 Swift 或 ObjC 文件的類(lèi)結(jié)構(gòu)和方法等。
sourcekitten 支持的命令如下：

SUBCOMMANDS:
  complete                Generate code completion options
  doc                     Print Swift or Objective-C docs as JSON
  format                  Format Swift file
  index                   Index Swift file and print as JSON
  module-info          Obtain Swift module information and print as json
  request                 Run a raw SourceKit request
  structure               Print Swift structure information as JSON
  syntax                  Print Swift syntax information as JSON
  version                 Display the current version of SourceKitten

問(wèn)：SourceKit 是什么？
答：SourceKit 是一套工具集，使得大多數(shù) Swift 源代碼層面的操作特性得以支持，例如源代碼解析、語(yǔ)法高亮、排版（typesetting）、自動(dòng)補(bǔ)全、跨語(yǔ)言頭文件生成，等等

問(wèn)：Swift AST 是什么？
答：AST(Abstract Syntax Tree 抽象語(yǔ)法樹(shù)) 是源代碼的抽象語(yǔ)法結(jié)構(gòu)的樹(shù)狀表示，樹(shù)上的每個(gè)節(jié)點(diǎn)都表示源代碼中的一種結(jié)構(gòu)，是 Swift 文件編譯過(guò)程中的產(chǎn)物。

Swift 文件編譯過(guò)程:

Swift 文件編譯過(guò)程

image.png

Swiftc 生成 AST：
Swiftc 是 swift 語(yǔ)言的編譯工具，它可以直接把 .swift 文件編譯生成可執(zhí)行文件，也可以產(chǎn)生編譯過(guò)程中某個(gè)中間文件。Swiftc 支持命令如下：

MODES:
  -dump-ast              Parse and type-check input file(s) and dump AST(s)
  -dump-parse            Parse input file(s) and dump AST(s)
  -emit-assembly         Emit assembly file(s) (-S)
  -emit-executable       Emit a linked executable
  -emit-ir               Emit LLVM IR file(s)
  -emit-sibgen           Emit serialized AST + raw SIL file(s)
  -emit-sib              Emit serialized AST + canonical SIL file(s)
  -emit-silgen           Emit raw SIL file(s)
  -emit-sil              Emit canonical SIL file(s)
  -parse                 Parse input file(s)
  -print-ast             Parse and type-check input file(s) and pretty print AST(s)
  -typecheck             Parse and type-check input file(s)
...

swiftc -dump-parse SourcekittenDemoViewController.swift

(source_file "SourcekittenDemoViewController.swift"
  (import_decl range=[SourcekittenDemoViewController.swift:9:1 - line:9:8] 'UIKit')
  (class_decl range=[SourcekittenDemoViewController.swift:11:1 - line:18:1] "SourcekittenDemoViewController" inherits: <null>
    (pattern_binding_decl range=[SourcekittenDemoViewController.swift:12:13 - line:12:32]
      (pattern_typed
        (pattern_named 'testVar')
        (type_optional
          (type_ident
            (component id='String' bind=none)))))
    (var_decl range=[SourcekittenDemoViewController.swift:12:17 - line:12:17] "testVar" type='<null type>' readImpl=stored writeImpl=stored readWriteImpl=stored)
    (func_decl range=[SourcekittenDemoViewController.swift:13:14 - line:17:5] "viewDidLoad()"
      (parameter "self")
      (parameter_list range=[SourcekittenDemoViewController.swift:13:30 - line:13:31])
      (brace_stmt range=[SourcekittenDemoViewController.swift:13:33 - line:17:5]
        (call_expr type='<null>' arg_labels=
          (unresolved_dot_expr type='<null>' field 'viewDidLoad' function_ref=unapplied
            (super_ref_expr type='<null>'))
          (tuple_expr type='()' location=SourcekittenDemoViewController.swift:14:26 range=[SourcekittenDemoViewController.swift:14:26 - line:14:27]))
        (sequence_expr type='<null>'
          (unresolved_dot_expr type='<null>' field 'backgroundColor' function_ref=unapplied
            (unresolved_dot_expr type='<null>' field 'view' function_ref=unapplied
              (declref_expr type='<null>' decl=SourcekittenDemoViewController.(file).SourcekittenDemoViewController.viewDidLoad().self@SourcekittenDemoViewController.swift:13:19 function_ref=unapplied)))
          (assign_expr type='<null>'
            (**NULL EXPRESSION**)
            (**NULL EXPRESSION**))
          (unresolved_dot_expr type='<null>' field 'lightGray' function_ref=unapplied
            (unresolved_decl_ref_expr type='<null>' name=UIColor function_ref=unapplied)))
        (sequence_expr type='<null>'
          (unresolved_decl_ref_expr type='<null>' name=testVar function_ref=unapplied)
          (assign_expr type='<null>'
            (**NULL EXPRESSION**)
            (**NULL EXPRESSION**))
          (string_literal_expr type='<null>' encoding=utf8 value="i am testVar" builtin_initializer=**NULL** initializer=**NULL**))))))

通過(guò)生成的 AST 信息可以看到 import_decl、class_decl、var_decl、func_decl、brace_stmt、call_expr 等及所在的行列數(shù)。sourcekit 可以通過(guò)這些信息實(shí)現(xiàn)語(yǔ)法高亮、排版、自動(dòng)補(bǔ)全、跨語(yǔ)言頭文件生成，等等

提醒 執(zhí)行 swiftc -print-ast SourcekittenDemoViewController.swift 命令時(shí)，終端會(huì)報(bào)錯(cuò) SourcekittenDemoViewController.swift:9:8: error: no such module 'UIKit' .
為解決此報(bào)錯(cuò)，需要指定 -sdk 和 -target 參數(shù)，如下：
swiftc -print-ast SourcekittenDemoViewController.swift -sdk /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS15.5.sdk -target arm64-apple-ios15.5
"15.5" 需要根據(jù)本地支持的版本做修改。

SwiftLint 規(guī)則建議

Swiftlint 規(guī)則沒(méi)有完全符合每個(gè)工程期望的統(tǒng)一規(guī)則?；陧?xiàng)目應(yīng)用上面，我得出一些經(jīng)驗(yàn)教訓(xùn)，在此給出一點(diǎn)建議：

1. 成熟的項(xiàng)目規(guī)則宜松不宜緊。規(guī)則過(guò)多或過(guò)嚴(yán)會(huì)直接導(dǎo)致產(chǎn)生較多警告，改動(dòng)太耗時(shí)間，產(chǎn)生大量提交。萬(wàn)一修改出了錯(cuò)誤，查起來(lái)也會(huì)非常麻煩。
2. 可糾正代碼 bug 的規(guī)則，建議提示級(jí)別為 error，而非 warning。如此可及時(shí)提醒修正錯(cuò)誤。
   例如： OverriddenSuperCallRule 規(guī)則可用于避免遺漏調(diào)用 super 方法，從而避免工程中對(duì)此方法的 hook 不生效。
   例如: DiscardedNotificationCenterObserverRule 規(guī)則可用于避免因?yàn)槲闯钟?observer，不能釋放內(nèi)存，從而導(dǎo)致內(nèi)存泄露的 bug。
3. 推薦 swift 寫(xiě)法的規(guī)則建議使用。
   例如：使用 CGPoint(x:y:) 代替 CGPointMake(,)

基于上面三條建議，制定的規(guī)則示例如下：

only_rules:
  - block_based_kvo # Swift 3.2 之后使用新的 KVO API
  - compiler_protocol_init # 不應(yīng)該直接調(diào)用字面量轉(zhuǎn)換的初始化方法
  - control_statement # if while 等判斷條件不要用括號(hào)括起來(lái)
  - custom_rules # 一些自定義規(guī)則
  - discarded_notification_center_observer # 當(dāng)使用 block 注冊(cè)通知中心 observer 的時(shí)候，應(yīng)該存儲(chǔ)函數(shù)返回的 observer, 以便之后的刪除
  - discouraged_optional_boolean # 不建議使用可選布爾值
  - duplicate_imports # 重復(fù)導(dǎo)入
  - duplicate_enum_cases # 枚舉不能設(shè)置兩個(gè)或者以上相同的名字
  - empty_count
  - empty_string # 優(yōu)先使用 isEmpty 判斷，而不是將字符串與空字符串文字進(jìn)行比較
  - empty_parameters # 閉包參數(shù)為空時(shí),建議使用 `() -> ` 代替 `Void ->
  - explicit_init # 避免直接調(diào)用 init 方法
  - fallthrough # switch 語(yǔ)句中不建議使用 fallthrough
  - fatal_error_message # fatalError 必須擁有一個(gè) message
  - file_name_no_space # 文件名不應(yīng)包含任何空格
  - force_cast # 不建議直接強(qiáng)解類(lèi)型
  - force_try # 避免 `try!`
  - force_unwrapping # 避免強(qiáng)制解包
  - identical_operands # 比較兩個(gè)相同的操作數(shù)可能是一個(gè)錯(cuò)誤
  - legacy_cggeometry_functions # 避免使用 C 風(fēng)格的 CG 遺留函數(shù)，使用 struct extension
  - legacy_constructor # 使用 swift 提供的 struct 構(gòu)造函數(shù)， 避免使用遺留的構(gòu)造函數(shù)比如 CGPointMake(10, 10)
  - legacy_nsgeometry_functions # 避免使用 C 風(fēng)格的 NS 遺留函數(shù)，使用 struct extension
  - literal_expression_end_indentation # 數(shù)組和字典文字的結(jié)尾應(yīng)與開(kāi)始它的行具有相同的縮進(jìn)
  - lower_acl_than_parent # 確保定義的訪問(wèn)控制級(jí)別低于其父級(jí)
  - mark # 正確使用 mark 的格式 `// MARK: - message`
  - multiline_parameters # 函數(shù)和方法參數(shù)應(yīng)該在同一行上，或者每行一個(gè)
  - no_extension_access_modifier # 在 extension 擴(kuò)展前面,不建議使用 (fileprivate,public) 等修飾符
  - redundant_objc_attribute # Objective-C 屬性（@objc）在聲明中是多余的
  - redundant_optional_initialization # 不需要寫(xiě)默認(rèn)值為 nil
  - redundant_string_enum_value # 字符串類(lèi)型枚舉，會(huì)有默認(rèn) string 值，與名字相同，不要再次設(shè)置
  - redundant_void_return # 在不必要的時(shí)候， 不需要寫(xiě) ->() and -> Void
  - return_arrow_whitespace # 函數(shù)定義返回的 ->  前后有空格， 不換行
  - switch_case_alignment # Case 語(yǔ)句應(yīng)與其封閉的 switch 語(yǔ)句垂直對(duì)齊，如果沒(méi)有其他配置，則縮進(jìn)
  - trailing_semicolon # 行末尾不加分號(hào)
  - type_name # 類(lèi)型名字限制規(guī)則（類(lèi)型名稱(chēng)應(yīng)僅包含字母數(shù)字字符，以大寫(xiě)字符開(kāi)頭，長(zhǎng)度在 3 到 40 個(gè)字符之間）
  - unneeded_break_in_switch # 在 switch-case 語(yǔ)句中, 有方法調(diào)用或操作時(shí),避免使用 break 語(yǔ)句
  - unowned_variable_capture # 最好將引用捕獲為弱引用以避免潛在的崩潰
  - void_return # 使用 `-> Void` 代替 `-> ()
  - weak_delegate # delegate 應(yīng)該被設(shè)置為 weak

excluded: # paths to ignore during linting. Takes precedence over `included`.
  - Tests
  - Example
  - Resources

force_cast:
  severity: warning
  
force_try:
  severity: warning

no_extension_access_modifier:
  severity: warning
  
empty_count:
  severity: warning

type_name:
  min_length: 1
  max_length: 60

overridden_super_call:
  severity: error

prohibited_super_call:
  severity: error
  
discarded_notification_center_observer:
  severity: error

weak_delegate:
  severity: error

unowned_variable_capture:
  severity: error

reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit, html, emoji, sonarqube, markdown)

custom_rules:
  ab_test_recovery:
    name: "AB Test Recovery"
    regex: '^ *//+[ \S]* ABTestHelper\.+'
    match_kinds:
      - comment
      - doccomment
    message: "AB Test Recovery. 調(diào)試期間注釋掉的 ab test,上線(xiàn)前記得恢復(fù)"
    severity: warning
  url_Check:
    name: "URL Check"
    regex: '(https?|ftp|file)://[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]+[()（）]'
    match_kinds: string
    message: "URL 中發(fā)現(xiàn)有 '(' 或 ')' 或 '（' 或 '）' ，請(qǐng)注意確認(rèn)正確性"
    severity: warning

附錄

1. swiftlint rules

參考文獻(xiàn)

1. SwiftLint
2. SwiftLint 的理解和使用
3. rule-directory
4. AST
5. LLVM優(yōu)點(diǎn)
6. How a Swift file is compiled
7. SwiftSyntax詳解
8. 使用“swiftc”命令編譯swift文件時(shí)如何導(dǎo)入像“UIKit”這樣的模塊？