Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() #17115

girishji · 2025-04-14T08:50:33Z

This PR introduces two features to improve introspection and control over command-line completion in Vim:

CmdlineLeavePre autocmd event

A new event triggered just before leaving the command line and before CmdlineLeave. It allows capturing completion-related state that is otherwise cleared by the time CmdlineLeave fires.

cmdcomplete_info() function

Returns a Dictionary with details about the current command-line completion state.

These are similar in spirit to InsertLeavePre and complete_info(), but focused on command-line mode.

Use case:

In [PR #16759], two examples demonstrate command-line completion: one for live grep, and another for fuzzy file finding. However, both examples share two key limitations:

Broken history recall (<Up>)
When selecting a completion item via <Tab> or <C-n>, the original pattern used for searching (e.g., a regex or fuzzy string) is overwritten in the command-line history. This makes it impossible to recall the original query later.
This is especially problematic for interactive grep workflows, where it’s useful to recall a previous search and simply select a different match from the menu.
Lack of default selection on <CR>
Often, it’s helpful to allow <CR> (Enter) to accept the first match in the completion list, even when no item is explicitly selected. This behavior is particularly useful in fuzzy file finding.

This PR addresses both issues through two new additions: the CmdlineLeavePre autocommand event and the cmdcomplete_info() function.

Below are the updated examples incorporating these improvements:

Live grep, fuzzy find file, fuzzy find buffer:

# --------------------------
# Live grep
# --------------------------
command! -nargs=+ -complete=customlist,GrepComplete Grep VisitFile()
def GrepComplete(arglead: string, cmdline: string, cursorpos: number): list<any>
    return arglead->len() > 1 ? systemlist($'grep -REIHns "{arglead}"' ..
       ' --exclude-dir=.git --exclude=".*" --exclude="tags" --exclude="*.swp"') : []
enddef
def VisitFile()
    if (selected_match != null_string)
        var qfitem = getqflist({lines: [selected_match]}).items[0]
        if qfitem->has_key('bufnr') && qfitem.lnum > 0
            var pos = qfitem.vcol > 0 ? 'setcharpos' : 'setpos'
            exec $':b +call\ {pos}(".",\ [0,\ {qfitem.lnum},\ {qfitem.col},\ 0]) {qfitem.bufnr}'
            setbufvar(qfitem.bufnr, '&buflisted', 1)
        endif
    endif
enddef
nnoremap <leader>g :Grep<space>
nnoremap <leader>G :Grep <c-r>=expand("<cword>")<cr>
# --------------------------
# Fuzzy find file
# --------------------------
command! -nargs=* -complete=customlist,FuzzyFind Find execute(selected_match != '' ? $'edit {selected_match}' : '')
var allfiles: list<string>
autocmd CmdlineEnter : allfiles = null_list
def FuzzyFind(arglead: string, _: string, _: number): list<string>
    if allfiles == null_list
        allfiles = systemlist($'find {get(g:, "fzfind_root", ".")} \! \( -path "*/.git" -prune -o -name "*.swp" \) -type f -follow')
    endif
    return arglead == '' ? allfiles : allfiles->matchfuzzy(arglead)
enddef
nnoremap <leader><space> :<c-r>=execute('let fzfind_root="."')\|''<cr>Find<space><c-@>
nnoremap <leader>fv :<c-r>=execute('let fzfind_root="$HOME/.vim"')\|''<cr>Find<space><c-@>
nnoremap <leader>fV :<c-r>=execute('let fzfind_root="$VIMRUNTIME"')\|''<cr>Find<space><c-@>
# --------------------------
# Fuzzy find buffer
# --------------------------
command! -nargs=* -complete=customlist,FuzzyBuffer Buffer execute('b ' .. selected_match->matchstr('\d\+'))
def FuzzyBuffer(arglead: string, _: string, _: number): list<string>
    var bufs = execute('buffers', 'silent!')->split("\n")
    var altbuf = bufs->indexof((_, v) => v =~ '^\s*\d\+\s\+#')
    if altbuf != -1
        [bufs[0], bufs[altbuf]] = [bufs[altbuf], bufs[0]]
    endif
    return arglead == '' ? bufs : bufs->matchfuzzy(arglead)
enddef
nnoremap <leader><bs> :Buffer <c-@>
# --------------------------
var selected_match = null_string
autocmd CmdlineLeavePre : SelectItem()
def SelectItem()
    selected_match = ''
    if getcmdline() =~ '^\s*\%(Grep\|Find\|Buffer\)\s'
        var info = cmdcomplete_info()
        if info != {} && info.pum_visible && !info.matches->empty()
            selected_match = info.selected != -1 ? info.matches[info.selected] : info.matches[0]
            setcmdline(info.cmdline_orig). # Preserve search pattern in history
        endif
    endif
enddef

Auto-completion snippet:

set wim=noselect:lastused,full wop=pum wcm=<C-@> wmnu
autocmd CmdlineChanged : CmdComplete()
def CmdComplete()
    var [cmdline, curpos] = [getcmdline(), getcmdpos()]
    if getchar(1, {number: true}) == 0  # Typehead is empty (no more pasted input)
            && !pumvisible() && curpos == cmdline->len() + 1
            && cmdline =~ '\%(\w\|[*/:.-]\)$' && cmdline !~ '^\d\+$'  # Reduce noise
        feedkeys("\<C-@>", "ti")
        SkipCmdlineChanged()  # Suppress redundant completion attempts
        # Remove <C-@> that get inserted when no items are available
        timer_start(0, (_) => getcmdline()->substitute('\%x00', '', 'g')->setcmdline())
    endif
enddef
cnoremap <expr> <up> SkipCmdlineChanged("\<up>")
cnoremap <expr> <down> SkipCmdlineChanged("\<down>")
autocmd CmdlineEnter : set bo+=error
autocmd CmdlineLeave : set bo-=error
def SkipCmdlineChanged(key = ''): string
    set ei+=CmdlineChanged
    timer_start(0, (_) => execute('set ei-=CmdlineChanged'))
    return key != '' ? ((pumvisible() ? "\<c-e>" : '') .. key) : ''
enddef

These customizable snippets can serve as lightweight and native alternatives to picker plugins like FZF or Telescope for common, everyday workflows. Also, live grep snippet can replace cscope without the overhead of building its database.

This PR introduces two features to improve introspection and control over command-line completion in Vim: - CmdlineLeavePre autocmd event A new event triggered just before leaving the command line and before CmdlineLeave. It allows capturing completion-related state that is otherwise cleared by the time CmdlineLeave fires. - cmdcomplete_info([{what}]) function Returns a Dictionary with details about the current command-line completion state. M runtime/doc/autocmd.txt M runtime/doc/builtin.txt M runtime/doc/tags M src/autocmd.c M src/cmdexpand.c M src/evalfunc.c M src/ex_getln.c M src/proto/cmdexpand.pro M src/testdir/test_autocmd.vim M src/testdir/test_cmdline.vim M src/vim.h

M runtime/doc/usr_41.txt

chrisbra · 2025-04-15T18:04:58Z

We have had in the past several issues with auto commands, because some unexpected commands were run. Can you add a few tests for e.g.: closing a window, creating a new tab window, re-opening the command line, etc? Just want to make sure we are not missing anything obvious.

girishji · 2025-04-16T12:33:36Z

We have had in the past several issues with auto commands, because some unexpected commands were run. Can you add a few tests for e.g.: closing a window, creating a new tab window, re-opening the command line, etc? Just want to make sure we are not missing anything obvious.

I’ve added some tests—let me know if you think more coverage is needed.

girishji · 2025-04-21T09:29:43Z

Thanks!

src/ex_getln.c

runtime/doc/builtin.txt

Problem: cannot get information about command line completion Solution: add CmdlineLeavePre autocommand and cmdcomplete_info() Vim script function (Girish Palya) This commit introduces two features to improve introspection and control over command-line completion in Vim: - Add CmdlineLeavePre autocmd event: A new event triggered just before leaving the command line and before CmdlineLeave. It allows capturing completion-related state that is otherwise cleared by the time CmdlineLeave fires. - Add cmdcomplete_info() Vim script function: Returns a Dictionary with details about the current command-line completion state. These are similar in spirit to InsertLeavePre and complete_info(), but focused on command-line mode. **Use case:** In [[PR vim/vim#16759](vim/vim#16759)], two examples demonstrate command-line completion: one for live grep, and another for fuzzy file finding. However, both examples share two key limitations: 1. **Broken history recall (`<Up>`)** When selecting a completion item via `<Tab>` or `<C-n>`, the original pattern used for searching (e.g., a regex or fuzzy string) is overwritten in the command-line history. This makes it impossible to recall the original query later. This is especially problematic for interactive grep workflows, where it’s useful to recall a previous search and simply select a different match from the menu. 2. **Lack of default selection on `<CR>`** Often, it’s helpful to allow `<CR>` (Enter) to accept the first match in the completion list, even when no item is explicitly selected. This behavior is particularly useful in fuzzy file finding. ---- Below are the updated examples incorporating these improvements: **Live grep, fuzzy find file, fuzzy find buffer:** ```vim command! -nargs=+ -complete=customlist,GrepComplete Grep VisitFile() def GrepComplete(arglead: string, cmdline: string, cursorpos: number): list<any> return arglead->len() > 1 ? systemlist($'grep -REIHns "{arglead}"' .. ' --exclude-dir=.git --exclude=".*" --exclude="tags" --exclude="*.swp"') : [] enddef def VisitFile() if (selected_match != null_string) var qfitem = getqflist({lines: [selected_match]}).items[0] if qfitem->has_key('bufnr') && qfitem.lnum > 0 var pos = qfitem.vcol > 0 ? 'setcharpos' : 'setpos' exec $':b +call\ {pos}(".",\ [0,\ {qfitem.lnum},\ {qfitem.col},\ 0]) {qfitem.bufnr}' setbufvar(qfitem.bufnr, '&buflisted', 1) endif endif enddef nnoremap <leader>g :Grep<space> nnoremap <leader>G :Grep <c-r>=expand("<cword>")<cr> command! -nargs=* -complete=customlist,FuzzyFind Find execute(selected_match != '' ? $'edit {selected_match}' : '') var allfiles: list<string> autocmd CmdlineEnter : allfiles = null_list def FuzzyFind(arglead: string, _: string, _: number): list<string> if allfiles == null_list allfiles = systemlist($'find {get(g:, "fzfind_root", ".")} \! $ -path "*/.git" -prune -o -name "*.swp" $ -type f -follow') endif return arglead == '' ? allfiles : allfiles->matchfuzzy(arglead) enddef nnoremap <leader><space> :<c-r>=execute('let fzfind_root="."')\|''<cr>Find<space><c-@> nnoremap <leader>fv :<c-r>=execute('let fzfind_root="$HOME/.vim"')\|''<cr>Find<space><c-@> nnoremap <leader>fV :<c-r>=execute('let fzfind_root="$VIMRUNTIME"')\|''<cr>Find<space><c-@> command! -nargs=* -complete=customlist,FuzzyBuffer Buffer execute('b ' .. selected_match->matchstr('\d\+')) def FuzzyBuffer(arglead: string, _: string, _: number): list<string> var bufs = execute('buffers', 'silent!')->split("\n") var altbuf = bufs->indexof((_, v) => v =~ '^\s*\d\+\s\+#') if altbuf != -1 [bufs[0], bufs[altbuf]] = [bufs[altbuf], bufs[0]] endif return arglead == '' ? bufs : bufs->matchfuzzy(arglead) enddef nnoremap <leader><bs> :Buffer <c-@> var selected_match = null_string autocmd CmdlineLeavePre : SelectItem() def SelectItem() selected_match = '' if getcmdline() =~ '^\s*\%(Grep\|Find\|Buffer\)\s' var info = cmdcomplete_info() if info != {} && info.pum_visible && !info.matches->empty() selected_match = info.selected != -1 ? info.matches[info.selected] : info.matches[0] setcmdline(info.cmdline_orig). # Preserve search pattern in history endif endif enddef ``` **Auto-completion snippet:** ```vim set wim=noselect:lastused,full wop=pum wcm=<C-@> wmnu autocmd CmdlineChanged : CmdComplete() def CmdComplete() var [cmdline, curpos] = [getcmdline(), getcmdpos()] if getchar(1, {number: true}) == 0 # Typehead is empty (no more pasted input) && !pumvisible() && curpos == cmdline->len() + 1 && cmdline =~ '\%(\w\|[*/:.-]\)$' && cmdline !~ '^\d\+$' # Reduce noise feedkeys("\<C-@>", "ti") SkipCmdlineChanged() # Suppress redundant completion attempts # Remove <C-@> that get inserted when no items are available timer_start(0, (_) => getcmdline()->substitute('\%x00', '', 'g')->setcmdline()) endif enddef cnoremap <expr> <up> SkipCmdlineChanged("\<up>") cnoremap <expr> <down> SkipCmdlineChanged("\<down>") autocmd CmdlineEnter : set bo+=error autocmd CmdlineLeave : set bo-=error def SkipCmdlineChanged(key = ''): string set ei+=CmdlineChanged timer_start(0, (_) => execute('set ei-=CmdlineChanged')) return key != '' ? ((pumvisible() ? "\<c-e>" : '') .. key) : '' enddef ``` These customizable snippets can serve as *lightweight* and *native* alternatives to picker plugins like **FZF** or **Telescope** for common, everyday workflows. Also, live grep snippet can replace **cscope** without the overhead of building its database. closes: vim/vim#17115 vim/vim@92f68e2 Co-authored-by: Girish Palya <girishji@gmail.com>

zeertzjq · 2025-04-21T12:09:10Z

ASAN reports a memory leak:


=================================================================
==23632==ERROR: LeakSanitizer: detected memory leaks

Direct leak of 6 byte(s) in 1 object(s) allocated from:
    #0 0x55681029aad8 in __interceptor_malloc ??:?
    #1 0x5568102df6de in lalloc /home/runner/work/vim/vim/src/alloc.c:246:11
    #2 0x5568102df641 in alloc /home/runner/work/vim/vim/src/alloc.c:151:12
    #3 0x5568110d7464 in vim_strnsave /home/runner/work/vim/vim/src/strings.c:44:9
    #4 0x55681040d9ac in showmatches /home/runner/work/vim/vim/src/cmdexpand.c:1247:17
    #5 0x5568107aa094 in cmdline_wildchar_complete /home/runner/work/vim/vim/src/ex_getln.c:983:9
    #6 0x55681078bb42 in getcmdline_int /home/runner/work/vim/vim/src/ex_getln.c:2014:12
    #7 0x5568107884e0 in getcmdline /home/runner/work/vim/vim/src/ex_getln.c:1580:12
    #8 0x556810791956 in getexline /home/runner/work/vim/vim/src/ex_getln.c:2916:12
    #9 0x5568106ef4dd in do_cmdline /home/runner/work/vim/vim/src/ex_docmd.c:916:46
    #10 0x556810b85f21 in nv_colon /home/runner/work/vim/vim/src/normal.c:3170:15
    #11 0x556810b5163f in normal_cmd /home/runner/work/vim/vim/src/normal.c:952:5
    #12 0x5568118ba9e9 in main_loop /home/runner/work/vim/vim/src/main.c:1610:3
    #13 0x5568118b4b6a in vim_main2 /home/runner/work/vim/vim/src/main.c:948:5
    #14 0x5568118a887a in main /home/runner/work/vim/vim/src/main.c:446:12
    #15 0x7fe824c2a1c9 in __libc_start_call_main csu/../sysdeps/nptl/libc_start_call_main.h:58:16
    #16 0x7fe824c2a28a in __libc_start_main csu/../csu/libc-start.c:360:3
    #1 0x5568101f6de4 in _start ??:?

Problem: cannot get information about command line completion Solution: add CmdlineLeavePre autocommand and cmdcomplete_info() Vim script function (Girish Palya) This commit introduces two features to improve introspection and control over command-line completion in Vim: - Add CmdlineLeavePre autocmd event: A new event triggered just before leaving the command line and before CmdlineLeave. It allows capturing completion-related state that is otherwise cleared by the time CmdlineLeave fires. - Add cmdcomplete_info() Vim script function: Returns a Dictionary with details about the current command-line completion state. These are similar in spirit to InsertLeavePre and complete_info(), but focused on command-line mode. **Use case:** In [[PR vim/vim#16759](vim/vim#16759)], two examples demonstrate command-line completion: one for live grep, and another for fuzzy file finding. However, both examples share two key limitations: 1. **Broken history recall (`<Up>`)** When selecting a completion item via `<Tab>` or `<C-n>`, the original pattern used for searching (e.g., a regex or fuzzy string) is overwritten in the command-line history. This makes it impossible to recall the original query later. This is especially problematic for interactive grep workflows, where it’s useful to recall a previous search and simply select a different match from the menu. 2. **Lack of default selection on `<CR>`** Often, it’s helpful to allow `<CR>` (Enter) to accept the first match in the completion list, even when no item is explicitly selected. This behavior is particularly useful in fuzzy file finding. ---- Below are the updated examples incorporating these improvements: **Live grep, fuzzy find file, fuzzy find buffer:** ```vim command! -nargs=+ -complete=customlist,GrepComplete Grep VisitFile() def GrepComplete(arglead: string, cmdline: string, cursorpos: number): list<any> return arglead->len() > 1 ? systemlist($'grep -REIHns "{arglead}"' .. ' --exclude-dir=.git --exclude=".*" --exclude="tags" --exclude="*.swp"') : [] enddef def VisitFile() if (selected_match != null_string) var qfitem = getqflist({lines: [selected_match]}).items[0] if qfitem->has_key('bufnr') && qfitem.lnum > 0 var pos = qfitem.vcol > 0 ? 'setcharpos' : 'setpos' exec $':b +call\ {pos}(".",\ [0,\ {qfitem.lnum},\ {qfitem.col},\ 0]) {qfitem.bufnr}' setbufvar(qfitem.bufnr, '&buflisted', 1) endif endif enddef nnoremap <leader>g :Grep<space> nnoremap <leader>G :Grep <c-r>=expand("<cword>")<cr> command! -nargs=* -complete=customlist,FuzzyFind Find execute(selected_match != '' ? $'edit {selected_match}' : '') var allfiles: list<string> autocmd CmdlineEnter : allfiles = null_list def FuzzyFind(arglead: string, _: string, _: number): list<string> if allfiles == null_list allfiles = systemlist($'find {get(g:, "fzfind_root", ".")} \! $ -path "*/.git" -prune -o -name "*.swp" $ -type f -follow') endif return arglead == '' ? allfiles : allfiles->matchfuzzy(arglead) enddef nnoremap <leader><space> :<c-r>=execute('let fzfind_root="."')\|''<cr>Find<space><c-@> nnoremap <leader>fv :<c-r>=execute('let fzfind_root="$HOME/.vim"')\|''<cr>Find<space><c-@> nnoremap <leader>fV :<c-r>=execute('let fzfind_root="$VIMRUNTIME"')\|''<cr>Find<space><c-@> command! -nargs=* -complete=customlist,FuzzyBuffer Buffer execute('b ' .. selected_match->matchstr('\d\+')) def FuzzyBuffer(arglead: string, _: string, _: number): list<string> var bufs = execute('buffers', 'silent!')->split("\n") var altbuf = bufs->indexof((_, v) => v =~ '^\s*\d\+\s\+#') if altbuf != -1 [bufs[0], bufs[altbuf]] = [bufs[altbuf], bufs[0]] endif return arglead == '' ? bufs : bufs->matchfuzzy(arglead) enddef nnoremap <leader><bs> :Buffer <c-@> var selected_match = null_string autocmd CmdlineLeavePre : SelectItem() def SelectItem() selected_match = '' if getcmdline() =~ '^\s*\%(Grep\|Find\|Buffer\)\s' var info = cmdcomplete_info() if info != {} && info.pum_visible && !info.matches->empty() selected_match = info.selected != -1 ? info.matches[info.selected] : info.matches[0] setcmdline(info.cmdline_orig). # Preserve search pattern in history endif endif enddef ``` **Auto-completion snippet:** ```vim set wim=noselect:lastused,full wop=pum wcm=<C-@> wmnu autocmd CmdlineChanged : CmdComplete() def CmdComplete() var [cmdline, curpos] = [getcmdline(), getcmdpos()] if getchar(1, {number: true}) == 0 # Typehead is empty (no more pasted input) && !pumvisible() && curpos == cmdline->len() + 1 && cmdline =~ '\%(\w\|[*/:.-]\)$' && cmdline !~ '^\d\+$' # Reduce noise feedkeys("\<C-@>", "ti") SkipCmdlineChanged() # Suppress redundant completion attempts # Remove <C-@> that get inserted when no items are available timer_start(0, (_) => getcmdline()->substitute('\%x00', '', 'g')->setcmdline()) endif enddef cnoremap <expr> <up> SkipCmdlineChanged("\<up>") cnoremap <expr> <down> SkipCmdlineChanged("\<down>") autocmd CmdlineEnter : set bo+=error autocmd CmdlineLeave : set bo-=error def SkipCmdlineChanged(key = ''): string set ei+=CmdlineChanged timer_start(0, (_) => execute('set ei-=CmdlineChanged')) return key != '' ? ((pumvisible() ? "\<c-e>" : '') .. key) : '' enddef ``` These customizable snippets can serve as *lightweight* and *native* alternatives to picker plugins like **FZF** or **Telescope** for common, everyday workflows. Also, live grep snippet can replace **cscope** without the overhead of building its database. closes: vim/vim#17115 vim/vim@92f68e2 Co-authored-by: Girish Palya <girishji@gmail.com>

M runtime/doc/builtin.txt

chrisbra · 2025-04-22T12:59:35Z

I wondered if we need to free cmdline_orig. I guess we do. Should be fixed in this commit: aadcc7f as part of this PR: #17189

girishji · 2025-04-22T13:31:51Z

I fixed these issues in #17190

girishji · 2025-04-22T13:34:19Z

ASAN reports a memory leak:


=================================================================
==23632==ERROR: LeakSanitizer: detected memory leaks

Direct leak of 6 byte(s) in 1 object(s) allocated from:
    #0 0x55681029aad8 in __interceptor_malloc ??:?
    #1 0x5568102df6de in lalloc /home/runner/work/vim/vim/src/alloc.c:246:11
    #2 0x5568102df641 in alloc /home/runner/work/vim/vim/src/alloc.c:151:12
    #3 0x5568110d7464 in vim_strnsave /home/runner/work/vim/vim/src/strings.c:44:9
    #4 0x55681040d9ac in showmatches /home/runner/work/vim/vim/src/cmdexpand.c:1247:17
    #5 0x5568107aa094 in cmdline_wildchar_complete /home/runner/work/vim/vim/src/ex_getln.c:983:9
    #6 0x55681078bb42 in getcmdline_int /home/runner/work/vim/vim/src/ex_getln.c:2014:12
    #7 0x5568107884e0 in getcmdline /home/runner/work/vim/vim/src/ex_getln.c:1580:12
    #8 0x556810791956 in getexline /home/runner/work/vim/vim/src/ex_getln.c:2916:12
    #9 0x5568106ef4dd in do_cmdline /home/runner/work/vim/vim/src/ex_docmd.c:916:46
    #10 0x556810b85f21 in nv_colon /home/runner/work/vim/vim/src/normal.c:3170:15
    #11 0x556810b5163f in normal_cmd /home/runner/work/vim/vim/src/normal.c:952:5
    #12 0x5568118ba9e9 in main_loop /home/runner/work/vim/vim/src/main.c:1610:3
    #13 0x5568118b4b6a in vim_main2 /home/runner/work/vim/vim/src/main.c:948:5
    #14 0x5568118a887a in main /home/runner/work/vim/vim/src/main.c:446:12
    #15 0x7fe824c2a1c9 in __libc_start_call_main csu/../sysdeps/nptl/libc_start_call_main.h:58:16
    #16 0x7fe824c2a28a in __libc_start_main csu/../csu/libc-start.c:360:3
    #1 0x5568101f6de4 in _start ??:?

cmdline_orig is freed in ExpandInit(). Looks like there is another code path. I freed it before allocation in #17190. Thanks.

Problem: cannot get information about command line completion Solution: add CmdlineLeavePre autocommand and cmdcomplete_info() Vim script function (Girish Palya) This commit introduces two features to improve introspection and control over command-line completion in Vim: - Add CmdlineLeavePre autocmd event: A new event triggered just before leaving the command line and before CmdlineLeave. It allows capturing completion-related state that is otherwise cleared by the time CmdlineLeave fires. - Add cmdcomplete_info() Vim script function: Returns a Dictionary with details about the current command-line completion state. These are similar in spirit to InsertLeavePre and complete_info(), but focused on command-line mode. **Use case:** In [[PR vim/vim#16759](vim/vim#16759)], two examples demonstrate command-line completion: one for live grep, and another for fuzzy file finding. However, both examples share two key limitations: 1. **Broken history recall (`<Up>`)** When selecting a completion item via `<Tab>` or `<C-n>`, the original pattern used for searching (e.g., a regex or fuzzy string) is overwritten in the command-line history. This makes it impossible to recall the original query later. This is especially problematic for interactive grep workflows, where it’s useful to recall a previous search and simply select a different match from the menu. 2. **Lack of default selection on `<CR>`** Often, it’s helpful to allow `<CR>` (Enter) to accept the first match in the completion list, even when no item is explicitly selected. This behavior is particularly useful in fuzzy file finding. ---- Below are the updated examples incorporating these improvements: **Live grep, fuzzy find file, fuzzy find buffer:** ```vim command! -nargs=+ -complete=customlist,GrepComplete Grep VisitFile() def GrepComplete(arglead: string, cmdline: string, cursorpos: number): list<any> return arglead->len() > 1 ? systemlist($'grep -REIHns "{arglead}"' .. ' --exclude-dir=.git --exclude=".*" --exclude="tags" --exclude="*.swp"') : [] enddef def VisitFile() if (selected_match != null_string) var qfitem = getqflist({lines: [selected_match]}).items[0] if qfitem->has_key('bufnr') && qfitem.lnum > 0 var pos = qfitem.vcol > 0 ? 'setcharpos' : 'setpos' exec $':b +call\ {pos}(".",\ [0,\ {qfitem.lnum},\ {qfitem.col},\ 0]) {qfitem.bufnr}' setbufvar(qfitem.bufnr, '&buflisted', 1) endif endif enddef nnoremap <leader>g :Grep<space> nnoremap <leader>G :Grep <c-r>=expand("<cword>")<cr> command! -nargs=* -complete=customlist,FuzzyFind Find execute(selected_match != '' ? $'edit {selected_match}' : '') var allfiles: list<string> autocmd CmdlineEnter : allfiles = null_list def FuzzyFind(arglead: string, _: string, _: number): list<string> if allfiles == null_list allfiles = systemlist($'find {get(g:, "fzfind_root", ".")} \! $ -path "*/.git" -prune -o -name "*.swp" $ -type f -follow') endif return arglead == '' ? allfiles : allfiles->matchfuzzy(arglead) enddef nnoremap <leader><space> :<c-r>=execute('let fzfind_root="."')\|''<cr>Find<space><c-@> nnoremap <leader>fv :<c-r>=execute('let fzfind_root="$HOME/.vim"')\|''<cr>Find<space><c-@> nnoremap <leader>fV :<c-r>=execute('let fzfind_root="$VIMRUNTIME"')\|''<cr>Find<space><c-@> command! -nargs=* -complete=customlist,FuzzyBuffer Buffer execute('b ' .. selected_match->matchstr('\d\+')) def FuzzyBuffer(arglead: string, _: string, _: number): list<string> var bufs = execute('buffers', 'silent!')->split("\n") var altbuf = bufs->indexof((_, v) => v =~ '^\s*\d\+\s\+#') if altbuf != -1 [bufs[0], bufs[altbuf]] = [bufs[altbuf], bufs[0]] endif return arglead == '' ? bufs : bufs->matchfuzzy(arglead) enddef nnoremap <leader><bs> :Buffer <c-@> var selected_match = null_string autocmd CmdlineLeavePre : SelectItem() def SelectItem() selected_match = '' if getcmdline() =~ '^\s*\%(Grep\|Find\|Buffer\)\s' var info = cmdcomplete_info() if info != {} && info.pum_visible && !info.matches->empty() selected_match = info.selected != -1 ? info.matches[info.selected] : info.matches[0] setcmdline(info.cmdline_orig). # Preserve search pattern in history endif endif enddef ``` **Auto-completion snippet:** ```vim set wim=noselect:lastused,full wop=pum wcm=<C-@> wmnu autocmd CmdlineChanged : CmdComplete() def CmdComplete() var [cmdline, curpos] = [getcmdline(), getcmdpos()] if getchar(1, {number: true}) == 0 # Typehead is empty (no more pasted input) && !pumvisible() && curpos == cmdline->len() + 1 && cmdline =~ '\%(\w\|[*/:.-]\)$' && cmdline !~ '^\d\+$' # Reduce noise feedkeys("\<C-@>", "ti") SkipCmdlineChanged() # Suppress redundant completion attempts # Remove <C-@> that get inserted when no items are available timer_start(0, (_) => getcmdline()->substitute('\%x00', '', 'g')->setcmdline()) endif enddef cnoremap <expr> <up> SkipCmdlineChanged("\<up>") cnoremap <expr> <down> SkipCmdlineChanged("\<down>") autocmd CmdlineEnter : set bo+=error autocmd CmdlineLeave : set bo-=error def SkipCmdlineChanged(key = ''): string set ei+=CmdlineChanged timer_start(0, (_) => execute('set ei-=CmdlineChanged')) return key != '' ? ((pumvisible() ? "\<c-e>" : '') .. key) : '' enddef ``` These customizable snippets can serve as *lightweight* and *native* alternatives to picker plugins like **FZF** or **Telescope** for common, everyday workflows. Also, live grep snippet can replace **cscope** without the overhead of building its database. closes: vim/vim#17115 vim/vim@92f68e2 Co-authored-by: Girish Palya <girishji@gmail.com>

girishji added 2 commits April 14, 2025 10:01

Improve doc

35c7715

M runtime/doc/usr_41.txt

girishji changed the title ~~Feat: Add CmdlineLeavePre autocmd and cmdcomplete_info() for cmdline completion introspection~~ Feat: Add CmdlineLeavePre autocmd and cmdcomplete_info() Apr 14, 2025

girishji changed the title ~~Feat: Add CmdlineLeavePre autocmd and cmdcomplete_info()~~ Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() Apr 15, 2025

Merge branch 'vim:master' into pr_cmdline

a6a041b

girishji added 4 commits April 16, 2025 14:35

Added tests for interaction with windows and tabs

2559779

Merge branch 'vim:master' into pr_cmdline

67198ea

Merge branch 'vim:master' into pr_cmdline

b23546e

Merge branch 'vim:master' into pr_cmdline

5e897a5

chrisbra closed this in 92f68e2 Apr 21, 2025

girishji deleted the pr_cmdline branch April 21, 2025 09:32

zeertzjq reviewed Apr 21, 2025

View reviewed changes

src/ex_getln.c Show resolved Hide resolved

zeertzjq reviewed Apr 21, 2025

View reviewed changes

runtime/doc/builtin.txt Show resolved Hide resolved

zeertzjq mentioned this pull request Apr 21, 2025

vim-patch:9.1.{1329,1331,1338} neovim/neovim#33565

Merged

girishji added a commit to girishji/vim that referenced this pull request Apr 22, 2025

Fixes for vim#17115

15cffda

M runtime/doc/builtin.txt

girishji mentioned this pull request Apr 22, 2025

Fix: Memory leak related to cmdcomplete_info() #17190

Closed

girishji mentioned this pull request May 27, 2025

lsp versus omni completion girishji/vimcomplete#101

Closed

girishji mentioned this pull request Oct 4, 2025

runtime: add self to :h credits #18485

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() #17115

Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() #17115

Uh oh!

girishji commented Apr 14, 2025 •

edited

Loading

Uh oh!

chrisbra commented Apr 15, 2025

Uh oh!

girishji commented Apr 16, 2025

Uh oh!

girishji commented Apr 21, 2025

Uh oh!

Uh oh!

Uh oh!

zeertzjq commented Apr 21, 2025

Uh oh!

chrisbra commented Apr 22, 2025

Uh oh!

girishji commented Apr 22, 2025

Uh oh!

girishji commented Apr 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() #17115

Feature: Add CmdlineLeavePre autocmd and cmdcomplete_info() #17115

Uh oh!

Conversation

girishji commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chrisbra commented Apr 15, 2025

Uh oh!

girishji commented Apr 16, 2025

Uh oh!

girishji commented Apr 21, 2025

Uh oh!

Uh oh!

Uh oh!

zeertzjq commented Apr 21, 2025

Uh oh!

chrisbra commented Apr 22, 2025

Uh oh!

girishji commented Apr 22, 2025

Uh oh!

girishji commented Apr 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

girishji commented Apr 14, 2025 •

edited

Loading