OCLint从安装到使用

OCLint是什么,引用官方对于OCLint的介绍:OCLint is a static code analysis tool for improving quality and reducing defects by inspecting C, C++ and Objective-C code and looking for potential problems. 通俗的讲,就是一个静态代码分析工具,通过该工具,我们可以检查出代码中的一些潜在问题,同时也就实现了自动化的code review。

接下里,我们直接进入OCLint的使用之旅:

一、 工具知识

在具体开始安装使用OCLint之前,我们先来了解一些在使用OCLint的过程中所涉及到的相关工具知识。

1. OCLint

OCLint是一套工具的总称,其中包含以下工具:

  • oclint :是OCLint工具集最主要的指令,用于规则加载、编译分析选项以及生产分析报告。
  • oclint-json-compilation-database :用于在JSON Compilation Database format类型的编译文件compile_commands.json中提取必要信息。
  • oclint-xcodebuild :用于将xcodebuild生产的log文件xcodebuild.log转换为JSON Compilation Database format类型的文件。

2. xcodebuild

使用OCLint需要搭配Xcode,准确的来说是使用Xcode套件中的xcodebuild工具,xcodebuild可以对Xcode工程进行编译,生成对应的xcodebuild.log文件。

3. xcpretty

xcpretty是配合xcodebuild来生成并输出对应格式的工具,在OCLint的使用里,我们可以用xcpretty配合xcodebuild来替代oclint-xcodebuild来输出JSON Compilation Database format格式文件。

4. 时序图

在使用OCLint对iOS工程进行代码分析中所涉及到的工具我们都已经介绍完了,下面是这些工具对应使用的时序图:

时序图

二、 工具安装

1. OCLint安装

有三种方式可以安装OCLint,分别为Homebrew安装安装包安装以及编译源码安装

如果你需要对OCLint进行规则的自定义开发,那么只能通过编译源码安装这种方式进行;如果你仅仅是使用OCLint规则来对源码进行分析,那么以上方式随你选择。

方式一. Homebrew安装

在安装前,请确保机器已经安装Homebrew。

该方式安装最为简单,只需执行以下命令即可:

brew tap oclint/formulae
brew install oclint

方式二. 安装包安装

(1). 进入oclint的github主页,进入Releases中,选择最新版本的安装包,例如oclint-0.13-x86_64-darwin-16.7.0.tar.gz

(2). 解压下载文件得到oclint-0.13文件,将文件放在某个目录下,如/Users/XXX/OCLint

(3). 终端输入vim ~/.bash_profile,将oclint添加到环境变量中,如下:

OCLINT_HOME=/Users/XXX/OCLint/oclint-0.13
export PATH=$OCLINT_HOME/bin:$PATH

(4). 重启终端,之后执行oclint命令,得到以下内容则证明安装成功:

oclint: Not enough positional command line arguments specified!
Must specify at least 1 positional argumen
  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值