Skip to content

fix: honor COMP_CWORD in generated completion #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeforester merged 2 commits into from
Sep 18, 2026
+62 −2
Merged

fix: honor COMP_CWORD in generated completion #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2b3d61
fix: limit generated completion to the cursor
codeforester Sep 17, 2026
5e0b409
fix(cli): complete next-word suggestions at cursor boundary
codeforester Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions lib/bash/cli/lib_cli.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1573,8 +1573,18 @@ base_cli_completion_script() {
fi
program="${__base_bash_libs_cli_models["$model|meta|name"]}"
printf '%s\n' "$function_name() {"
printf '%s\n' ' local current="${COMP_WORDS[COMP_CWORD]-}"'
printf '%s\n' ' local -a cli_words=( "${COMP_WORDS[@]:1}" )'
printf '%s\n' ' local cursor="${COMP_CWORD:-0}" word_count candidate'
printf '%s\n' ' local -a completion_words=( "${COMP_WORDS[@]+${COMP_WORDS[@]}}" ) cli_words=()'
printf '%s\n' ' if [[ "$cursor" =~ ^[0-9]+$ ]]; then cursor=$((10#$cursor)); else cursor=0; fi'
printf '%s\n' ' word_count="${#completion_words[@]}"'
printf '%s\n' ' if ((cursor > 0)); then'
printf '%s\n' ' if ((cursor < word_count)); then'
printf '%s\n' ' cli_words=( "${completion_words[@]:1:cursor}" )'
printf '%s\n' ' else'
printf '%s\n' ' cli_words=( "${completion_words[@]:1}" )'
printf '%s\n' ' cli_words+=("")'
printf '%s\n' ' fi'
printf '%s\n' ' fi'
printf '%s\n' ' COMPREPLY=()'
printf ' while IFS= read -r candidate; do COMPREPLY+=("$candidate"); done < <(base_cli_complete %q -- "${cli_words[@]}")\n' "$model"
printf '%s\n' '}'
Expand Down
50 changes: 50 additions & 0 deletions lib/bash/cli/tests/lib_cli.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,56 @@ EOF
[[ "$output" == *"complete -F _demo_complete demo"* ]]
}

@test "generated completion honors the cursor and keeps scratch variables local" {
local completion_script="$TEST_TMPDIR/completion.bash"
local candidate=caller-owned

base_cli_model_init cursor name=cursor
base_cli_command cursor admin "Administration"
base_cli_command cursor admin/user "User"
base_cli_option cursor '' channel value --channel enum=alpha,beta
base_cli_option cursor '' output value --output
base_cli_option cursor admin/user color value --color
base_cli_completion_script cursor _cursor_complete > "$completion_script"
source "$completion_script"

COMP_WORDS=(cursor --ch stable --output result)
COMP_CWORD=1
_cursor_complete
[ "${COMPREPLY[*]}" = --channel ]
[ "$candidate" = caller-owned ]

COMP_WORDS=(cursor --channel a --output result)
COMP_CWORD=2
_cursor_complete
[ "${#COMPREPLY[@]}" -eq 0 ]

COMP_WORDS=(cursor admin --out --channel alpha)
COMP_CWORD=2
_cursor_complete
[ "${COMPREPLY[*]}" = --output ]

COMP_WORDS=(cursor admin user --co)
COMP_CWORD=3
_cursor_complete
[ "${COMPREPLY[*]}" = --color ]

COMP_WORDS=(cursor -- --channel)
COMP_CWORD=2
_cursor_complete
[ "${#COMPREPLY[@]}" -eq 0 ]

COMP_WORDS=(cursor admin)
COMP_CWORD=2
_cursor_complete
[ "${COMPREPLY[*]}" = user ]

COMP_WORDS=(cursor)
COMP_CWORD=1
_cursor_complete
[ "${COMPREPLY[*]}" = admin ]
}

@test "completion consumes option values and honors the double-dash boundary" {
base_cli_model_init complete name=complete
base_cli_command complete admin "Administration" aliases=a
Expand Down
Loading