SuperAPI AI 工具集

jww-swift-style

编程与开发

查看项目

更新于 10-15 23:43

技能介绍

用途:为 JWW 项目生成、编辑或审查 Swift 代码时统一风格。核心规则是让代码看起来像原本就属于被修改的代码旁边;最近的周边 Swift 源码和适用的 AGENTS.md 是最终依据,其余规则仅在周边代码未规定时作为默认,主要用于新建顶层文件。

输入与输出:输入为目标 Swift 文件或 diff、附近可比源码文件以及所有适用的 AGENTS.md;输出为符合本地约定的最小 Swift 编辑或风格审查,并在编辑时说明所做的验证。

写前准备:阅读目标文件与附近可比文件,阅读每个适用的嵌套 AGENTS.md;保留现有结构、导入顺序、访问控制风格以及所有 MARK 和分节分隔符,不做无关格式化或风格清理。

源码布局:使用四空格缩进,用空行分组声明和逻辑步骤;行宽遵循适用的 SwiftLint line_length 设置,未配置时默认 150 字符,并遵循仓库显式覆盖(包括禁用该规则)。缩进与续行对齐匹配 Xcode Control-I 输出。仅在仓库已使用分隔符样式时为大类型添加分节,并精确匹配邻近文件。新建顶层文件优先一个主要类型;新建聚焦扩展文件命名为 Type+Purpose.swift。遵循所在文件的 self. 约定。

命名、访问与文档:使用清晰惯用的 Swift 名称和与周边目标一致的显式访问级别;非子类引用类型在符合角色时优先 final;需要观察但不可变更时用 private(set);为公共/共享 API 写英文文档注释,不写重复代码、时间标签或 LLM/流程引用的注释。

Swift 与 Apple API:优先使用部署目标已可用的标准 Swift 特性和平台框架,避免为常规工作引入第三方依赖;用 guard 做必需提前退出;共享代码中窄范围使用 #if os(...) 或 #if targetEnvironment(...)。

测试:遵循现有测试文件的框架与结构;XCTest 目标中新测试用 XCTest,除非该目标正在迁移,否则优先 Swift Testing(import Testing、@Test、#expect、#require)。测试聚焦、按行为命名,复用现有夹具与辅助工具。

最终检查:呈现 Swift 代码前重读改动上下文,确认保留分隔符、本地顺序、导入、可见性、平台边界和相关 SwiftLint 限制;实际改动时运行仓库配置的定向 lint 命令及最相关的构建或测试验证。