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 対応