89luca89 / 89luca89/distrobox

[Suggestion] Provide fish shell completions / Fix commands format in the man page

Aberta
#1,425 8 comentários 7 reações 0 responsáveis Ver no GitHub
enhancement good first issue help wanted
Linguagem predominante
Go
Estrelas
13k
Forks
541
Merge médio
20h 47min
PRs com merge (30d)
4

Descrição

**Is your feature request related to a problem? Please describe.**
Distrobox man pages specify commands using the following layout:
```
distrobox create

--image/-i: image to use for the container default: ${container_image_default}
--name/-n: name for the distrobox default: ${container_name_default}
--hostname: hostname for the distrobox default: .$(uname -n)
--pull/-p: pull the image even if it exists locally (implies --yes)
--yes/-Y: non-interactive, pull images without asking
```

This is fine for a human, but it causes fish shell to have buggy completions:
```
❯ distrobox-create --absolutely-disable-root-password-i-am-really-positively-sure
--absolutely-disable-root-password-i-am-really-positively-sure (COMPATIBILITY for a list of compatible images and container managers, please …)
--additional-flags/-a
--additional-packages/-ap
--clone/-c (this will be useful to either rename an existing distrobox or hav…)
--compatibility/-C
--dry-run/-d
--help/-h
--home/-H
--hostname
--image/-i
--init/-I (this will make host[aq]s processes not visible from within the co…)
--init-hooks
--name/-n
--no-entry
--nvidia
--pre-init-hooks
--pull/-p
--root/-r (way over [dq]sudo distrobox[dq] (note: if using a program other t…)
```

As you can see, the completion are in the format --longcommand/-shortcommand and if you complete your prompt using TAB then the completion will not work. You have to manually go and delete the last part

**Describe the solution you'd like**
I'd like the distrobox man page to list commands in the man page in the classic format, or at least I'd like for it to provide correct fish shell completions which is all I really care about.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Veja a geração de man page no projeto para entender como as opções são formatadas. A issue menciona que fish completions estão com bugs devido ao formato --long/-short. Verifique os shell completion scripts existentes, provavelmente em um diretório completions/, e veja como fish espera as opções. Teste gerando uma man page corrigida ou adicionando um fish completion script, depois verifique com fish's completion system.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
fish, shell
Domínio
cli, documentation
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
50/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.