SwiftLint 是一款 Swift 代码 lint 工具,它可以帮助我们规范代码风格,提高代码质量。
使用 SwiftLint 的步骤:
- 安装 SwiftLint。可以通过 Homebrew 安装:
brew install swiftlint
- 在 Xcode 中生成 .swiftlint.yml 配置文件。
- 在 Build Phases 中添加 SwiftLint 运行脚本:
if which swiftlint >/dev/null; then
swiftlint
else
echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi
- 在 .swiftlint.yml 中配置规则:
yml
line_length: # 行长度限制
warning: 150
error: 200
type_body_length: # 类型声明主体长度
warning: 400
error: 500
- 运行时 SwiftLint 会自动检查代码并输出警告和错误。
- 我们需要手动修复这些问题,来达到规范代码的目的。
SwiftLint 支持的规则非常多,包括:
– 常量命名规则:lower_case_casing
– 变量命名规则:lower_camel_case
– 函数参数数量规则:max_function_params
– 空行规则:empty_lines
– 缩进规则:indent
下面是一个 SwiftLint 检查的示例:
swift
let SomeConstant = "Some value" // Error:常量应使用lower_case_casing
func doSomething(firstParam: Int, secondParam: Int) { // Warning:函数参数数量过多
let someVar = "Some value" // Error:变量应使用lower_camel_case
if someCondition { // Warning:if语句应在前一行结束
doSomething()
}