SwiftFormat
1)新建一个BuildTools的文件夹和Package.swift文件
1.在 xcodeproj 工程文件的同级目录下新建一个文件夹BuildTools
2.在这个文件夹下新建一个Package.swift文件,夹带着一下内容:
// swift-tools-version:5.1
import PackageDescription
let package = Package(
name: "BuildTools",
platforms: [.macOS(.v10_11)],
dependencies: [
.package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.54.0"),
],
targets: [.target(name: "BuildTools", path: "")]
)
3.如果你用Xcode11.4或更高版本,在BuildTools文件夹下再新建一个Empty.swift文件,空文件什么内容都没有,这是为了满足Swift包管理器的变化
2)在你的app target下增加一个Build phase
- 打开你的工程PROJECT TARGETS,在TARGETS选择你的target,点击Tab上的Build Phases
- 点击左上角的 + 号按键,新增一个脚本,New Run Script Phase
- 不要勾选,Based on dependency analysis
- 把刚才新建的脚本Run Script 拖拽到 Compile Sources 的上边,脚本的内容:
cd BuildTools
SDKROOT=(xcrun --sdk macosx --show-sdk-path)
#swift package update #Uncomment this line temporarily to update the version used to the latest matching your BuildTools/Package.swift file
swift run -c release swiftformat "$SRCROOT"
你也可以使用swift run -c release --package-path BuildTools swiftformat "$SRCROOT",如果你需要一个更复杂的脚本和cd BuildTools破坏的东西
注意⚠️
note:你可能希望检查BuildTools/Package.swift到你的源代码控制中,这样你运行脚本阶段使用的版本就会被保存在版本控制中。建议在.gitignore文件中添加以下内容:
BuildTools/.build
BuildTools/.swiftpm
note:如果你使用的是Xcode 15或更高版本,请确保ENABLE_USER_SCRIPT_SANDBOXING(又名“用户脚本沙箱”)选项设置为NO,否则SwiftFormat将无法正常运行。
SwiftLint
- SwiftPM添加package依赖,在你的项目中,在Package Dependencies一节中导入SwiftLint。
要添加的SwiftLint GitHub URL: https://github.com/realm/SwiftLint.git - 一旦包被加载,你会被要求添加SwiftLintFramework和/或swiftlint。不要打勾。只需点击添加包按键。
- 转到你的Xcode项目目标,进入Build Phases选项卡:单击Run Build Tool plug -ins下的+按钮。从那里,添加SwiftLintBuildToolPlugin。
- 在构建项目时,Xcode会询问 Trust & Enable All plugins
点击此按钮启用SwiftLint插件。
SwiftLint现在正在你的Xcode项目中工作,你应该会看到警告和错误被触发。
你可以通过添加.swiftlint来添加自定义规则。将.yml文件放入项目的根目录。然后,您可以使用所需的规则编辑该文件。要了解更多关于你可以添加的规则,请查阅SwiftLint规则。关于如何设置自定义规则的例子,你可以查阅SwiftLint包索引文档的Configuration部分
参考:
https://github.com/nicklockwood/SwiftFormat?tab=readme-ov-file#using-swift-package-manager