Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Chiusa
  • Qualcosa non va?
#634 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@margaretjgu ci sta già lavorando.

Dal 22/9/2026.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
cli, documentation, testing

Direzione di ricerca

Leggi AGENTS.md e il lavoro sull’argomento della guida in #630 per identificare le stringhe error.code esistenti e le aspettative documentate sui codici di uscita. Esegui il probe di elastic status --json per i flussi auth_required e transport_error, quindi aggiungi un test per ogni codice documentato e verifica gli errori JSON in caso di configurazione mancante e la nota nel changelog per qualsiasi codice modificato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
45
Fork
26
Merge medio
2g 1h
PR unite (30g)
51

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di elastic/cli

Tutte le issue di elastic/cli

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.