Swiftlint帮你定规范

前言

  • 程序员写代码总是自我感觉良好,使用插件来规范下还是很有必要的
  • Swiftlint是Realm公司的一个插件,专门用于管理Swift代码规范

以下为CocoaPods用法,如需使用全局配置传送门

部署

1、 导入Swiftlint

podfile添加:

$ pod 'SwiftLint'

2、 添加脚本

Target>Build Phases

image

3、 build起来

⚠️惊不惊喜,一堆警告和报错!


企业微信截图_098f23b6-6482-4a9e-a74d-1a8663e58

4、 添加配置文件【.swiftlint.yml】

文件目录如下:


企业微信截图_19404817-eb13-4784-8c28-1f90099e6a09

5、 去除Pods影响

企业微信截图_4d322551-75a0-4a04-a5fa-d1e9831d0457

再Build起来,是不是立竿见影😏


企业微信截图_1e81b249-e176-43cb-83b9-5a8606790e26

6、开始修改代码⚠️警告和报错

例如以下强制解包错误:


企业微信截图_b0e9e1d6-0a96-46c4-93ff-3a1022ad29a3

修改配置文件,把报错修改为警告

企业微信截图_29cce329-4eec-430b-b889-6a7896cfd13a

保存然后build起来

企业微信截图_aa29f4b7-4688-42df-9a62-86d8d9a18f11

7、 禁用指定规则

image
企业微信截图_1ef0a681-cd33-4147-b2fd-abee6e22eaae

8、 自定义配置

  • 例如自定义配置类名规范:

官方对于类名规则定义:类型名称只能包含字幕数字字符,以大小写开头,并且长度控制在4-40个字符之间

image
  • min_length: 最小长度,默认为警告
  • max_length: 最大长度,超过40警告,超过50报错
  • excluded: 排除指定字符
  • allowed_symbols: 允许类名包含指定符号

更多规则可以查看文档

9、 autocorrect

Swiftlint可以自动更正某些违规的规则,执行以下命令,自动更正并覆盖磁盘上的文件。

⚠️更正时注意备份,否则数据可能会丢失

$ swiftlint autocorrect

踩坑之路

1、 Command PhaseScriptExecution failed with a nonzero exit code

image

File>WorkSpcae Settings>Build System 修改为Legacy Build System使用记得编译系统即可。

截屏2020-03-12下午4.08.32

2、 include 文件路径错误

如果include文件路径错误,会报以下错误

image

⚠️注意官方配置模板中includeSource,这个Source需要修改为本地源文件夹名称。

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