fix: Wrong completion context for chained commands in zsh
還沒有人認領這個 Issue。
評估
研究方向
Start with lib/src/installer/shell_completion_configuration.dart and CompletionState.fromEnvironment, which the issue identifies as passing and reading the completion context. Check the existing completion tests and how the words passed after completion -- relate to COMP_CWORD. Done means commands after |, && or ; suggest the current command’s options, while existing bash completion still works.
由索引模型根據 Issue 內容生成。
描述
Description
Thank you for this cool lib! I'm facing a minor bug when used with zsh.
In zsh, completing a command that isn't at the start of the command line (after |, && or ;) uses the wrong context. The zsh script passes COMP_LINE="$BUFFER", which is zsh's whole edit buffer, and CompletionState.fromEnvironment reads the arguments from COMP_LINE. So everything typed before the current command is treated as CLI arguments.
Steps To Reproduce
Take a CLI my_cli built on CompletionCommandRunner, with commands foo and bar that have different options, and install its completion in zsh with my_cli install-completion-files.
my_cli foo | my_cli bar <TAB>suggestsfoo's options. The request is parsed asfoo | my_cli bar '', sofoois taken as the command being completed.cd somewhere && my_cli bar <TAB>suggests nothing, so zsh falls back to file names.
Without a shell, this is the request zsh sends for step 1:
ZSH_NAME=zsh COMP_LINE='my_cli foo | my_cli bar ' COMP_POINT=24 COMP_CWORD=2 \
my_cli completion -- my_cli bar ''
It prints foo's options.
Expected Behavior
A command after |, && or ; completes the same way as at the start of the line. Both my_cli foo | my_cli bar <TAB> and cd somewhere && my_cli bar <TAB> suggest bar's options, just like my_cli bar <TAB>. Bash already behaves this way.
Additional Context
Cause
- The zsh template in
lib/src/installer/shell_completion_configuration.dartrunsCOMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" … completion -- "${words[@]}".$BUFFERis the whole edit buffer, while$wordsand$CURRENTcover only the current command. CompletionState.fromEnvironmenttakes the arguments fromCOMP_LINE(line.trimLeft().split(' ').skip(1)) and ignores the words passed aftercompletion --.- Bash isn't affected, because bash itself limits
COMP_LINEto the current command. With bash 3.2,echo x | mycmd a <TAB>setsCOMP_LINEtomycmd a.
Suggested fix
Build the arguments from the words the scripts already pass after completion --, up to COMP_CWORD, instead of from COMP_LINE. Both scripts pass only the current command's words there, so this fixes zsh without changing the scripts or making users reinstall them.
Workaround
Until this is fixed, a CLI can narrow COMP_LINE itself before the request is handled, in its CompletionCommandRunner subclass:
@override
Future<int?> runCommand(ArgResults topLevelResults) {
final command = topLevelResults.command;
if (command?.name == HandleCompletionRequestCommand.commandName) {
final words = command!.rest; // the words after `completion --`
final environment = Platform.environment;
final cword = int.tryParse(environment['COMP_CWORD'] ?? '');
if (cword != null && cword >= 0 && cword < words.length) {
final line = words.take(cword + 1).join(' ');
environmentOverride = {...environment, 'COMP_LINE': line, 'COMP_POINT': '${line.length}'};
}
}
return super.runCommand(topLevelResults);
}
Environment
- cli_completion 0.6.0
- Dart 3.13.3
- zsh 5.9, macOS (arm64)
- 主要語言
- Dart
- 星號
- 54
- 分支
- 6
- 平均合併
- 24 分鐘
- 30 天內合併 PR
- 1
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 沒有貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
VeryGoodOpenSource/cli_completion 的其他 Issue
-
feature p3
難度 5/5 一週以上 新手友好度 30/100
VeryGoodOpenSource/cli_completion#91 · 2 則留言 · 1 個 reaction ·
-
feature p3
難度 3/5 1-2 天 新手友好度 35/100
VeryGoodOpenSource/cli_completion#90 · 1 則留言 · 1 個 reaction ·
-
feat: CLI-user configurable auto install可能已有人在做 @vgvbot 於 54 天前認領。 未關閉feature p2
VeryGoodOpenSource/cli_completion#55 · 1 則留言 · 1 個 reaction · 已指派 1 人 ·
-
feature p2
難度 4/5 3-5 天 新手友好度 35/100
VeryGoodOpenSource/cli_completion#47 · 2 則留言 · 2 個 reaction ·
查看 VeryGoodOpenSource/cli_completion 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 62/100
維護者通常 1 天內回覆
-
documentation good first issue
難度 1/5 1 小時以內 新手友好度 88/100
djazairdev/wilayas#22 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 80/100
rajput-hemant/calculator#199 ·
-
難度 2/5 1-3 小時 新手友好度 62/100
leancodepl/app-rating#35 ·
-
Mobile login: "Sign In" button is squashed to 16 px with its label cut while the keyboard is open未關閉ai-driven-qa bug claude
難度 2/5 1-3 小時 新手友好度 78/100
linagora/tmail-flutter#4976 ·
維護者通常 1 天內回覆