Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

An option is resolved from the root before the matched command, so a short name means one thing for the whole line

未关闭
  • 哪里不对？
#153 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@AmirSa12 已经在做这个了。

开始于 2026年10月5日。

  • #154 来自 @AmirSa12 —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
56/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
javascript, typescript
领域
cli

调研方向

从 RootCommand#shouldCompleteFlags() 和 #stripOptions() 开始，然后跟踪 matchCommand() 如何调用后者，以及 handleFlagCompletion() 如何使用匹配的命令。使用 Node 运行提供的复现，并比较四种 argv 情况下的补全结果。完成的标准是：选项的参数数量遵循每个位置上确定的命令，同时命令之前的 root 选项仍像以前一样工作。

由索引模型根据 Issue 内容生成。

描述

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 -h was read as the root's boolean help. Expected: localhost, the value of the command's --host.
  • serve -h localhost <TAB> offers nothing, because localhost was 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 -h in 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.

主要语言
TypeScript
星标
280
派生
11
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

bombshell-dev/tab 的其他 Issue

查看 bombshell-dev/tab 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。