lsd-rs/lsd

mention shell completions usage in `README.md`

Aperta

#853 aperta il 5 giu 2023

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Rust (434 fork)batch import
good first issuehelp wantedkind/doc

Metriche repository

Star
 (13.400 stelle)
Metriche merge PR
 (Merge medio 34g 3h) (2 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Investiga come vengono generate le completazioni di shell nel file build.rs e decidi se documentare le variabili d'ambiente o aggiungere un flag CLI per la generazione a runtime.
Tech stack
rust
Dominio
cli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75