Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

feat: document and stabilize exit codes and error.code values

クローズ
#634 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@margaretjgu がすでに取り組んでいます。

2026年9月22日 から。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript

調査の方向性

AGENTS.md と #630 のヘルプトピックに関する作業を読んで、既存の error.code 文字列と文書化された終了コードの期待値を確認します。auth_required と transport_error のフローについて elastic status --json を試し、その後、文書化されたコードごとに 1 つのテストを追加し、設定がない場合の JSON エラーと、変更したコードについての changelog の注記を確認します。

索引モデルが issue の本文から書いたものです。

説明

enhancement

We almost always exit 1. JSON errors use ad hoc error.code strings (transport_error, confirmation_required, input_validation_failed, command_blocked) with no catalog.

For agents this is the difference between retry with --yes and give up.

  1. Publish a table (help topic in #630): 0 success, 1 generic, then reserve 2 usage, 3 validation, 4 auth/config, 5 network. Implementing the split can follow the table. Do not silently change codes on existing scripts without a changelog note.
  2. Freeze error.code strings in AGENTS.md. Add codes for auth_required, config_invalid, not_found if we do not already emit them.
  3. elastic status --json should be the probe agents run after auth_required / transport_error.

Acceptance: help topic lists codes. --json errors on a missing config use a documented code. One test per code.

主要言語
TypeScript
スター
47
フォーク
27
平均マージ
2日 15分
マージ済み PR(30日)
56

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

elastic/cli のほかの issue

elastic/cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。