因为风格很重要

尽管已记录了适当的代码风格并根据准则制定了代码约定,但是开发人员可能会忘记始终如一地应用它,或者变得懒惰并开始忽略它。 您不想以任何方式花费自己的时间来修复代码样式或让同事去做。

代码样式是(尽管很重要)最不重要的编码任务之一,因此,建议让工具为您做花哨的格式检查,让您专注于编写代码的更棘手的方面。

Realm引入了一个非常不错的工具-SwiftLint,该工具可以帮助自动完成起毛过程。

在本文中,我将向您介绍如何在iOS项目中设置此工具,以提供所需的语义,保护代码的清洁度并帮助您编写更简洁的代码。

Swiftlint是一个工具,可以帮助您识别和标记可能不符合您定义的样式准则的代码部分。

如果尚未安装SwiftLint,请检查 原始存储库中的 安装” 部分。

您可以通过在Xcode项目的Build Phases中添加运行脚本来使用它。

在下面,您将找到我们用来检查代码风格的脚本。 继续并通过将其保存到项目目录中来在项目中使用它: $SRCROOT/Build-Phases/swiftlint.sh

在此步骤中,可以将脚本本身复制并粘贴到“运行脚本阶段”中 ,但是我们建议将脚本保存在单独的文件中(因为您可能在项目的另一个目标中使用它)。 因此,将文件拖放到运行脚本编写器中 ,其路径如下所示:

拥有此脚本将在每次下一次构建项目时直观地向您显示代码的哪些确切部分与您决定坚持的样式不符。

下图显示了一个警告示例,它违反了我们在样式指南配置文件中定义的规则之一。

SwiftLint确实可以帮助您加强自己和您的团队遵守团队所同意的样式指南,从而对团队产生积极影响,因为他们不会因为两个人使用不同的代码样式而引起任何讨论实践。 通过让机器为我们完成所有繁重的工作,自动化在这里很方便。 让我们(作为开发人员和代码审阅者)真正专注于重要部分。

主要目标是强制执行和鼓励使用样式惯例,这些惯例通常由社区或团队定义。 所有这些都可以使单个项目的文件之间或一般项目之间的代码样式保持一致,无论是您的个人项目还是公司的项目。 它还将有助于提高项目的可读性和更多好处。

从这往哪儿走:

阅读有关SwiftLint的更多信息,并查看它提供了哪些规则。 与团队一起构建自己的样式指南,并在.swiftlint.yml文件中对其进行配置,以在整个项目中使用它。 了解有关使用SwiftLint的其他方法的更多信息(例如,与github一起使用它,并在使用危险的每个拉请求上发布wanring)。

参考:

  • https://github.com/realm/SwiftLint

👏🏻如果您喜欢这篇文章,并认为它很有用。 这会鼓励我写更多! 任何意见或反馈表示赞赏!

随时将我添加到githubtwitter linkedin

感谢您的阅读!