肘子的Swift记事本
·
【小贴士】Monorepo 实战：解决 VSCode/Cursor 中 SwiftLint 配置失效问题
内容提要
在 Swift 项目的 monorepo 中，SwiftLint 默认无法识别根目录的 .swiftlint.yml。为解决此问题，需要在根目录及每个子 Package 的 .vscode/settings.json 中设置 swiftlint.configSearchPaths 指向配置文件，并明确指定 included 路径，以确保 lint 规则生效。
关键要点
-
在 Swift 项目的 monorepo 中，SwiftLint 默认无法识别根目录的 .swiftlint.yml。
-
在 VSCode 或 Cursor 中打开子目录时，SwiftLint 可能无法正确加载配置。
-
需要在根目录和每个子 Package 的 .vscode/settings.json 中设置 swiftlint.configSearchPaths。
-
配置中必须明确指定 included 路径，避免使用通配符。
-
确保在打开 MyProject 目录时，SwiftLint 能正确处理指定路径下的源码文件。
-
子 Package 的 .vscode/settings.json 也需添加 swiftlint.configSearchPaths 设置。
-
SwiftFormat 的配置更简单，不需要在配置文件中指定 lint 路径。
延伸问答
如何在 monorepo 中配置 SwiftLint 以确保规则生效？
需要在根目录和每个子 Package 的 .vscode/settings.json 中设置 swiftlint.configSearchPaths 指向 .swiftlint.yml，并明确指定 included 路径。
为什么 SwiftLint 在 monorepo 中无法识别根目录的配置文件？
因为在 VSCode 或 Cursor 中打开子目录时，SwiftLint 默认无法加载根目录的 .swiftlint.yml 配置。
在 SwiftLint 配置中，为什么不能使用通配符？
必须明确列出需要 lint 的子目录，使用通配符可能导致 lint 规则无法正常生效。
如何在子 Package 的 VSCode 设置中添加 SwiftLint 配置？
在子 Package 的 .vscode/settings.json 中添加 swiftlint.configSearchPaths，指向上层的 .swiftlint.yml 文件。
SwiftFormat 的配置与 SwiftLint 有什么不同？
SwiftFormat 的配置更简单，不需要在配置文件中指定 lint 路径，只需设置配置文件查找路径即可。
在使用 VSCode 时，如何确保 SwiftLint 正确处理源码文件？
确保在打开 MyProject 目录时，SwiftLint 能正确处理指定路径下的源码文件，并在配置中明确列出这些路径。
