yugabyte/yugabyte-db

[usability] Allow prefix matching for yb-admin commands

Open

#9624 aperta il 6 ago 2021

Vedi su GitHub
 (4 commenti) (0 reazioni) (1 assegnatario)C (1003 fork)batch import
area/docdbgood first issuehelp wantedkind/enhancementpriority/medium

Metriche repository

Star
 (8229 star)
Metriche merge PR
 (Merge medio 17g 21h) (92 PR mergiate in 30 g)

Descrizione

Jira Link: DB-2024 Currently when yb-admin command is slightly misspelled, e.g. list_snapshot_schedule instead of list_snapshot_schedules, the user would be given the whole list of commands.

User experience can be improved by using the (partial) command as prefix.

If there is only one match, that match would be picked - we can ask the user to confirm the selection (or add option, say -accept-prefix-match which would accept the selection without asking). In case there are multiple candidates for the given prefix, the list of commands would be printed.

Guida contributor

Direzione di ricerca
Esamina la logica di analisi dei comandi yb admin. Identifica dove vengono confrontati i comandi e implementa la corrispondenza per prefisso: se un comando parziale corrisponde in modo univoco a un comando completo, offri di eseguirlo (con opzione di conferma). Se ci sono più corrispondenze, elencale. Cerca la struttura di registrazione dei comandi esistente.
Tech stack
cgo
Dominio
cli
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitcommand line basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60