SuperAPI AI 工具集

research-deprecation-usage

编程与开发

查看项目

更新于 11-02 04:45

技能介绍

用途

该技能为 CDS 中已废弃成员在客户仓库中的使用情况提供评估,输出尽可能准确的使用证据,以支持“某个导出能否在本次发布中移除、还是需保留到下一个大版本”的决策。

移除就绪策略

一个废弃 API 必须保留一个完整大版本且不受干扰才可移除:若在 M 大版本中废弃,必须完整保留至 M+1,最早移除版本为 M+2(参见 @deprecationExpectedRemoval 与 .claude/skills/deprecate-cds-api/SKILL.md)。

使用方式

  1. 确定研究范围:可能只调查一个具体废弃项,也可能对全部 CDS 废弃项做全面审计。全面审计需额外执行 yarn node scripts/findDeprecations.mjs --json,该脚本以 JSON 输出所有 CDS 包中的废弃项及元数据。
  2. 确定废弃类型:常见两类,一是 React 组件的单个 prop,二是整个 React 组件、函数或常量。调查单个废弃项时,在本仓库源码中查找(不要用 Sourcegraph),代码会标注 jsdoc @deprecated;查看周边代码判断属于哪一类;若同一废弃项出现在多个 CDS 包中,可请用户澄清关注哪个包。全面审计时,第 1 步脚本输出已对废弃项完成分类。
  3. 使用 Sourcegraph:对每个需研究的废弃项执行搜索以寻找使用证据。每次只搜索一个废弃项;信息不足时不要发起搜索。须通过 Sourcegraph MCP server 做关键词搜索,query 参数使用下列精确查询,并替换其中的名称占位符:
    • 组件、函数、常量:将 NAME_HERE 替换为废弃的组件/函数/常量名: NOT repo:frontend/cds(-(internal|public|next))?$ file:..(t|j)sx?$ /import[^;'"]*?\bNAME_HERE\b[^;'"]*?from\s+['"][^'"]*(?:cds-web|cds-mobile)[^'"]*['"]/
    • React prop:将 NAME_HERE 替换为 React 组件名,PROP_HERE 替换为废弃 prop 名: NOT repo:frontend/cds(-(internal|public|next))?$ file:..(t|j)sx?$ /<\\s*NAME_HERE\\b[^>]*?\\s+PROP_HERE[\\s=\/>]/
  4. 结构化输出:
    • 单个废弃项:给出找到的总使用次数,并输出 Markdown 表格,列为 Repo、Hits、Search Link;每个链接为完整 Sourcegraph URL,直达该废弃项对应的正则搜索,并按该行仓库过滤。
    • 多个废弃项:列出每个废弃项及其 Sourcegraph 查询返回的总匹配数。

适用场景

适用于评估 CDS 废弃 API 在客户代码库中的实际使用规模,为版本发布中是否移除导出提供依据;既可针对单个废弃项,也可对全部废弃项做系统性审计。

限制

仅研究本仓库源码中单个废弃项时不得使用 Sourcegraph;搜索必须通过 Sourcegraph MCP server,使用规定的精确查询,并一次只查一个废弃项;信息不足时不得发起搜索。全面审计依赖 scripts/findDeprecations.mjs 脚本输出;移除决策受“保留一个完整大版本、最早 M+2”策略约束。