Moulinette

这是 Prolific Interactive 使用的内部审计工具，用于确保代码质量和标准。

要求

• Xcode 8.3.3 或更高版本

说明

如何在 Xcode 项目中构建和运行 Moulinette。

命令行执行

1. 通过双击 .xcodeproj 文件或运行 open Moulinette.xcodeproj 在 Xcode 中打开项目。
2. 使用 CMD B 构建 project。
3. 将名为 Moulinette 的可执行文件从 /Build/Products/Debug/ 复制到您的 your_project_repo/subdirectory。
4. 命令行运行： ./Moulinette -projectName <project-name> -auditSubDirectory <subdirectory>。

从 Xcode 开始

1. 按照上面的第1步，在 Xcode 中打开项目。
2. 在 ProjectSettings.swift 中设置 projectName 和 auditSubDirectory 变量。
3. 使用 CMD R 构建（Build）并运行（Run）项目。

如何贡献力量

如何创建规则

流程

1. 在 Trello 板（https://trello.com/b/CNYIKBlQ/pios-moulinette）上选择一个规则。
2. 评估创建这个规则的要求（例如：与其他 moulinette 团队成员进行交流）。
3. 开始处理该规则。
   1. 新规则应符合 SwiftRule 协议，位于 SwiftRule.swift。
   2. 对规则进行注释
      1. 在类声明之前应有解释规则检查内容的注释。
      2. 每个方法（公开 / 私有 / 内部）都应有注释，并说明其行为。
   3. 为规则创建单元测试或创建一个 Trello 任务来提醒自己去做。
      1. 如果你创建了单元测试
         • 对每个测试进行注释，清楚地解释你正在测试的内容和你期望的结果。
      2. 如果你在 Trello 上创建了任务。
         • 对任务进行注释，并说明规则应包含哪些边缘情况及其预期。
4. 提交一个合并请求（PR）。
   1. 将所有 PiOS Moulinette 成员添加到 PR 中。
   2. 合并规则需要 2 个批准。
   3. 在 PR 中解释你的规则正在测试什么，并附上与此规则相关的任何故事的 url（例如：即使尚未制作，也应提供单元测试链接）。

咖啡

调用 moulinette 生成多个审计的调用工具。

作者

• Jonathan Samudio

需求

• Xcode 8.3.3 或更高版本

说明

如何在多个项目中构建和运行 Coffee。

从命令行

1. 通过双击 .xcodeproj 文件或运行 open Coffee.xcodeproj 在 Xcode 中打开项目。
2. 将目标设置为发布模式 & 使用 CMD B 构建项目。
3. 将名为 Coffee 的可执行文件从 /Build/Products/Debug/ 复制到您的 your_project_repo/subdirectory。
4. 从命令行运行：./Coffee -moulinettePath </$path/to/moulinette/binary/Moulinette> -projectDirectory </$path/to/projects/directory/>")