yugabyte/yugabyte-db

[usability] Allow prefix matching for yb-admin commands

Open

#9 624 ouverte le 6 août 2021

Voir sur GitHub
 (4 commentaires) (0 réactions) (1 assigné)C (1 003 forks)batch import
area/docdbgood first issuehelp wantedkind/enhancementpriority/medium

Métriques du dépôt

Stars
 (8 229 stars)
Métriques de merge PR
 (Merge moyen 17j 21h) (92 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la logique d'analyse des commandes yb admin. Identifiez l'endroit où les commandes sont mises en correspondance et implémentez la correspondance par préfixe : si une commande partielle correspond de manière unique à une commande complète, proposez de l'exécuter (avec une option de confirmation). En cas de correspondances multiples, listez les. Recherchez la structure d'enregistrement des commandes existante.
Stack technique
cgo
Domaine
cli
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitcommand line basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60