SwiftFormatPlugins

SwiftPM compatible Swift Package Index License

SwiftFormatPlugins 为 Apple 的 swift-format 格式化工具添加了构建工具插件支持。与作为 swift-format 项目一部分包含的命令插件不同,这些插件允许您在每次构建之前自动运行 lint 命令,从而无需手动检查 lint 违规,这些违规可以使用包含的 format 插件来解决。

注意

此软件包依赖于 Swift 6 及更高版本中 Swift 工具链包含swift-format 安装。

安装

SwiftFormatPlugins 可通过 Swift Package Manager(一个内置于 Xcode 的依赖管理器)获得。

如果您使用的是 Xcode 11 或更高版本,请转到 File / Swift Packages / Add Package Dependency... 并输入软件包存储库 URL https://github.com/StarLard/SwiftFormatPlugins.git,然后按照说明操作。

要删除依赖项,请选择项目并打开 Swift Packages(位于 Build Settings 旁边)。您可以从此选项卡添加和删除软件包。

Swift Package Manager 也可以从命令行使用。

用法

'Lint' 和 'Format' 插件都会针对它们执行的每个目标检查关联的 .swift-format JSON 文件。如果存在该文件,则该目标随后对 swift format 的任何调用都将传递该配置文件。如果没有,将使用默认配置。

Lint

lint 命令可用作预构建命令插件。 要使用该插件

  1. 在 Xcode 项目导航器窗格中选择您的项目,然后导航到您要进行 lint 检查的目标。
  2. 打开“Build Phases”选项卡,然后单击“Run Build Tool Plug-ins”部分下的 + 图标。
  3. 从下拉列表中选择“Lint”插件,然后从后续提示中选择“Trust & Enable”。

现在,每次构建目标时都会运行 lint 命令。违规情况将在 Xcode 和构建日志中显示。

Format

format 命令可用作命令插件。要使用该插件

  1. 在 Xcode 项目导航器窗格中右键单击您的项目,然后在“Swift Format Plugins”部分下选择“Format”。
  2. 选择一个或多个要格式化的目标。
  3. 选择“Allow Command to Change Files”。

作者

@StarLard

许可

SwiftFormatPlugins 在 Apache 2.0 许可下可用。 有关更多信息,请参见 LICENSE 文件。