lsd-rs/lsd

mention shell completions usage in `README.md`

Ouverte

#853 ouverte le 5 juin 2023

Voir sur GitHub
 (3 commentaires) (0 réaction) (0 personne assignée)Rust (434 forks)batch import
good first issuehelp wantedkind/doc

Métriques du dépôt

Stars
 (13 400 étoiles)
Métriques de merge PR
 (Merge moyen 34j 3h) (2 PRs mergées en 30 j)

Description

https://github.com/lsd-rs/lsd/blob/2fe3fcdd3564836962eab8ba6b1444996fe24e1e/build.rs#L24-L36

despite lsd providing shell completions via clap_complete::generate_to, there is no documentation that either SHELL_COMPLETIONS_DIR or OUT_DIR environment variable needs to be set to generate one.

alternatively, LSD could provide a command-line option to generate completions at runtime.

Guide contributeur

Direction de recherche
Enquêtez sur la façon dont les complétions de shell sont générées dans le fichier build.rs et déterminez s'il faut documenter les variables d'environnement ou ajouter un indicateur CLI pour la génération à l'exécution.
Stack technique
rust
Domaine
cli
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75