An option is resolved from the root before the matched command, so a short name means one thing for the whole line
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 56/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- javascript, typescript
- Área
- cli
Línea de trabajo
Comienza con RootCommand#shouldCompleteFlags() y #stripOptions(), y luego sigue cómo matchCommand() llama a este último y cómo handleFlagCompletion() utiliza el comando coincidente. Ejecuta la reproducción proporcionada con Node y compara la finalización para los cuatro casos de argv. Se considera terminado cuando la aridad de las opciones sigue al comando establecido en cada posición, mientras que las opciones raíz anteriores a un comando siguen comportándose como antes.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 282
- Forks
- 11
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de bombshell-dev/tab
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
bombshell-dev/tab#127 · 2 comentarios ·
-
support completions for npx/bunxAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
bombshell-dev/tab#118 ·
-
provide installation utilitiesPosiblemente ocupada @theoephraim la tomó hace 138 días. Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
bombshell-dev/tab#117 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
bombshell-dev/tab#107 · 3 comentarios ·
-
documentation enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
bombshell-dev/tab#106 · 1 comentario ·
Todos los issues de bombshell-dev/tab
Issues similares
-
Create/import wallet form shows raw "password must be at least 1 characters" instead of the translated messagePosiblemente ocupada @CapThunder19 la tomó hoy. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
joinmarket-webui/jam#1538 ·
Los mantenedores suelen responder en 1 día
-
t0ggles
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
nolimits4web/swiper#8240 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
modelcontextprotocol/inspector#2723 ·
Los mantenedores suelen responder en 1 día
-
status:approved type:bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
egdev6/quorb#109 · 1 comentario ·
Los mantenedores suelen responder en 1 día