feat: auto_show on autocomplete window (#98)

* Implement new behavior for autocompletion menu, toggle option to require keypress for showing suggestions.

* docs: auto_show in readme and explanation

* feat: handle auto_show at the window level

---------

Co-authored-by: Liam Dyer <[email protected]>

Author: Jezda1337

README.md

@@ -286,6 +286,8 @@ MiniDeps.add({
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 's', 'n' },
+      -- Controls whether the completion window will automatically show when typing
+      auto_show = true,
       -- Controls how the completion items are selected
       -- 'preselect' will automatically select the first item in the completion list
       -- 'manual' will not select any item by default
@@ -318,6 +320,7 @@ MiniDeps.add({
         autocomplete_north = { 'e', 'w', 'n', 's' },
         autocomplete_south = { 'e', 'w', 's', 'n' },
       },
+      -- Controls whether the documentation window will automatically show when selecting a completion item
       auto_show = false,
       auto_show_delay_ms = 500,
       update_delay_ms = 50,

lua/blink/cmp/config.lua

@@ -89,6 +89,7 @@
 --- @field border? blink.cmp.WindowBorder
 --- @field order? "top_down" | "bottom_up"
 --- @field direction_priority? ("n" | "s")[]
+--- @field auto_show? boolean
 --- @field selection? "preselect" | "manual" | "auto_insert"
 --- @field winhighlight? string
 --- @field scrolloff? number
@@ -250,6 +251,8 @@ local config = {
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 's', 'n' },
+      -- Controls whether the completion window will automatically show when typing
+      auto_show = true,
       -- Controls how the completion items are selected
       -- 'preselect' will automatically select the first item in the completion list
       -- 'manual' will not select any item by default
@@ -281,6 +284,7 @@ local config = {
         autocomplete_north = { 'e', 'w', 'n', 's' },
         autocomplete_south = { 'e', 'w', 's', 'n' },
       },
+      -- Controls whether the documentation window will automatically show when selecting a completion item
       auto_show = false,
       auto_show_delay_ms = 500,
       update_delay_ms = 50,

lua/blink/cmp/init.lua

@@ -119,7 +119,10 @@ end
 
 cmp.show = function()
   if cmp.windows.autocomplete.win:is_open() then return end
-  vim.schedule(cmp.trigger.show)
+  vim.schedule(function()
+    cmp.windows.autocomplete.auto_show = true
+    cmp.trigger.show({ force = true })
+  end)
   return true
 end
 
@@ -149,13 +152,19 @@ cmp.accept = function()
 end
 
 cmp.select_prev = function()
-  if not cmp.windows.autocomplete.win:is_open() then return end
+  if not cmp.windows.autocomplete.win:is_open() then
+    cmp.show()
+    return true
+  end
   vim.schedule(cmp.windows.autocomplete.select_prev)
   return true
 end
 
 cmp.select_next = function()
-  if not cmp.windows.autocomplete.win:is_open() then return end
+  if not cmp.windows.autocomplete.win:is_open() then
+    cmp.show()
+    return true
+  end
   vim.schedule(cmp.windows.autocomplete.select_next)
   return true
 end

lua/blink/cmp/trigger/completion.lua

@@ -144,13 +144,18 @@ function trigger.suppress_events_for_callback(cb)
     and is_insert_mode
 end
 
---- @param opts { trigger_character?: string, send_upstream?: boolean } | nil
+--- @param opts { trigger_character?: string, send_upstream?: boolean, force?: boolean } | nil
 function trigger.show(opts)
   opts = opts or {}
 
   local cursor = vim.api.nvim_win_get_cursor(0)
   -- already triggered at this position, ignore
-  if trigger.context ~= nil and cursor[1] == trigger.context.cursor[1] and cursor[2] == trigger.context.cursor[2] then
+  if
+    not opts.force
+    and trigger.context ~= nil
+    and cursor[1] == trigger.context.cursor[1]
+    and cursor[2] == trigger.context.cursor[2]
+  then
     return
   end
 
@@ -177,7 +182,6 @@ function trigger.listen_on_show(callback) trigger.event_targets.on_show = callba
 
 function trigger.hide()
   if not trigger.context then return end
-
   trigger.context = nil
   trigger.event_targets.on_hide()
 end

lua/blink/cmp/windows/autocomplete.lua

@@ -14,6 +14,8 @@ local autocomplete = {
   ---@type blink.cmp.CompletionItem[]
   items = {},
   has_selected = nil,
+  -- hack: ideally this doesn't get mutated by the public API
+  auto_show = autocmp_config.auto_show,
   ---@type blink.cmp.Context?
   context = nil,
   event_targets = {
@@ -72,9 +74,9 @@ function autocomplete.open_with_items(context, items)
 
   vim.iter(autocomplete.event_targets.on_open):each(function(callback) callback() end)
 
+  if not autocomplete.auto_show then return end
   autocomplete.win:open()
 
-  autocomplete.context = context
   autocomplete.update_position(context)
   autocomplete.set_has_selected(autocmp_config.selection == 'preselect')
 
@@ -92,6 +94,7 @@ end
 
 function autocomplete.close()
   if not autocomplete.win:is_open() then return end
+  autocomplete.auto_show = autocmp_config.auto_show
   autocomplete.win:close()
   autocomplete.set_has_selected(autocmp_config.selection == 'preselect')