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
命令。违规情况将在 Xcode 和构建日志中显示。
format
命令可用作命令插件。要使用该插件
SwiftFormatPlugins 在 Apache 2.0 许可下可用。 有关更多信息,请参见 LICENSE 文件。