CodeReview之SwiftLint

一、前言

SwiftLint 是 Realm 推出的一款 Swift 代码规范检查工具，SwiftLint 是基于 GitHub 公布的 Swift代码规范对 Swift 代码进行检查的。
GitHub 公布的 Swift 代码规范 - 原文
GitHub 公布的 Swift 代码规范 - 中文
配置好 SwiftLint 之后，在 Xcode 中直接编译代码，SwiftLint 就会按照预先设置好的代码规范自动检查代码，不符合规范的代码就会通过警告(warning)或者报错(error)的形式指示给开发者，从而对开发者的代码进行规范。
除了 SwiftLint 自带的规则之外，开发者还可以自定义规则。同时可以禁用或启用某一些规则。

二、安装 SwiftLint

SwiftLint 可以通过 3 种方式进行安装:

通过 HomeBrew 安装
通过 CocoaPods 安装
通过 pkg 安装包安装

1、通过 Homebrew 安装【全局安装】

第一步: 安装 Homebrew （如已安装，请跳过）

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

如果出现下图所示，表示 Homebrew 安装成功。

Homebrew安装成功.png

第二步: 通过终端命令安装 SwiftLint

brew install SwiftLint

SwiftLint 安装成功.png

2、通过 CocoaPods 安装【局部安装】

通过 CocoaPods 安装，只对单个项目有效，如果想要对不同的项目使用不同的 SwiftLint 版本，这会是一种很好的解决方案。
需要注意的是使用这种方案会将整个 SwiftLint 以及它的依赖包的完整资源文件都安装到 Pods/ 目录中去，所以在使用代码版本管理工具比如 git/svn 时要注意设置忽略（ignore）相关目录。
通过 CocoaPods 安装 SwiftLint，跟安装第三方框架一样。
在项目根目录创建 Podfile

pod 'SwiftLint'

3、通过安装包安装【全局安装】

SwiftLint 还支持使用 pkg 安装包进行安装，在官方的 GitHub 页面可以找到最新发布的安装包。

SwiftLint 安装包.png

三、查看 SwiftLint 的全部命令

在终端中输入 swiftlint help

swiftlint help

SwiftLint 的全部命令.png

各个命令注释:

# Automatically correct warnings and errors
# 自动更改警告和错误（仅适用于支持自动更改的规则）
autocorrect     

# Generates markdown documentation for all rules
# 为所有规则生成 markdown 文档
generate-docs     
 
# Display general or command-specific help
# 显示通用命令或指定命令的帮助信息
help          
 
# Print lint warnings and errors (default command) 
# 打印输出所有的警告和错误
lint     

# Display the list of rules and their identifiers    
# 显示所有规则的列表以及对应的 ID   
rules      
  
# Display the current version of SwiftLint   
# 显示 SwiftLint 的当前版本号
version

四、SwiftLint 的使用

安装完成之后，需要在Xcode中配置相关设置，才能使 SwiftLint 在 Xcode 中自动检测代码规范。配置也很简单，只需要在 Xcode 的 Build Phases 中新建一个 Run Script Phase 配置项，在里面添加相关代码后,编译即可!

1、SwiftLint 脚本设置

这里分两种情况: 全局脚本的添加和局部脚本的添加。

（1）全局脚本的添加

全局脚本

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

添加全局脚本的步骤

添加全局脚本的步骤.png
如果没有安装 SwiftLint，则会报出警告，提示团队成员安装 SwiftLint

Shell Script Invocation Warning:
warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint

（2）局部脚本的添加

局部脚本

"${PODS_ROOT}/SwiftLint/swiftlint"

添加局部脚本的步骤

添加局部脚本的步骤.png
这里其实是设置了一个自动编译脚本，每次运行编译都会自动执行这个脚本。
如果正确安装了 SwiftLint，就会执行 SwiftLint 中的代码规范检查，如果没有安装，脚本会抛出一个没有安装 SwiftLint 并提示下载的错误，方便提醒团队中没有安装的成员。

Shell Script Invocation Error: 
swiftlint: No such file or directory

在没有安装 SwiftLint 的情况下，如不想直接报错，可以使用如下脚本:

"${PODS_ROOT}/SwiftLint/swiftlint"
echo "warning: ..."

2、SwiftLint 的体验

新建一个 SwiftLintDemo 的工程，配置完成后，Command + B 编译

SwiftLintDemo 新建项目.png
如图，新建项目，任何代码都没写，直接报出一堆 警告，甚至还有 错误。试想，如果是正在开发中的项目，你可能会发现你的项目提示N+的黄色警告和N+的红色错误。
通过 SwiftLintDemo，你会发现甚至一些空格和一些系统的方法和注释也会报错或者警告。
SwiftLint 默认方法名或者注释不得超过120个字符。
SwiftLint 的所有规则可以在: Rules 找到。

五、自定义配置

当我们编译一个正在开发的项目代码后，看到的 N 多的警告和错误，其实并不全都需要我们来解决，因为这里面通常包含了第三方库的代码规范问题，而且好多问题的级别都被设置成了 error。
第三方库的代码规范问题，这不是我们的问题，怎么解决？
因此，我们需要做一些设置，让 SwiftLint 在做代码规范检查的时候自动忽略 CocoaPods、Carthage 等包管理器引入的第三方库(当然，手动导入的第三方库也能设置忽略)。
上面的问题需要我们来 自定义配置文件。

1、创建配置文件

首先，需要在项目的根目录下新建一个名为 .swiftlint.yml 的配置文件。
打开终端，cd 进入项目根目录下。
输入: touch .swiftlint.yml

创建 .swiftlint.yml文件.png
执行完命令之后，在文件夹中就会有一个 .swiftlint.yml 的隐藏文件。
隐藏/显示隐藏文件的命令: Command + Shift + .

隐藏的配置文件.png
下面来认识一下主要的几个配置选项

disabled_rules: # 禁用指定的规则
  - colon
  - comma
  - control_statement
opt_in_rules: # 启用指定的规则
  - empty_count
  - missing_docs
  # 可以通过执行如下指令来查找所有可用的规则:
  # swiftlint rules
included: # 执行 linting 时包含的路径。如果出现这个 `--path` 会被忽略。
  - Source
excluded: # 执行 linting 时忽略的路径。 优先级比 `included` 更高。
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

2、在代码中关闭某个规则

可以通过在一个源文件中定义一个如下格式的注释来关闭这个规则

// swiftlint:disable <rule>

在该文件结束之前或者在定义如下格式的匹配注释之前，这条规则都会被禁用：

// swiftlint:enable <rule>

举例: viewDidLoad方法后面的圆括号 () 跟大括号 { 贴在了一起

    // swiftlint:disable opening_brace
    override func viewDidLoad(){ 
        // swiftlint:enable opening_brace
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
    }

规则关闭之前:

规则关闭之前.png

规则关闭之后:

规则关闭之后.png

也可以通过添加 :previous, :this 或者 :next 来使关闭或者打开某条规则的命令分别应用于前一行，当前或者后一行代码。

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