CLI に機械可読な出力を足す
収録 2026-11-06
人向けの出力とプログラム向けの出力は分けるべき。
CLI があります：[用途、現在の出力、利用者]。機械可読な出力を足してください：1）`--json` モードのスキーマ（成功・失敗・部分成功）；2）人間向け出力と共存し、既存スクリプトを壊さない方法；3）失敗種別を判別できる終了コードとエラーオブジェクト；4）ページング、ストリーム、巨大出力の扱い；5）安定性の約束（変わりうる項目、実験的項目の印）；6）追加すべきテストと文書、移行例。
当サイトオリジナル
中国語の原文
置き換えるプレースホルダー 1
括弧の中をご自身の情報に置き換えてから送ってください。
[用途、現在の出力、利用者]
使い方
まず JSON と終了コードを決め、人間向けの整形は後回しにする。
こう変えてみる
- コードを書く前に要件と制約を復唱させる。
- 全体書き換えではなく、最小の変更とロールバック方法を出させる。
得られる成果物
- そのまま使える最小変更（コピー可能なコード）
- 影響範囲：変更ファイルと追従が必要な呼び出し元
よくある失敗
- 一度に十ファイル変更させ、何が原因か分からなくなる。
- エラーだけ貼ってコードとバージョンを省くと、使えない修正が返る。
出力のチェック
- 変更は動いて戻せて、無関係なコードに手を入れていない。
- 境界条件（空・巨大・同時実行）が説明かテストで押さえられている。
使いどころと注意
- 向いている用途：要件と制約を復唱させてから、最小限の動く変更を出させる。
- 注意：エラーにはバージョンと最小再現を添える。無いと一見もっともらしいが合わない修正が返る。