关于 add-diagnostic
add-diagnostic 是一份指导开发者为 nostics 诊断目录添加新代码的技能说明。它涵盖代码命名、定义字段和调用方式,并强调已发布代码不可重命名或复用。
主要功能
- 01定位合适的诊断目录
- 02按约定选择稳定代码
- 03添加原因与可选修复建议
- 04传入运行时字段并调用诊断
适用场景
- 01为新错误类型登记诊断代码
- 02扩展多个领域的诊断目录
- 03为诊断补充参数化原因和修复建议
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ vercel-labs/ nostics --skill add-diagnostic安装后在 Claude Code 中输入/add-diagnostic确认已加载。
详细介绍
添加新的诊断代码
- 查找目录。 搜索
defineDiagnostics,找到新条目所属的codes对象。如果有多个目录,请按领域选择。 - 选择代码。
PREFIX_XNNNN:PREFIX是大写的项目名称(NUXT、I18N);X是领域字母(B表示构建,R表示运行时,C表示配置,D表示弃用);NNNN是下一个可用编号。阅读现有代码后再选择。已发布的代码绝不能重命名或重复使用。 - 添加条目:
LIB_R0001: {
why: (p: { hook: string }) => `${p.hook}() must run at the top of setup().`, // string or typed fn; becomes Error.message (required)
fix: 'Move the call into setup() or a composable it calls.', // optional, but add whenever the fix is known
docs: 'https://example.com/custom', // optional: overrides docsBase, or `false` to opt out
},
why是唯一必填字段。why和fix中的参数会合并,且必须在调用处提供。- 运行时字段(
cause、sources)在调用处传入,绝不能写在定义中。
- 调用: 使用
diagnostics.LIB_R0001({ hook })报告,使用throw diagnostics.LIB_R0001({ hook, cause: err })抛出错误。两种方式都会运行报告器。
完整的 API 以及报告器、格式化器和插件详情:nostics 技能。
评论
支持 Markdown