SuperAPI AI 工具集

swiftlint

通用与其它

查看项目

更新于 10-16 05:52

技能介绍

用途:SwiftLint 用于检查并强制 Swift 代码风格、格式和约定,可作为构建工具插件、Xcode 脚本、Swift Package 插件或 CI 环节运行。其范围限于 lint 与风格强制;底层 API 命名、约定与架构规则需参考 swift-api-design-guidelines 和 swift-code-review,资料未提供更多细节。

主要能力:支持规则配置与选择、抑制、基线和自动修正,并可与 CI 集成。推荐在 Xcode 项目与 Swift Package 中使用 SimplyDanny/SwiftLintPlugins 的构建工具插件,避免全局安装并在目标编译时自动运行。

使用方式:在项目根目录放置 .swiftlint.yml,配置 included、excluded、opt_in_rules、disabled_rules 等;采用渐进式启用规则,先用高置信度默认规则,关闭噪声较大的格式规则,再逐个团队引入更严格的 opt-in 规则。可用 swiftlint --fix 修正可自动修正的违规。抑制可使用 // swiftlint:disable:next rule_id 或块级 disable/enable。历史代码库可使用 swiftlint analyze --compiler-log-path xcodebuild.log 生成基线。CI 中可在单元测试前运行 swiftlint --strict --reporter github-actions-logging。

适用场景与限制:适合 Xcode 项目、Swift Package 及 CI 流水线中的代码风格治理。资料提醒不要一次性启用全部 opt-in 规则,避免全局 Homebrew 依赖未固定版本,需排除 Pods、.build、DerivedData 等目录,优先窄范围抑制,自动修正宜在本地 pre-commit 运行而 CI 用 --strict 验证。具体安装命令、版本要求、平台与价格等资料未提供。