如何避免在协作Xcode项目中出现混乱

您经历了多少次,以自己的方式用自己的风格进行编码非常自在,但是突然之间,您的团队从只有您一个开发人员的团队成长为由五个人组成的团队?

并非每个人都会对您组织代码和样式的方式感到满意,因为我们每个人都有自己的方法。 您能想象一个由六个开发人员组成的团队在不共享任何准则的情况下进行编码吗? 它很容易失控,很可能变得非常混乱! 这就是SwiftLint进行救援时的特殊情况。


这是怎么回事?

在深入探讨之前,让我们先了解一些概念。

  • 什么是短绒/棉绒?

短绒(或称棉绒)是指一种工具,可以分析源代码以查找编程或风格错误,错误和可疑结构。

  • 什么是SwiftLint?

SwiftLint是一种宽松的工具,用于强制执行Swift样式和约定,大致基于GitHub的Swift样式指南。 它与Clang和SourceKit挂钩,以使用源文件的AST表示形式寻找更准确的结果。


安装

您可以通过多种方式在Mac上安装SwiftLint,但最常见和最简单的方法是使用Brew:

 酿造安装swiftlint 

如果您不熟悉Homebrew,并且想要通过Cocoapods,Mint安装它或使用预构建的软件包,则可以查看文档。


Xcode和项目配置

现在我们完成了安装,有必要配置我们的项目以运行SwiftLint。 为了允许Xcode运行swiftlint命令,您必须为目标创建一个运行脚本。

您将必须在Xcode中选择项目,选择相应的目标,转到Build Phases选项卡,单击+按钮,然后选择New Run Script Phase

然后粘贴以下代码。

 如果哪个swiftlint> / dev / null; 然后 
swiftlint
其他
echo“警告:未安装SwiftLint,请从https://github.com/realm/SwiftLint下载”
科幻

您的构建阶段应该像这样结束。

注意:您可以重命名默认的构建阶段名称。 就我而言,我将其命名为“ Swiftlint”。

现在,您可以构建(⌘ + B)您的项目。 完成后,您的项目中将显示一些错误或警告,如下所示。

警告!

让我提前告诉您,如果您使用任何依赖项管理器,我们集成的第3方库也将出现错误。 这就是您可能会想“地狱,我不需要这个。 我可以没有短毛猫生活”,但还不要失去信心!

您可以创建配置文件以自定义要运行的规则,不运行的规则,还可以为任何特定规则设置特殊参数。 因此,让我们对其进行配置。

首先,您需要与Xcode项目位于同一文件夹级别。

  .swiftlint.yml 

您可以使用vi or touch或所需的任何其他文本编辑器。 然后,这将为我们的规则创建一个空的配置文件。

现在,您可能想知道要在此文件中放入什么。 让我通过为您提供参考文件来帮助您。


这两个选项将极大地帮助您识别line_lengthline_length )的位置,并在每次按return键并失去行焦点时修剪尾随空格( line_length )。


关于SwiftLint

SwiftLint由Realm Inc.维护和资助。但是它的代码是开源的,您可以根据需要为新项目或错误修复提供项目。 您可以通过观看此视频来了解有关SwiftLint的更多信息。

SwiftLint和CI集成

SwiftLint与Fastlane集成,Fastlane是另一个用于iOS开发和自动化所有部署过程的出色工具。 但是,如果您有CI服务器且未配置Fastlane,并且您的CI服务器恰好是Jenkins,Travis或Circle,那么您也可以集成SwiftLint。


结论

在我看来,SwiftLint是用于iOS / macOS开发的出色工具,它确实有助于我们保持代码库非常整洁,可维护并与我们的团队和Swift社区保持一致。

SwiftLint强制我们避免执行强制施放或强制展开等不良做法。 它还使我们学习了一些语言功能,例如在for where子句中发生的情况。

触发示例:

非触发示例:

您还可以在此处检查SwiftLint适用的所有规则集。