SwiftLint简介

在Swift开发中,为了保持代码风格统一、降低低级问题、提升codeReview的效率,我们可以通过SwiftLint
)来进行静态检测,尽早的发现和解决问题并养成良好的代码习惯。
SwiftLint是用于强制检查Swift代码风格和规定,基于Swift官方的Guide由Realm公司开发的一款工具。

一、可以通过以下几种方式来安装SwiftLint:

1、HomeBrew进行全局安装:
1)需提前安装好HomeBrew,然后在终端执行

brew install SwiftLint

2)安装完swiftlint后需要在Xcode中添加脚本

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

2、Pod进行局部安装:
1)需提前安装CocoPods,然后在终端执行

pod 'SwiftLint'

2)在Xcode中添加脚本配置

"${PODS_ROOT}/SwiftLint/swiftlint"

3)其他方式
也可通过Mint安装,或把SwiftLint发布的安装包倒入,或者编译SwiftLint源代码的方式来实现

二、规则添加

其实完成上述的安装配置后,已经实现了对代码的静态检测,有不合规范的地方就会出现warning或者error。但是在实际项目开发中,有一些特殊的规范要求,例如只针对某个模块生效、仅不针对某个模块生效、添加新的规则、修改默认规则等等,我们都可以进行自定义。
首先进入项目文件夹,在终端执行

touch .swiftlint.yml

接着进入项目文件夹,按 Command + Shift + . 会显示隐藏的文件,此时会看到刚刚创建的.swiftlint.yml文件,打开后即可通过写入命令来定制规则(注意这个文件所在的层级目录,会影响它的作用范围,一般放到项目根目录即可)。可以在这里查看具体的规则详情。
opt_in_rules默认是关闭的,如果需要支持某些非默认的规则,那么需要在配置文件中打开它们。比如,禁止强解包就需要在这里实现。

excluded:  # 不针对以下路径的文件进行检测
  - Test/Test/ThirdParty

included: # 检测以下路径的文件
  - Test

disabled_rules: # 以下规则不生效
  - line_length
  - todo

# rules that have both warning and error levels, can set just the warning level
line_length: 120  # 一行的字符长度不超过120个,否则会有warning

file_length:  # 文件行数超过500行会有warning,超过1200行会有error
  warning: 500
  error: 1200

opt_in_rules: # 禁止强解包
  - force_unwrapping
force_unwrapping:
  severity: error
三、自动校准代码规范问题

1、通过SwiftLint校正部分代码规范问题

swiftlint autocorrect // 校正空格导致的问题

但是上面命令局限性很大,只有Rules里Supports autocorrection: Yes的rules才支持自动编排,并且使用不够方便

2、通过SwiftFormat
在这里比较推荐使用SwiftFormat,它会帮助我们自动校正很懂代码规范的问题
SwiftFormat简介 - (menlosecurity.com)

备注:
Swift编码规范:swift-style-guide/README_CN.md at master · LeiHao0/swift-style-guide · GitHub

参考:
SwiftLint 的理解和使用 (menlosecurity.com)

你可能感兴趣的:(SwiftLint简介)