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)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,039评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,426评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,417评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,868评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,892评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,692评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,416评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,326评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,782评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,957评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,102评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,790评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,442评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,996评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,113评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,332评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,044评论 2 355