Emerald iOS Components
这是一个框架,包含了遵循Emerald风格指南的基本UI类。
📚
文档有关如何在您的应用程序中使用框架的文档,可在本项目的Wiki中找到。
🤝
贡献想帮助我们使此SDK变得更好吗?您可以在这里找到我们的贡献指南。
入门
以下步骤将帮助您在本地的机器上安装项目副本并进行开发和测试。
需求
要在您的机器上运行此项目,您需要最新版本的
Xcode
macOS和iOS的默认IDE,您可以在Mac App Store上免费下载。
CocoaPods
Cocoa项⽬的依赖关系管理器。您可以使用以下命令安装它
$ [sudo] gem install cocoapods
Git
本项目使用的版本控制系统,其最新版本可在此下载 https://git-scm.cn/download/mac。
安装
- 将项目克隆到您的机器上。
- 在项目文件夹内部,在终端中运行
$ pod install
。 - 使用Xcode打开
EmeraldComponents.xcworkspace
文件。
✅
测试为了能够手动测试项目和检查代码覆盖率,请执行以下步骤
- 打开
EmeraldComponents.xcworkspace
文件。 - 按
⌘
+U
。 - 在左侧导航器中打开
报告导航器(⌘ + 9)
选项卡。 - 在列表中选择
{} 覆盖率
选项。 - 应看到整个项目和类的覆盖率。
当打开文件时,编辑器屏幕在其所有可执行代码的左侧显示绿色、红色或条纹颜色,显示哪些代码部分被测试所覆盖。这并不意味着该方法确实被测试过,它只是表示在执行时测试方法已经通过了该代码行。
如果您看不到这个指示,可以通过转到 编辑器 > 显示代码覆盖率
启用它。
代码质量
为了始终维护代码的最佳质量并确保代码的可维护性,我们在开发和发布流程中使用了一些前提条件。
SwiftLint
我们使用 SwifLint 作为我们的代码检查工具,以确保代码中没有结构问题或任何不良的编程实践,您可以在我们的样式规则文件 这里 找到应用于项目的规则。
覆盖率
Xcode 提供了代码覆盖率信息,我们用它来自动阻止任何可能会将项目的覆盖率降低到低于 80.0% 的拉取请求。请记住始终测试您的类和方法。
许可证
本项目采用 Apache 许可证,详细信息请参见 LICENSE.md 文件。