这个项目能做什么

SwiftFormat 是一个代码库和命令行工具,用于在 macOS、Linux 或 Windows 上重新格式化 Swift 代码。除了简单的空白调整之外,它还可以插入或移除隐式 `self`、移除冗余括号,并纠正许多其他偏离标准 Swift 惯用法的写法。 该项目声明的动机是:就共同的编码风格达成一致有助于协作,但手动强制执行既繁琐又容易出错。自动化格式化工具让团队能够专注于代码行为,而不是表现形式。 使用方式包括: - 命令行工具,可手动运行或作为工具链的一部分运行 - Xcode Source Editor Extension,通过 Editor > SwiftFormat 菜单调用 - Xcode 构建阶段,在每次构建时运行 - Git pre-commit hook,在提交前格式化已更改的文件 - Swift Package Manager 命令插件(Swift 5.6+) - 适用于 VSCode(通过 Run on Save)、Sublime Text 和 Nova 的集成 - GitHub Actions、CI 上的 Danger、Bazel、Docker 和 AppleScript 安装选项包括 Homebrew(`brew install swiftformat`)、Mint、Nix/nixpkgs、CocoaPods、Package.swift 中的二进制 artifactbundle,或使用 `swift build -c release` 手动构建。Xcode 扩展可通过 Homebrew cask 或 GitHub Releases 获取。 基本用法是 `swiftformat .`,用于格式化当前目录中的 Swift 文件。README 警告说,这会就地覆盖文件,因此用户应首先提交更改;`--infer-options` 可以建议与现有项目风格匹配的设置。支持标准输入/输出管道,包括使用 `--stdin-path` 提供文件位置上下文。 配置涵盖选项、规则、Swift 版本、`.swiftformat` 配置文件、globs、linting 模式、错误代码、缓存、文件头和 Markdown 格式化。README 还包括 FAQ、已知问题、打赏和致谢。该项目采用 MIT 许可证。