SwiftLint 的理解和使用

SwiftLint 是 realm 公司开发的一个插件，专门用于管理 Swift 代码的规范。Swift 是 Apple 在 2014 年推出的用于 Apple 系列产品开发的新一代编程语言，目标是取代原来的 Object-C . 和其他编程语言，比如 C、Java、Python 等一样，Swift 中也规定了基本的编码规范，用于定义采用 Swift 编程时， 对于「美」的倾向。基本标准已经在git 开源Swift 编程官网规范。realm 公司开发 SwiftLint 插件，就是用来规范开发者在编程时对 Swift 规范进行贯彻执行。

这里简要介绍下 realm 公司。它主要的开发产品是用于移动端的数据库，可以跨多个现有的移动端系统（Android/iOS 等），API 简单易用，而且效率较高， 号称现在拥有 10 亿用户。它诞生于美国著名孵化器 Y combinator （就是年初从百度辞职的副董事长陆奇新加入的公司）项目。

SwiftLint 的工作原理是检查 Swift 代码编译过程中的 AST 和 SourceKit 环节，从而可以摆脱不同版本 Swift 语法变化的影响。AST 是编译前端形成的抽象语法书（Abstract Symbolic Tree）， SourceKit 过程用来对 AST 进行代码优化，减少内存开销，提高执行效率。如果对编译过程理解不太清楚，可以参考：AST 和 LLVM优点

SwiftLint 安装方式很简单，在 mac 上使用第三方包管理工具 homebrew ，执行brew install swiftlint 命令即可。如果想要在不同的 Xcode 项目使用不同版本的 SwiftLint ，可以采用 cocoapods 进行集成的方式。

1 pod 'SwiftLint'
2 添加Run Script脚本 
"${PODS_ROOT}/SwiftLint/swiftlint"

集成成功后，在编译之后，会自动执行 Swift 语法规范的检查。可以在工程根目录下，配置 .swiftlint.yml 文件, 对本工程定制 Swift 语法。下面是我在工程中使用的配置：

reporter: "xcode"

#排除的文件
excluded:
    - Pods
#使用规则的文件
included:

#禁用的规则
disabled_rules:
    #- trailing_whitespace

#修改默认规则
line_length:
    warning: 80
    ignores_function_declarations: true
    ignores_comments: true

vertical_whitespace:
    max_empty_lines: 4

如果想要增删更多规则，已经对规则进行定制修改，可以在命令行 terminal 中使用 swiftlint 命令查看 SwiftLint 插件规定的所有规则。

更详细的配置，可以参考官网文档：SwiftLint

参考：
1 https://github.com/realm/SwiftLint/blob/master/README_CN.md
2 https://www.cnblogs.com/zuopeng/p/4141467.html
3 https://www.infoq.cn/article/what-is-llvm-the-power-behind-swift-rust-clang-and-more
4 https://github.com/Artwalk/swift-style-guide/blob/master/README_CN.md

喜欢和关注都是对我的鼓励和支持~