mcpField
U
update-swiftui-apis

update-swiftui-apis

github.com/avdlee开发3.8k2.4k 次安装3 周前更新
代码仓库

关于 update-swiftui-apis

用于维护 SwiftUI API 弃用参考资料的工作流技能,指导贡献者借助 Sosumi MCP 扫描 Apple 文档、更新查询文件并准备拉取请求。

主要功能

  1. 01检查现有 API 覆盖范围
  2. 02扫描 Apple 文档
  3. 03查找弃用 API 及替代项
  4. 04更新 API 查询参考文件
  5. 05准备拉取请求

适用场景

  1. 01刷新弃用 API 清单
  2. 02核实替代 API 的可用版本
  3. 03提交有文档依据的 API 更新

MCP 相关

使用 Sosumi MCP 工具搜索和获取 Apple 文档及视频文字稿,以识别 API 变更。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/avdlee/swiftui-agent-skill --skill update-swiftui-apis

安装后在 Claude Code 中输入/update-swiftui-apis确认已加载。

附带文件references/scan-manifest.md

详细介绍

更新 SwiftUI API

通过 Sosumi MCP 系统地扫描 Apple 开发者文档,找出已弃用的 SwiftUI API 及其现代替代方案,并更新 skills/swiftui-expert-skill/references/latest-apis.md。

前提条件

  • 必须启用并可使用 Sosumi MCP(提供 searchAppleDocumentation、fetchAppleDocumentation、fetchAppleVideoTranscript、fetchExternalDocumentation)
  • 对此仓库(或其分叉)的写入权限

工作流程

1. 了解当前覆盖情况

阅读 skills/swiftui-expert-skill/references/latest-apis.md,了解:

  • 已记录的弃用 API 到现代替代方案的转换
  • 当前使用的版本区段(iOS 15+、16+、17+、18+、26+)
  • 底部的快速查找表
2. 加载扫描清单

阅读 references/scan-manifest.md(相对于此技能的路径)。其中包含要扫描的 API 分类、文档路径、搜索查询和 WWDC 视频路径列表。

3. 扫描 Apple 文档

对于清单中的每个分类:

  1. 使用列出的查询调用 searchAppleDocumentation,查找相关页面。
  2. 使用具体的文档路径调用 fetchAppleDocumentation,获取完整的 API 详情。
  3. 查找弃用通知、“Deprecated”标签和“Use ... instead”指引。
  4. 记录现代替代方案的可用 iOS 版本。
  5. 可选:调用 fetchAppleVideoTranscript,查看宣布 API 变更的 WWDC 主题演讲。

将相关搜索批量执行,以提高效率。重点查找 latest-apis.md 中尚未记录的新弃用项。

4. 对比并识别变更

将扫描结果与现有条目进行对比。对结果分类:

  • 新弃用项:latest-apis.md 中尚未记录的 API
  • 更正:需要更新的现有条目(版本有误,或有更好的替代方案)
  • 新版本区段:如果新的 iOS 版本引入了弃用项,则添加新区段
5. 更新 latest-apis.md

严格遵循现有格式。每个条目必须包含:

区段位置——放在正确的版本区段下:

  • 长期已弃用的 API 放在“始终使用(iOS 15+)”
  • 版本限定的变更放在“面向 iOS 16+”/“17+”/“18+”/“26+”

条目格式:

**Always use `modernAPI()` instead of `deprecatedAPI()`.**

\```swift
// Modern
View()
    .modernAPI()

// Deprecated
View()
    .deprecatedAPI()
\```

快速查找表——在文件底部添加一行:

| `deprecatedAPI()` | `modernAPI()` | iOS XX+ |

保留文件顶部的致谢行:

根据使用 Sosumi MCP 对比 Apple 文档的结果,我们找到了最新推荐使用的 API。

6. 发起拉取请求
  1. 从 main 创建分支,命名为 update/latest-apis-YYYY-MM(使用当前年份和月份)。
  2. 将更改提交到 skills/swiftui-expert-skill/references/latest-apis.md。
  3. 使用 gh pr create 发起 PR,并填写:
    • 标题:“更新最新 SwiftUI API(Month Year)”
    • 正文:新条目和变更条目的摘要,以及对 Sosumi MCP 的致谢

Sosumi MCP 工具参考

工具参数返回内容
searchAppleDocumentationquery(字符串)JSON,包含 results[],其字段包括 title、url、description、breadcrumbs、tags、type
fetchAppleDocumentationpath(字符串,例如 /documentation/swiftui/view/foregroundstyle(_:))Markdown 格式的文档内容
fetchAppleVideoTranscriptpath(字符串,例如 /videos/play/wwdc2025/10133)Markdown 格式的文字稿
fetchExternalDocumentationurl(完整的 https URL 字符串)Markdown 格式的文档内容

提示

  • 先使用 searchAppleDocumentation 查询进行广泛搜索,然后通过 fetchAppleDocumentation 深入查看特定路径。
  • Apple 的弃用文档通常会在页面中注明“Deprecated”,并链接到替代方案。
  • WWDC 的“What's new in SwiftUI”专题会议是了解新推出的替代方案的最佳来源。
  • 如果不确定某项弃用对应的确切 iOS 版本,请查看获取的文档中的“Availability”部分进行确认。
  • 如果某个 API 已弃用,但没有直接的替代方案,请如实说明,不要建议不正确的替代方案。

评论

支持 Markdown