From 99d688e6459c7963b00a95d544de7a3de951a70b Mon Sep 17 00:00:00 2001 From: Tomas Slusny Date: Mon, 3 Mar 2025 17:51:42 +0100 Subject: vim-patch:9.1.1166: command-line auto-completion hard with wildmenu Problem: command-line auto-completion hard with wildmenu Solution: implement "noselect" wildoption value (Girish Palya) When `noselect` is present in `wildmode` and 'wildmenu' is enabled, the completion menu appears without pre-selecting the first item. This change makes it easier to implement command-line auto-completion, where the menu dynamically appears as characters are typed, and `` can be used to manually select an item. This can be achieved by leveraging the `CmdlineChanged` event to insert `wildchar(m)`, triggering completion menu. Without this change, auto-completion using the 'wildmenu' mechanism is not feasible, as it automatically inserts the first match, preventing dynamic selection. The following Vimscript snippet demonstrates how to configure auto-completion using `noselect`: ```vim vim9script set wim=noselect:lastused,full wop=pum wcm= wmnu autocmd CmdlineChanged : timer_start(0, function(CmdComplete, [getcmdline()])) def CmdComplete(cur_cmdline: string, timer: number) var [cmdline, curpos] = [getcmdline(), getcmdpos()] if cur_cmdline ==# cmdline # Avoid completing each character in keymaps and pasted text && !pumvisible() && curpos == cmdline->len() + 1 if cmdline[curpos - 2] =~ '[\w*/:]' # Reduce noise by completing only selected characters feedkeys("\", "ti") set eventignore+=CmdlineChanged # Suppress redundant completion attempts timer_start(0, (_) => { getcmdline()->substitute('\%x00$', '', '')->setcmdline() # Remove if no completion items exist set eventignore-=CmdlineChanged }) endif endif enddef ``` fixes: vim/vim#16551 closes: vim/vim#16759 https://github.com/vim/vim/commit/2bacc3e5fb3569e0fd98e129cb1e422ca18b80a6 Cherry-pick Wildmode_Tests() change from patch 9.0.0418. Co-authored-by: Girish Palya Signed-off-by: Tomas Slusny --- runtime/doc/news.txt | 1 + runtime/doc/options.txt | 11 +++++++++-- runtime/lua/vim/_meta/options.lua | 17 +++++++++++++++-- 3 files changed, 25 insertions(+), 4 deletions(-) (limited to 'runtime') diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index a131934a8e..415a234254 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -329,6 +329,7 @@ OPTIONS • 'completeopt' flag "fuzzy" enables |fuzzy-matching| during |ins-completion|. • 'completeopt' flag "preinsert" highlights text to be inserted. +• 'wildmode' flag "noselect" shows 'wildmenu' without selecting an entry. • 'messagesopt' configures |:messages| and |hit-enter| prompt. • 'tabclose' controls which tab page to focus when closing a tab page. • 'eventignorewin' to persistently ignore events in a window. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index a6f5f85d37..a3cef8bacb 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -7050,7 +7050,10 @@ A jump table for the options with a short description can be found at |Q_op|. "lastused" When completing buffer names and more than one buffer matches, sort buffers by time last used (other than the current buffer). - When there is only a single match, it is fully completed in all cases. + "noselect" Do not pre-select first menu item and start 'wildmenu' + if it is enabled. + When there is only a single match, it is fully completed in all cases + except when "noselect" is present. Examples of useful colon-separated values: "longest:full" Like "longest", but also start 'wildmenu' if it is @@ -7073,7 +7076,11 @@ A jump table for the options with a short description can be found at |Q_op|. set wildmode=list,full < List all matches without completing, then each full match >vim set wildmode=longest,list -< Complete longest common string, then list alternatives. +< Complete longest common string, then list alternatives >vim + set wildmode=noselect:full +< Display 'wildmenu' without completing, then each full match >vim + set wildmode=noselect:lastused,full +< Same as above, but sort buffers by time last used. More info here: |cmdline-completion|. *'wildoptions'* *'wop'* diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index 8df174a838..8e6acecc28 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -7691,7 +7691,10 @@ vim.go.wmnu = vim.go.wildmenu --- "lastused" When completing buffer names and more than one buffer --- matches, sort buffers by time last used (other than --- the current buffer). ---- When there is only a single match, it is fully completed in all cases. +--- "noselect" Do not pre-select first menu item and start 'wildmenu' +--- if it is enabled. +--- When there is only a single match, it is fully completed in all cases +--- except when "noselect" is present. --- --- Examples of useful colon-separated values: --- "longest:full" Like "longest", but also start 'wildmenu' if it is @@ -7729,7 +7732,17 @@ vim.go.wmnu = vim.go.wildmenu --- ```vim --- set wildmode=longest,list --- ``` ---- Complete longest common string, then list alternatives. +--- Complete longest common string, then list alternatives +--- +--- ```vim +--- set wildmode=noselect:full +--- ``` +--- Display 'wildmenu' without completing, then each full match +--- +--- ```vim +--- set wildmode=noselect:lastused,full +--- ``` +--- Same as above, but sort buffers by time last used. --- More info here: `cmdline-completion`. --- --- @type string -- cgit