一份不完全的代码检测工具FauxPas使用指南

简介

• Faux Pas 是一个 Xcode 辅助工具，主要用于检查常见的代码错误，隐藏的 bug，代码风格问题及可维护性问题。

作用

• 查找潜在 bug
• 查找资源错误
• 查找本地化错误
• 查找版本控制错误
• 更加优秀的代码格式
• 强制 code style，检查出过时 style
• 共有 111 中可以选择的代码规则
• 可以使用 GUI 或 命令行来进行操作
• 可以在 Xcode build 项目的时候 run
• 可以与外部工具进行联系
• 通过 tag 来选择所要使用的 rules，并且可以对这些 rules 进行配置，最后可以选择将代码检查结果导出不同的格式中
• 可以使用你选择的 editor 来打开链接

使用方法

主要有以下三种使用方法

直接通过GUI进行代码审查：

• 主要步骤如下：

  • 首先打开 FauxPas

    

    首页.png

• 然后选择一个 project，进入工具中，在这个界面中我们需要选择项目是否需要用 workspace 打开以及选择我们的 workspace 和 scheme，注意这里的 scheme 不要选错，想检查哪个target就要选择哪个 scheme，这里我选择的是 PreciousMetalsDev，然后点击确定

进入界面.png

• 接着需要配置 target 和 config，这里的 target 也要选择对应的 PreciousMetalsDev， Rules 表示你需要检查的代码规则，一共有 111 种规则，默认会帮我们选择 "Recommended" 类型的规则

• 主要的规则有如下几条

  • Recommended ：主要是代码风格检查以及代码中可能潜在的危险，包括垂悬指针等，以及图片资源的问题。
  • BestPractice ：更好的代码风格，包括 block 应该使用 typedef 来定义， IBOutlet 不应该出现在公共头文件等
  • Resources ：潜在的有可能未被使用的资源
  • Config ：这个选项是当你想要在 .xcconfig 文件中设置 xcode 的配置，而不是在 GUI 中直接设置
  • Localization ：本地化过的变量，但是却没被使用过、
  • Style ：代码风格检查，主要包括变量，方法，分类等的命名规则，使用正则表达式来进行约束
  • 其他还有 APIUsage，VCS，Pedantic 等不是特别重要
  

  choose.png

![config.png](https://upload-images.jianshu.io/upload_images/3262069-62234a6c81b184df.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

• 点击 start checking 开始代码检查，首先需要等待倒计时十五秒后才会开始进行检查，然后会开始打印出检查步骤

  

  checkinglog.png

• 最后就是结果呈现

  

  diagnositic.png

通过命令行进行代码审查__：

• 首先在命令行输入 $ fauxpas help 可以查看到文档，注意首先需要下载 CLI

  

  help.png

• 然后可以按照类似步骤进行代码审查，不再展开

在Xcode进行build的过程中进行审查：

• 这个过程首先需要在你想要检查的 target 中新建一个 “Run Script” ，然后将如下代码填入，然后点击运行即可在 build 时候检测错误，这里官方文档只写了这么一点，我也没太明白如何修改参数

   [[ ${FAUXPAS_SKIP} == 1 ]] && exit 0
  
   FAUXPAS_PATH="/usr/local/bin/fauxpas"
   if [[ -f "${FAUXPAS_PATH}" ]]; then
     "${FAUXPAS_PATH}" check-xcode
   else
     echo "warning: Faux Pas was not found at '${FAUXPAS_PATH}'"
   fi
  

可能出现的错误

• build 失败：
  • 首先需要检查 fauxpas 的版本号是否支持当前的 xcode，在命令行执行下列代码来检查 Xcode 使用的 Clang 版本号： xcrun clang -dM -E -x c /dev/null | grep __VERSION__ 然后检查 FauxPas 使用的 Clang 版本号： fauxpas -v version | grep Clang ，不一致的话可能需要先升级 FauxPas。
  • 然后再检查 scheme 和 target 是否一致
  • 如果你的 project 是使用 workspace 来 build 的，并且不能单独 build ，则使用 --workspace 来指定你想要 build 的 workspace 名，使用 --scheme 来指定 scheme，一般与 target 名相同

总结

• 优势：可以非常方便的展示出代码中不规范和潜在错误的地方，便于提高自己的 coding 水平
• 缺点：比较大的项目检查过程较长，并且不会检查 cocoapods 所管理的代码，这在我们的项目中可能不够实用，毕竟我们的组件化的组件都不能够单独编译。

附

• 官方指南