lsd-rs/lsd

mention shell completions usage in `README.md`

Aberta

#853 aberto em 5 de jun. de 2023

Ver no GitHub
 (3 comentários) (0 reação) (0 responsável)Rust (434 forks)batch import
good first issuehelp wantedkind/doc

Métricas do repositório

Stars
 (13.400 estrelas)
Métricas de merge de PR
 (Mesclagem média 34d 3h) (2 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue como as conclusões de shell são geradas no arquivo build.rs e decida se documentar as variáveis de ambiente ou adicionar um sinalizador CLI para geração em tempo de execução.
Pilha de tecnologia
rust
Domain
cli
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75