让XCode自动CodeReview你的代码-OCLint使用

前言

OCLint 是一个静态分析代码的工具,支持自定义规则,可以很好地帮助我们规范代码,这篇文章主要介绍通过OCLint让XCode来帮你Code Review,规范代码。
OCLint相关的详细内容也可以到OCLint官网上查看。

安装OCLint 和 xcpretty

这里需要安装OCLintxcpretty 工具

1、 安装xcpretty

gem安装xcpretty

sudo gem install xcpretty

用sudo是防止一些权限出现问题

2、安装OCLint

安装OCLint有两种常用的方法:

1)通过安装包:

从oclint的github项目链接中下载安装包oclint-0.10.3-x86_64-darwin-15.5.0.tar.gz.
解压后在当前用户的.bashrc中配置环境变量

OCLINT_HOME=/pathexport PATH=$PATH:OCLINT_HOME/bin

然后source .bashrc即可

2)通过Homebrew
brew tap oclint/formulae
brew install oclint
3)确认安装成功

运行oclint确认环境配置正确

$ oclint

如果展示以下内容即为安装成功:

oclint: Not enough positional command line arguments specified!Must specify at least 1 positional arguments: See: oclint -help

OCLint 的使用

这里介绍一些简单常用的用法,足够应对很多场景,其他详细用法可以到OCLint Manual上查看。


OCLint 有三个指令:oclintoclint-json-compilation-databaseoclint-xcodebuild

1、oclint:常规核心指令。
2、oclint-json-compilation-database:从编译好的compile_commands.json 文件中读取配置信息并执行 oclint。
3、oclint-xcodebuild:主要用于生成compile_commands.json文件,现在已经不进行维护了,我们可以用xcpretty替代,来生成json文件。

oclint指令

使用语法

oclint [options] <source> -- [compiler flags]

[options]为一些参数选项,可以是规则加载选项、报告形式选项等:

1、 -R <路径> : 检测所用的规则的路径,默认路径$(/path/to/bin/oclint)/../lib/oclint/rules
2、-disable-rule <规则名>: 让相对应的规则失效(OCLint 规则列表)。
3、-rc <参数>=<值> :修改阈值
4、-report-type <报告类型>,有"text"、“html”、“json”、“pmd”、“xcode”几个类型
5、-o <路径> 报告生成路径。

eg:

oclint  -R  /path/to/rules   -disable-rule ObjCAssignIvarOutsideAccessors -report-type xcode 
oclint-json-compilation-database 指令

这是我们主要用到的指令,它是oclint 指令的升级版,使用起来相对 oclint 指令简单方便。
可以通过 -- 的方式在指令的最后加上oclint 选项。

oclint-json-compilation-database 指令有过滤文件选项
-i :包含进某些文件
-e : 过滤掉某些文件
eg:

# 排除Pods 里的文件
oclint-json-compilation-database -e Pods 
# 包含进Pods里的文件
oclint-json-compilation-database -i Pods
oclint-xcodebuild 指令。

因为oclint-xcodebuild 指令已经不再维护,实际应用中用xcpretty代替,所以这里就不进行介绍。

其他命令工具:xcodebuild 和 xcpretty

xcodebuild

xcodebuild是苹果发布自动构建的工具,可以通过命令行脚本的方式编译、打包Xcode 工程。
可以在终端输入man xcodebuild来查询相关用法

xcpretty

用xcpretty生成OClint 解析用的json 文件
这里用xcpretty是因为oclint-xcodebuild不再维护了,在XCode 8之后采用xcpretty来生成。

用XCode检测代码

首先在targets点添加按钮:



在Cross-platform选项中,选“Aggregate”,然后命名为"OCLint":


接着选中OCLint Target,进入Build Phases选项,点左上角的加号,选择“New Run Script Phase”


然后输入脚本即可:


示例脚本:

source ~/.bash_profile
cd ${SRCROOT}
xcodebuild clean
xcodebuild  -workspace demo.xcworkspace -scheme demo | xcpretty -r json-compilation-database --output compile_commands.json
oclint-json-compilation-database -v \
-e Pods \
-e MGLivenessDetection \
-e MGBaseKit \
-e MGIDCard \
oclint_args -- -report-type xcode \
-disable-rule ObjCAssignIvarOutsideAccessors \
-disable-rule ShortVariableName \
-rc=MINIMUM_CASES_IN_SWITCH=3 \
-rc=CYCLOMATIC_COMPLEXITY=10 \
-rc=LONG_CLASS=700 \
-rc=LONG_LINE=200 \
-rc=NCSS_METHOD=40 \
-rc=NESTED_BLOCK_DEPTH=5 \
-rc=TOO_MANY_FIELDS=20 \
-rc=TOO_MANY_METHODS=30 \
-rc=TOO_MANY_PARAMETERS=6
exit

接着选择OCLint Scheme,Command+B就可以执行了
在执行前最好删除drivedata里面的数据缓存,以保证不会解析到旧的编译内容。
编译成功后Xcode上会在不符合规则的代码上显示Warning:

参考链接:

iOS 工程自动化 - OCLint 使用详解
用OCLint给iOS代码做静态分析

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

推荐阅读更多精彩内容