SuperAPI AI 工具集

swiftlint

通用与其它

查看项目

更新于 10-15 21:12

技能介绍

用途:SwiftLint 通过可配置规则集对源码做 lint,强制执行 Swift 风格与约定。本技能覆盖安装、配置、规则选择、抑制、CI 集成与渐进式落地。它是风格执行工具,不是风格指南;命名与设计约定另见 swift-api-design-guidelines,架构模式另见 swift-architecture。

主要能力:支持默认规则、按 opt_in_rules 选择性开启的规则,以及需要编译器日志的 analyzer 规则;支持 .swiftlint.yml 配置、仅用 only_rules、抑制注释、基线、自动修复和多层配置。

推荐用法:默认通过 SimplyDanny/SwiftLintPlugins 以构建工具插件方式接入,在 Package.swift 添加依赖并在 target 的 plugins 中应用 SwiftLintBuildToolPlugin;首次构建时在 Xcode 中信任插件。项目根目录创建 .swiftlint.yml,可设置 disabled_rules、opt_in_rules、included/excluded、line_length、type_body_length、file_length 等。新建项目可从默认规则开始,逐条加入 opt-in 规则;存量项目可先生成基线:swiftlint --write-baseline .swiftlint.baseline,之后用 swiftlint --baseline .swiftlint.baseline 只报告新增违规。

自动修复:使用 swiftlint --fix(旧别名 --autocorrect),不要在构建阶段自动运行,需手动或独立 CI 步骤执行并审查 diff。CI 建议运行 swiftlint --strict --reporter sarif,并配合基线只让新增违规失败。

限制与注意:需固定 SwiftLint 版本,并与编译所用 Swift 工具链兼容;避免过度排除、误用 only_rules、忘记重新启用抑制、在大型代码库一次性开启过多规则。资料未提供具体价格与支持平台范围。