SwiftFormat 中如何排除 SPM 依赖包的格式化检查

在使用 SwiftFormat 进行代码格式化时，开发者可能会遇到一个常见问题：工具会尝试对 Swift Package Manager (SPM) 依赖包中的代码进行格式化检查，这通常会导致不必要的警告或错误。本文将深入探讨这个问题的成因及解决方案。

问题背景

当项目使用 SPM 管理依赖时，这些第三方库会被下载到 Xcode 的 DerivedData 目录中，路径通常类似于：

/Users/[用户名]/Library/Developer/Xcode/DerivedData/[项目名称]-[随机字符串]/SourcePackages/checkouts/[库名称]

SwiftFormat 默认会扫描项目目录下的所有 Swift 文件，如果不进行适当配置，可能会意外地包含这些第三方库的代码。

核心解决方案

1. 正确设置运行目录
   SwiftFormat 应该只在项目源代码目录下运行，而不是在整个用户目录或系统根目录。确保你的构建脚本或命令行工具只在项目目录内执行格式化。

2. 使用排除选项
   如果确实需要排除特定路径，可以使用 --exclude 参数明确指定要忽略的目录或文件。

高级场景处理

在某些特殊情况下，开发者可能会遇到关于 self 引用的警告，特别是在日志语句中使用字符串插值时。例如：

logger.error("Fetch value for '\(key)' from \(container) failed. \(error.localizedDescription)")

这种情况下，SwiftFormat 会要求显式使用 self 来明确捕获语义。可以通过在 .swiftformat 配置文件中添加以下规则来解决：

--selfrequired logger.error

这条规则告诉 SwiftFormat 在 logger.error 调用中需要显式使用 self。

最佳实践建议

1. 项目结构规范化
   保持项目结构的清晰，将第三方依赖与项目源代码明确分离。

2. 配置文件的合理使用
   维护一个完善的 .swiftformat 配置文件，根据项目需求定制规则。

3. 构建脚本的优化
   在 CI/CD 流程中，确保构建脚本正确设置了工作目录和排除路径。

通过以上方法，开发者可以有效管理 SwiftFormat 的行为，避免对第三方库代码的不必要检查，同时保持项目代码的高质量格式化。