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

Consider including region in callback data

Aperta
  • Qualcosa non va?
#12 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
api, cli

Direzione di ricerca

La issue indica l'API e la CLI, ma non specifica file né test. Inizia individuando i percorsi attuali dei dati di callback e dell'output della CLI, quindi risolvi i dubbi sulla rappresentazione proposta della regione, sui valori predefiniti e sulla compatibilità. Il lavoro è completato quando il comportamento dell'API e della CLI, inclusa un'eventuale scelta di opt-in o del formato di output, è deciso e implementato esplicitamente.

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

Descrizione

API

Should be relatively easy to add to the API, providing an object instead of a string, like so:

{
  "name": "aws",
  "region": "us-east-1"
}

And possibly just use the default "unknown" if it can't be determined.

This would, of course, represent a major/breaking change. Unless the API was changed in a backwards-compatible way by accepting an optional opts object that could ask for region data via region: true or detailed: true. But this might be overkill.

CLI

This poses a couple interesting problems for the CLI:

Does the CLI return the extra info by default, or should it be explicitly requested (and how)?

If it's included by default in the API, I would argue it should be included by default in the CLI. However, it would certainly be acceptable to make it opt-in via a flag like --detailed or --verbose. (It could also be opt-out via --brief or --simple.)

How should the data be represented/formatted?

I think, by default, we should stick with a simple format that is human-friendly but also not too difficult to parse, perhaps name:region. Otherwise, it would be nice to support explicit CLI options to output more machine-friendly formats, like --json.

All of the above is open to suggestions. What do you think?

Lingua principale
JavaScript
Stelle
141
Fork
11
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 bcoe/which-cloud

Tutte le issue di bcoe/which-cloud

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.