×

Xcode 配置 Swift Lint 规范代码风格

96
萌面大道
2017.04.30 11:06* 字数 1150

Swift Lint is a tool to enforce Swift style and conventions.

Date Notes Swift Xcode
2017-04-30 首次提交 3.1 8.3.2

前言

最近一个月,文章的更新速度慢了下来,原因一是并不是所有内容都值得发表。有些纯粹熟练度的问题,大可不必浪费时间和精力作文。二是最近找了不少外文的资料,需要消化一阵子才行。另外,博客(http://maimieng.com)基本上闲置了下来,其中有多说不再支持的原因,另外 Hexo 有时也会抽风(主要是 node),而博客的主要目的在于文章,而非这些形式。所以未来会着重在简书,有些有深度的文章会发布到掘金专栏。而类似本文的记录型文章仅发布在此,目的主要是为了给自己提醒。另外有些文章可能会随着时间而有一些内容变更,因此从今往后的文章开头会有文章迭代的版本信息。以往的文章会在后续若有更新时进行调整,另外也会保证掘金和简书文章内容的同步。其实也有意向在未来更新英文版于 Medium。

realm/SwiftLint 是 Realm 开源的一个加强检查 Swift 语言规范的库,满足强迫症的所有「幻想」。代码风格规范在协作开发中的重要性不言而喻。不过,由于其官方 GitHub 为英文叙述,可能对我们有一些阻碍。那么本文就简单通俗地描述一下 Swift Lint 的基本配置。

安装

  • 在官方文档中,Swift Lint 提供了四种安装方式。
  • 若要全局安装(即一次安装,所有项目均可使用)建议选择下载最新的 Release 包(.pkg)并安装。因为经我个人测试 Homebrew 的安装途中可能会出现问题,且没有找到好的解决方法,但大家也可尝试直接 brew install swiftlint
  • 全局安装之后,可以在 Terminal 输入 swiftlint version 测试是否安装成功。
  • 若要针对某个项目安装,可以在 Xcode 项目的 Podfile 中加上 pod 'SwiftLint' 并 install 即可。(推荐)
Podfile
pod 操作

使用

  • 为方便演示配置过程,新建一个 Swift-Lint-Demo 项目。
Swift-Lint Demo
  • 选择全局或 Pod 安装 Swift Lint(为演示后续操作,本机全局安装了 Swift Lint,也在项目中 Pod 安装,后续会指出两者配置的不同)。

  • 为 Xcode 添加运行脚本(Run Script Phase)。

找到如图的加号并点击
选择 New Run Script Phase
  • 在图中黑色编辑区域添加脚本(选择一种即可)。
添加脚本
  • 全局安装添加以下脚本
if which swiftlint >/dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi
  • 若安装有问题,Xcode 找不到全局的 Swift Lint 就会出现「warning: SwiftLint not installed...」的警告,那么你就需要检查是否成功的全局安装了 Swift Lint。
全局脚本
  • Pod 安装添加以下脚本
"${PODS_ROOT}/SwiftLint/swiftlint"
Pod 脚本
  • 添加完脚本之后,重新编译即可(Cmd + B),默认的空项目其实已经暗含了很多与 Swift Style 不符合的风格,如果你也受不了这么多警告和错误,那就去一个个修复它吧。
满屏的 Warning

配置

  • Swift Lint 在完成上述操作之后,便已经生效。但是,如果觉得默认的风格过于严格,或者项目组有另外的要求,Swift Lint 也可以定制相应的风格,或者禁用某些规则。
  • Swift Lint 的全部规则可以在:Source/SwiftLintFramework/Rules 目录内找到。

禁用/开启规则

Code

  • 若要禁用规则,需要首先拿到某个规则的 ID。全局安装的 Swift Lint 可以在 Terminal 输入 swiftlint rules 查看所有可获得的规则以及对应的 ID;未全局安装的 Swift Lint 也可以直接在警告或错误提示末尾的小括号中找到其对应的 ID。
  • 在代码中即可使用以下注释禁用或开启相应的规则。
// 作用于该文件该行以下(除非遇到同一规则的 enable,disable)
// swiftlint:disable <rule1> [<rule2> <rule3>...]
// swiftlint:enable <rule1> [<rule2> <rule3>...]

// eg:
// swiftlint:disable trailing_whitespace vertical_whitespace
// swiftlint:enable trailing_whitespace

// 作用于下一(next),这一(this),上一(previous)行
// 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

配置文件

  • 上述的代码中禁用/开启规则只对其文件内有效,只能用于临时的情况,若想针对项目进行自定义配置,就需要额外的配置文件 .swiftlint.yml,直接放在项目根目录即可。
# eg:
disabled_rules: # rule identifiers to exclude from running
  - trailing_whitespace

参考

也欢迎您关注我的微博 @萌面大道V & 简书

[iOS]
Web note ad 1