简介
danger-plugin-xcode-report 是一个可以在 Danger 上通过解析 Xcode 编译报告来帮助团队保持代码质量和代码风格的 npm 包。
使用 danger-plugin-xcode-report 可以让我们在代码审查时更快速地了解代码的质量问题和编译错误等，并且可以配合其他的 Danger 插件一起使用，形成一个完整的代码审查工具链。
安装
安装 danger-plugin-xcode-report 的方式很简单，只需要在项目的根目录下执行以下命令即可：
yarn add danger-plugin-xcode-report --dev
或者是使用 npm：
npm install danger-plugin-xcode-report --save-dev
使用
获取编译报告
首先，我们需要获取到 Xcode 的编译报告，获取方式很简单，只需要在编译选项中添加 -json-compilation-database 参数，编译完成后会在项目根目录下生成一个名为 compile_commands.json 的文件。
配置 Dangerfile
在项目根目录下创建一个名为 Dangerfile 的文件，并且在文件中引入 danger-plugin-xcode-report：
import xcodeReport from 'danger-plugin-xcode-report' xcodeReport()
运行 Danger
最后，我们只需要运行 Danger 即可，可以使用 danger 命令行工具进行运行：
yarn danger pr https://github.com/org/repo/pull/1
或者使用 danger-local 命令进行本地测试：
yarn danger-local fix
功能说明
通过使用 danger-plugin-xcode-report，我们可以在 Danger 给出的代码审查结果中看到关于编译错误和代码风格问题的详细信息。默认情况下，使用该插件会检查以下信息：
- 编译错误：检查编译是否成功，如果编译错误会给出提示；
- 代码风格问题：使用
clang-tidy工具扫描代码，给出代码风格问题的建议； - 重复代码：使用
clazy工具扫描代码，给出重复代码的提示。
示例代码
以下是一个根据 danger-plugin-xcode-report 提供的信息进行代码审查的例子：
-- -------------------- ---- -------
------ ----------- ---- ----------------------------
-- --------
----- -- - -------------
----- ------ - ------------------------------------------ -
--------- -------
--
--------------- - -------------------------------------
-- -- ------
-------------
-- ------
-- -------------------------- -- ----------------------------------- --- ------ -
-----------------
-
-- --------
-- ---------------------- -- -------------------------- -
----- ----------- - ---------------------------------------------
---------------------------- -- -
----- -------- - ---------------
----- -------- - ---------------
-- ---------------- - -- -
----- ------- - --- ------------------ -------------
----- ------------- - ---------------------- -- -
------ --- --------------------------- - -------------------
--
----- ----------- - ------------------------
------------ - ------------
-
--
-
-- ------
-- ---------------------- -- -------------------------- -
----- ------------ - ----------------------------------------
----------------------------- -- -
----- -------- - ---------------
----- -------- - ---------------
-- ---------------- - -- -
----- ------- - --- ------------------ -----------
----- ------------- - ---------------------- -- -
------ --- --------------------------- - -------------------
--
----- ----------- - ------------------------
------------ - ------------
-
--
-结论
danger-plugin-xcode-report 是一个非常实用的 Danger 插件，可以大大提高团队代码审查的效率，特别是在需要进行低级别的细节处理时。
在使用该插件的过程中，我们需要注意及时删除旧的编译报告文件，并且在进行代码审查前重新编译并生成一个新的编译报告，以保证得到最新的代码质量和编译错误信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f7b238a385564ab6a04