Sonar 集成 Swift 项目

SonarQube是一个开源的代码管理平台,不仅能够提供代码质量的数据报告,还能够有效的管理代码质量。
Sonar 通过一些小组件可以显示代码测试覆盖率、复杂度、坏味道等各种代码的统计数据报告,并且可以很轻松的进行查找和比较。

Sonar 支持很多种语言,都是通过插件来提供支持,针对各种语言的编译器执行之后产生的日志文件对代码的情况进行分析统计,通过插件转化成统一的数据结构上传至Sonar 平台,随之形成可视化报表数据。

官方提供了一些语言(Java、JavaScript 等)的插件,但是Swift 、 Objective-c等语言的插件需要licence才能使用,而且还不便宜。当然,你只要遵循官方的API,也可以写出平台语言的插件。

For Swift

不过,好消息是,Swift语言 这里已经有人完成了这个工程 sonar-swift ,可以通过这里直接下载到,所以就不用造轮子了。

支持

插件整合了多个工具来完成 Swift 的复杂度、代码规范、测试覆盖率 的统计。所以在整合之前需要对这些工具进行安装。

安装 sonar-scanner

官方提供的sonar 命令行工具,可以通过命令完成日志文件上传。

brew install sonar-scanner
安装 xcpretty

xcpretty为xcodebuild 命令提供的附加功能,可以对整个编译构建的过程中产生的日志进行统计,并生成格式化报表。比如类编译时间,编译的错误等等。

sudo gem install xcpretty
安装 SwiftLint

SwiftLint 是Swift 代码规范的检测工具,集成之后,会在Xcode编译之后提示出代码不符合规范的地方,也能生成相应的Lint报告。 最简单的安装方式就是直接下载 pkg 进行安装

安装 slather

slather 是统计测试覆盖率的工具,可以生成报告日志文件,和静态网页报表对测试覆盖率进行分析。

sudo gem install slather
安装 lizard

lizard 是一个简单的代码复杂度分析工具,支持很多流行的语言,这当然也包括了Swift。工具使用python 开发,所以可以通过下载源码后通过 python build 安装,或者通过pip 来安装。

pip install lizard

到这里所有需要的工具都已经安装完成了。

安装plugin

sonar-swift 插件 jar 文件下载至$SONARQUBE_HOME/extionsions/plugins 目录,然后重启Sonar 服务,插件安装完成,如果之前已经安装了官方或者其他的Swift 插件,建议删除,以免发生冲突。

通过脚本上传相关数据

sonar-project.properties 配置文件拷贝至你Swift 项目的根目录,然后根据项目信息进行修改,具体配置属性可以通过Sonar scanner 官方文档进行查看。
最重要的是将sonar.host 修改成你Sonar 服务器的Host地址。

run-sonar-swift脚本文件拷贝至你Swift 项目的根目录,直接执行就可以了。

完成

等脚本执行完成之后,打开Sonar 的地址就可以看到你相关项目的统计信息了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,283评论 4 61
  • 首先,作为一枚果粉,我得说一句标题里的“不行”并不是说苹果产品不行,或者质量很差的意思。苹果公司依然是世界上最值得...
    黎虹阅读 16,106评论 0 1
  • 如果,当初我再相信你一点 如果,当初我再自信一点 如果,当初我再听你说一句 如果,我当初再挽留你一会儿 如果,我当...
    七八岁阅读 309评论 0 7
  • 剽悍晨读为我们分享了《亲爱的卧底经济学家》,选出了其中5个问题,包括怎么样选择健身卡。 我相信很多人都有考虑过或办...
    七七十二行阅读 394评论 4 4
  • So bad,因为手机没电闹铃未响,错过了七点十五的车,只能九点十五去了,少飞了一个小时。中午可以不回来,或者回来...
    四月六日阅读 133评论 0 0