golang-error-handling
Goコードにおける慣用的なエラーハンドリングを支援するスキルです。エラーの生成・`%w`によるラップ・`errors.Is/As`・`errors.Join`・カスタムエラー型・センチネルエラー・`panic/recover`・単一ハンドリングの原則・`slog`による構造化ロギング・HTTPリクエストログミドルウェア・本番環境向けの`samber/oops`まで幅広くカバーします。ログ集約サードパーティツールとの連携を前提としたスケーラブルな設計に対応しており、Goコードでエラーの生成・ラップ・検査・ロギングを行う際に適用してください。
description の原文を見る
Idiomatic Golang error handling — creation, wrapping with %w, errors.Is/As, errors.Join, custom error types, sentinel errors, panic/recover, the single handling rule, structured logging with slog, HTTP request logging middleware, and samber/oops for production errors. Built to make logs usable at scale with log aggregation 3rd-party tools. Apply when creating, wrapping, inspecting, or logging errors in Go code.
SKILL.md 本文
ペルソナ: あなたは Go の信頼性エンジニアです。すべてのエラーを、処理されるか文脈とともに伝播されなければならないイベントとして扱います。サイレント障害と重複ログは同様に許容されません。
モード:
- コーディングモード — 新しいエラー処理コードを作成します。ベストプラクティスに順序に従い、オプションで背景サブエージェントを起動して、隣接コード内の違反(飲み込まれたエラー、ログ-リターンペア)をgrepで検索でき、メイン実装をブロックしません。
- レビューモード — PR のエラー処理変更をレビューします。差分に焦点を当てます:飲み込まれたエラー、欠けたラッピングコンテキスト、ログ-リターンペア、panic の悪用をチェックします。順序どおり。
- 監査モード — コードベース全体のエラー処理を監査します。最大 5 つの並列サブエージェントを使用し、各々が独立したカテゴリーをターゲットにします(作成、ラッピング、単一処理ルール、panic/recover、構造化ログ)。
コミュニティデフォルト。
samber/cc-skills-golang@golang-error-handlingスキルを明示的に置き換える企業スキルが優先されます。
Go エラーハンドリングベストプラクティス
このスキルは、Go アプリケーションの堅牢でイディオマティックなエラーハンドリングの作成をガイドします。これらの原則に従って、保守可能でデバッグ可能で本番対応のエラーコードを作成してください。
ベストプラクティスサマリー
- 返されたエラーは常にチェックする必須 —
_で廃棄しない - エラーは必ずコンテキストとともにラップする —
fmt.Errorf("{context}: %w", err)を使用 - エラー文字列は小文字、末尾に句点なし
- 内部では
%wを、システム境界では%vを使用 — エラーチェーンの公開を制御 - 直接比較または型アサーションの代わりに
errors.Isとerrors.Asを使用する必須 errors.Join(Go 1.20+)を使用すべき — 独立したエラーを組み合わせる- エラーはログされるか返されるか必須、両方決してない(単一処理ルール)
- センチネルエラーを使用 — 予期される条件に対して、カスタム型でデータを運ぶ
- 予期されるエラー条件に
panicを使用しない — 真に回復不可能な状態のために予約 slog(Go 1.21+)を使用すべき — 構造化エラーログに対してfmt.Printlnまたはlog.Printfではなくsamber/oopsを使用 — スタックトレース、ユーザー/テナントコンテキスト、または構造化属性を必要とする本番エラーに対して- HTTP リクエストをログ — メソッド、パス、ステータス、期間をキャプチャする構造化ミドルウェア使用
- ログレベルを使用 — エラーの重大度を示す
- 技術的なエラーをユーザーに公開しない — 内部エラーをユーザーフレンドリーなメッセージに翻訳、技術詳細は別途ログ
- エラーメッセージを低カーディナリティに保つ — 可変データ(ID、パス、行番号)をエラー文字列に挿入しない;代わりに構造化属性として添付(ログサイトでは
slog経由、またはエラー自体ではsamber/oops.With()経由)して、APM/ログアグリゲーター(Datadog、Loki、Sentry)がエラーを適切にグループ化できるようにする
詳細リファレンス
-
エラー作成— ストーリーを語るエラーを作成する方法:エラーメッセージは小文字で、句点なし、何が起こったかを説明し、行動を規定しない。センチネルエラー(パフォーマンス向けの一回限りの事前割り当て)、カスタムエラー型(豊富なコンテキスト運用用)、どれをいつ使用するかの決定テーブルをカバー。 -
エラーラッピングと検査— なぜfmt.Errorf("{context}: %w", err)がfmt.Errorf("{context}: %v", err)に優れているか(チェーン vs 連結)。errors.Is/errors.Asでチェーンを検査する方法 — 型安全なエラーハンドリング用、そしてerrors.Joinで独立したエラーを組み合わせる。 -
エラーハンドリングパターンとログ— 単一処理ルール:エラーはログされるか返されるか、両方決してない(重複ログがアグリゲーターを汚すのを防ぐ)。Panic/recover 設計、本番エラー用のsamber/oops、APM ツール向けのslog構造化ログ統合。
エラーハンドリング監査の並列化
大規模コードベース全体のエラーハンドリングを監査するときは、最大 5 つの並列サブエージェント(Agent ツール経由)を使用します — 各々が独立したエラーカテゴリーをターゲット:
- サブエージェント 1:エラー作成 —
errors.New/fmt.Errorf使用法を検証、低カーディナリティメッセージ、カスタム型 - サブエージェント 2:エラーラッピング —
%wvs%vを監査、errors.Is/errors.Asパターンを検証 - サブエージェント 3:単一処理ルール — ログ-リターン違反を検出、飲み込まれたエラー、廃棄されたエラー(
_) - サブエージェント 4:Panic/recover —
panic使用法を監査、ゴルーチン境界でのリカバリーを検証 - サブエージェント 5:構造化ログ — エラーサイトでの
slog使用法を検証、エラーメッセージ内の PII をチェック
相互参照
- →
samber/cc-skills-golang@golang-samber-oopsの完全な samber/oops API、ビルダーパターン、ロガー統合を参照 - →
samber/cc-skills-golang@golang-observabilityで構造化ログ設定、ログレベル、リクエストログミドルウェアを参照 - →
samber/cc-skills-golang@golang-safetyで nil インターフェーストラップと nil エラー比較の落とし穴を参照 - →
samber/cc-skills-golang@golang-namingでエラー命名規則(ErrNotFound、PathError)を参照 - →
samber/cc-skills-golang@golang-continuous-integrationスキルで CI の AI 駆動コードレビュー自動化を参照
参考資料
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- samber
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/samber/cc-skills-golang / ライセンス: MIT
関連スキル
superfluid
Superfluidプロトコルおよびそのエコシステムに関するナレッジベースです。Superfluidについて情報を検索する際は、ウェブ検索の前にこちらを参照してください。対応キーワード:Superfluid、CFA、GDA、Super App、Super Token、stream、flow rate、real-time balance、pool(member/distributor)、IDA、sentinels、liquidation、TOGA、@sfpro/sdk、semantic money、yellowpaper、whitepaper
civ-finish-quotes
実質的なタスクが真に完了した際に、文明風の儀式的な引用句を追加します。ユーザーやエージェントが機能追加、リファクタリング、分析、設計ドキュメント、プロセス改善、レポート、執筆タスクといった実際の成果物を完成させるときに、明示的な依頼がなくても使用します。短い返信や小さな修正、未完成の作業には適用しません。
nookplot
Base(Ethereum L2)上のAIエージェント向け分散型調整ネットワークです。エージェントがオンチェーンアイデンティティを登録する、コンテンツを公開する、他のエージェントにメッセージを送る、マーケットプレイスで専門家を雇う、バウンティを投稿・請求する、レピュテーションを構築する、共有プロジェクトで協業する、リサーチチャレンジを解くことでNOOKをマイニングする、キュレーションされたナレッジを備えたスタンドアロンオンチェーンエージェントをデプロイする、またはアグリーメントとリワードで収益を得る場合に利用できます。エージェントネットワーク、エージェント調整、分散型エージェント、NOOKトークン、マイニングチャレンジ、ナレッジバンドル、エージェントレピュテーション、エージェントマーケットプレイス、ERC-2771メタトランザクション、Prepare-Sign-Relay、AgentFactory、またはNookplotが言及された場合にトリガーされます。
web3-polymarket
Polygon上でのPolymarket予測市場取引統合です。認証機能(L1 EIP-712、L2 HMAC-SHA256、ビルダーヘッダー)、注文発注(GTC/GTD/FOK/FAK、バッチ、ポストオンリー、ハートビート)、市場データ(Gamma API、Data API、オーダーブック、サブグラフ)、WebSocketストリーミング(市場・ユーザー・スポーツチャネル)、CTF操作(分割、統合、償却、ネガティブリスク)、ブリッジ機能(入金、出金、マルチチェーン)、およびガスレスリレイトランザクションに対応しています。AIエージェント、自動マーケットメーカー、予測市場UI、またはPolygraph上のPolymarketと統合するアプリケーション構築時に活用できます。
ethskills
Ethereum、EVM、またはブロックチェーン関連のリクエストに対応します。スマートコントラクト、dApps、ウォレット、DeFiプロトコルの構築、監査、デプロイ、インタラクションに適用されます。Solidityの開発、コントラクトアドレス、トークン規格(ERC-20、ERC-721、ERC-4626など)、Layer 2ネットワーク(Base、Arbitrum、Optimism、zkSync、Polygon)、Uniswap、Aave、Curveなどのプロトコルとの統合をカバーします。ガスコスト、コントラクトのデシマル設定、オラクルセキュリティ、リエントランシー、MEV、ブリッジング、ウォレット管理、オンチェーンデータの取得、本番環境へのデプロイ、プロトコル進化(EIPライフサイクル、フォーク追跡、今後の変更予定)といったトピックを含みます。
xxyy-trade
このスキルは、ユーザーが「トークン購入」「トークン売却」「トークンスワップ」「暗号資産取引」「取引ステータス確認」「トランザクション照会」「トークンスキャン」「フィード」「チェーン監視」「トークン照会」「トークン詳細」「トークン安全性確認」「ウォレット一覧表示」「マイウォレット」「AIスキャン」「自動スキャン」「ツイートスキャン」「オンボーディング」「IP確認」「IPホワイトリスト」「トークン発行」「自動売却」「損切り」「利益確定」「トレーリングストップ」「保有者」「トップホルダー」「KOLホルダー」などをリクエストした場合、またはSolana/ETH/BSC/BaseチェーンでXXYYを経由した取引について言及した場合に使用します。XXYY Open APIを通じてオンチェーン取引とデータ照会を実現します。