SuperAPI AI 工具集

add-diagnostic

编程与开发

查看项目

更新于 10-16 02:24

技能介绍

用途

add-diagnostic 是一个用于在 nostics 项目中新增诊断代码(diagnostic code)的技能。它围绕 defineDiagnostics() 的约定,帮助开发者以统一规范添加新的诊断条目,使错误信息、修复建议和文档链接保持一致。

主要能力

该技能覆盖新增诊断代码的完整流程:

  1. 定位目录:通过搜索 defineDiagnostics 找到新条目应归属的 codes 对象;若存在多个目录,则按领域选择。
  2. 选取代码:代码格式为 PREFIX_XNNNN。其中 PREFIX 是项目名的大写形式(如 NUXT、I18N);X 是领域字母(B 表示 build、R 表示 runtime、C 表示 config、D 表示 deprecation);NNNN 是下一个可用编号。需阅读现有代码来选定,且不得重命名或复用已发布的代码。
  3. 添加条目:条目包含 why、fix、docs 等字段。why 是唯一必填字段,可以是字符串或带类型的函数,其内容会成为 Error.message;fix 为可选字段,但在已知修复方式时应尽量填写;docs 为可选字段,可覆盖 docsBase,或设为 false 以退出文档链接。why 与 fix 的参数会被取交集,并在调用处成为必填参数。
  4. 运行时字段:cause、sources 等运行时字段在调用处传入,绝不在定义中声明。
  5. 调用方式:使用 diagnostics.LIB_R0001({ hook }) 上报,或使用 throw diagnostics.LIB_R0001({ hook, cause: err }) 抛出;两者都会运行 reporter。

使用方式

按照技能说明,先搜索 defineDiagnostics 定位目录,再依据命名规则选取代码,随后添加条目并填写 why(必填)、fix、docs 等字段,最后在调用处传入所需参数进行上报或抛出。完整的 API 以及 reporter、formatter、plugin 的细节可参考 nostics 技能。

适用场景

适用于在 nostics 项目中新增诊断代码、统一错误信息与修复提示、维护诊断代码目录规范的开发场景。

限制

资料未提供该技能的安装方式、依赖要求、支持平台、收费情况或实际运行效果等信息,暂未提供。