yugabyte/yugabyte-db

[usability] Allow prefix matching for yb-admin commands

Open

#9.624 aberto em 6 de ago. de 2021

Ver no GitHub
 (4 comments) (0 reactions) (1 assignee)C (1.003 forks)batch import
area/docdbgood first issuehelp wantedkind/enhancementpriority/medium

Métricas do repositório

Stars
 (8.229 stars)
Métricas de merge de PR
 (Mesclagem média 17d 21h) (92 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Examine a lógica de análise de comandos do yb admin. Identifique onde os comandos são correspondidos e implemente a correspondência por prefixo: se um comando parcial corresponder exclusivamente a um comando completo, ofereça para executá lo (com opção de confirmação). Se houver várias correspondências, liste as. Procure a estrutura de registro de comandos existente.
Pilha de tecnologia
cgo
Domain
cli
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitcommand line basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60