简介
SwiftLint 是一个用于强制检查 Swift 代码风格和规定的一个工具,基本上以 Ray Wenderlich’s Swift 代码风格指南为基础。 本文仅备忘操作概要
安装
若要把swiftlint工具高效利用起来, 终端必须得安装$ brew install swiftlint
特殊说明: 升级macOS Big Sur后homebrew失效了
执行$ brew update-reset
, $ brew list
即可
项目安装, 参考官方全局配置即可. Build Phases
下添加New Run Script Phase
1 | Shell /bin/sh |
使用
仅如上面配置安装后, 立即运行项目, 肯定是一堆错误和警告.
当发现执行 $ swiftlint lint
, $ swiftlint autocorrect
后, 还是有很多错误和警告无法修正, 关键是还包括了 Pods里面三方库的.
接着就只能自定义风格规范了, 按官方文档规定
嵌套配置
SwiftLint 支持通过嵌套配置文件的方式来对代码分析过程进行更加细致的控制。
- 在你需要的目录引入 .swiftlint.yml。
- 在目录结构必要的地方引入额外的 .swiftlint.yml 文件。
- 每个文件被检查时会使用在文件所在目录下的或者父目录的更深层目录下的配置文件。否则根配置文件将会生效。
- excluded 和 included 在嵌套结构中会被忽略。
创建文件; cd
到项目根目录, $vim .swiftlint.yml
, 路径大致如下
1 | . |
模板可以参考官方, 或者 .swiftlint.yml
注意
1.swiftlint规则可以使用$ swiftlint rules
查看, 或者参考下面的对照表中文翻译.
2.项目目录下校验自定义规则yml文件适用指令: $ swiftlint lint --config .swiftlint.yml
指令
常用指令备忘:
终端使用
$ swiftlint rules
$ swiftlint autocorrect
$ swiftlint lint --config .swiftlint.yml
项目内使用
1 | /// 在代码中关闭某个规则 |
参考
- 本文作者: 醉疏狂
- 本文链接: https://hubin97.github.io/2021/10/22/Swiftlint/
- 版权声明: 本博客所有文章除特别声明外,均采用 MIT 许可协议。转载请注明出处!