An option is resolved from the root before the matched command, so a short name means one thing for the whole line
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 56/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- javascript, typescript
- Domínio
- cli
Direção de pesquisa
Comece com RootCommand#shouldCompleteFlags() e #stripOptions(), depois acompanhe como matchCommand() chama o último e como handleFlagCompletion() usa o comando correspondente. Execute a reprodução fornecida com Node e compare a conclusão para os quatro casos de argv. Está concluído quando a aridade das opções segue o comando definido em cada posição, enquanto as opções root antes de um comando continuam funcionando como antes.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
What happens
RootCommand#shouldCompleteFlags() and #stripOptions() decide whether the word after an option is that option's value. Both resolve the option with findOption(this, arg) — the root first — and fall back to the registered commands only when the root does not have it. An option therefore has one arity for the whole line, whichever command the cursor is in.
A CLI whose root carries the program's own options, and whose sub-command gives one of those letters to an option that takes a value, cannot be completed there.
Reproduction
// repro.mjs — `npm i @bomb.sh/[email protected]`, then `node repro.mjs`
import { RootCommand } from '@bomb.sh/tab'
const build = () => {
const root = new RootCommand()
root.option('help', 'Display this help message', 'h') // boolean, takes no value
const serve = root.command('serve', 'Serve the app')
serve.option('host', 'Host name', c => c('localhost', ''), 'h') // takes a value, same letter
serve.argument('env', c => {
c('prod', '')
c('staging', '')
})
return root
}
for (const argv of [
['serve', '-h', ''],
['serve', '-h', 'localhost', ''],
['serve', '--host', ''],
['-h', '']
]) {
process.stdout.write(`${JSON.stringify(argv).padEnd(36)} => `)
build().parse([...argv])
}
Actual output (@bomb.sh/tab 0.0.22, Node 24.21.0). Each request prints its candidates one per line; they are joined with / here:
["serve","-h",""] => prod / staging / :4
["serve","-h","localhost",""] => :4
["serve","--host",""] => localhost / :4
["-h",""] => serve / :4
serve -h <TAB>offers the positional, because-hwas read as the root's booleanhelp. Expected:localhost, the value of the command's--host.serve -h localhost <TAB>offers nothing, becauselocalhostwas counted as the positional. Expected:prod,staging.- The last two lines are the controls, and both are right: the long name resolves against the command, and
-hin front of a command name is the root's.
Why it is not simply "look at the matched command"
stripOptions() is what matchCommand() calls to find the command, so the command is not known when the question is asked. Fixing it means walking the words in order and resolving each option against the command that is settled at that point — the root until a command name is matched, then that command, and so on.
handleFlagCompletion() already resolves against the matched command, so once shouldCompleteFlags() answers correctly for a letter typed behind a command name, the value completion follows.
Related
Issue #110 (closed) is the same family: handlePositionalCompletion() counted words without stripping options. This is the other half — the stripping itself does not know where it is.
Downstream
gunshi (kazupon/gunshi#744) works around it by re-registering the root's entry for that one letter, for the duration of one completion request, and only when the letter was typed behind the matched command's name
(PR #753, corrected in PR #754 — the first attempt re-registered the root's entry under the option's long name, which flipped the arity of --help too). The workaround cannot express the same letter on both sides of a command name, because one Option carries one arity for the request. If the lookup here becomes positional, that workaround is deleted whole.
- Linguagem predominante
- TypeScript
- Estrelas
- 282
- Forks
- 11
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de bombshell-dev/tab
-
enhancement
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
bombshell-dev/tab#127 · 2 comentários ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
bombshell-dev/tab#118 ·
-
provide installation utilitiesTalvez já em andamento @theoephraim assumiu há 140 dias. Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
bombshell-dev/tab#117 ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
bombshell-dev/tab#107 · 3 comentários ·
-
documentation enhancement
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
bombshell-dev/tab#106 · 1 comentário ·
Todas as issues de bombshell-dev/tab
Issues semelhantes
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 80/100
aws/agentcore-cli#2606 ·
Mantenedores costumam responder em até 1 dia
-
ai-driven-qa bug Cosmetic
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
Mantenedores costumam responder em até 1 dia
-
ai-driven-qa bug claude Minor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
linagora/twake-mail-admin#301 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Mantenedores costumam responder em até 1 dia
-
reproduced
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
anomalyco/opencode#56038 · 1 comentário ·
Mantenedores costumam responder em até 1 dia