feat!: implement auto-insert option (#65)

* feat: implement auto-insert option

* doc: revert README.md formatting

* fix: properly handle auto-inserting when context length is zero

* fix: deduplicate selection logic and auto-inserting while in mid-bound

* fix: improve last fix

* fix: switch to using much more reliable text-exits for auto-insert

* fix: guess_text_edit not handling 0 indexed column

* fix: use item's label when auto-inserting snippets

* feat!: change config of auto_insert,preselect to a single 'selection'

* feat: apply additional text edits when implicitely accepting completion

* fix: accepting an auto-inserted bugs when item contains special characters

* fix: completion does not hide after accepting while selection~=auto_insert

* feat: ignore autocmds wrapper for trigger

* chore: clear remaining triggered_by code

---------

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

Author: noomly

README.md

@@ -286,8 +286,11 @@ MiniDeps.add({
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 's', 'n' },
-      -- whether to preselect the first item in the completion list
-      preselect = 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
+      -- 'auto_insert' will not select any item by default, and insert the completion items automatically when selecting them
+      selection = 'preselect',
       -- Controls how the completion items are rendered on the popup window
       -- 'simple' will render the item's kind icon the left alongside the label
       -- 'reversed' will render the label on the left and the kind icon + name on the right

lua/blink/cmp/accept/text-edits.lua

@@ -7,7 +7,7 @@ function text_edits.get_from_item(item)
   -- from when the items were fetched versus the current.
   -- hack: is there a better way?
   if item.textEdit ~= nil then
-    local text_edit = utils.shallow_copy(item.textEdit)
+    local text_edit = vim.deepcopy(item.textEdit)
     local offset = vim.api.nvim_win_get_cursor(0)[2] - item.cursor_column
     text_edit.range['end'].character = text_edit.range['end'].character + offset
     return text_edit

lua/blink/cmp/config.lua

@@ -89,7 +89,7 @@
 --- @field border? blink.cmp.WindowBorder
 --- @field order? "top_down" | "bottom_up"
 --- @field direction_priority? ("n" | "s")[]
---- @field preselect? boolean
+--- @field selection? "preselect" | "manual" | "auto_insert"
 --- @field winhighlight? string
 --- @field scrolloff? number
 --- @field draw? 'simple' | 'reversed' | 'minimal' | function(blink.cmp.CompletionRenderContext): blink.cmp.Component[]
@@ -250,8 +250,11 @@ local config = {
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 's', 'n' },
-      -- whether to preselect the first item in the completion list
-      preselect = 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
+      -- 'auto_insert' will not select any item by default, and insert the completion items automatically when selecting them
+      selection = 'preselect',
       -- Controls how the completion items are rendered on the popup window
       -- 'simple' will render the item's kind icon the left alongside the label
       -- 'reversed' will render the label on the left and the kind icon + name on the right

lua/blink/cmp/trigger/completion.lua

@@ -27,19 +27,29 @@ function trigger.activate_autocmds()
   -- decide if we should show the completion window
   vim.api.nvim_create_autocmd('TextChangedI', {
     callback = function()
+      -- we were told to ignore the text changed event, so we update the context
+      -- but don't send an on_show event upstream
+      if trigger.ignore_next_text_changed then
+        if trigger.context ~= nil then trigger.show({ send_upstream = false }) end
+        trigger.ignore_next_text_changed = false
+
       -- no characters added so let cursormoved handle it
-      if last_char == '' then return end
+      elseif last_char == '' then
+        return
 
       -- ignore if in a special buffer
-      if utils.is_special_buffer() then
+      elseif utils.is_special_buffer() then
         trigger.hide()
+
       -- character forces a trigger according to the sources, create a fresh context
       elseif vim.tbl_contains(sources.get_trigger_characters(), last_char) then
         trigger.context = nil
         trigger.show({ trigger_character = last_char })
+
       -- character is part of the current context OR in an existing context
       elseif last_char:match(config.keyword_regex) ~= nil then
         trigger.show()
+
       -- nothing matches so hide
       else
         trigger.hide()
@@ -51,6 +61,14 @@ function trigger.activate_autocmds()
 
   vim.api.nvim_create_autocmd({ 'CursorMovedI', 'InsertEnter' }, {
     callback = function(ev)
+      -- we were told to ignore the cursor moved event, so we update the context
+      -- but don't send an on_show event upstream
+      if trigger.ignore_next_cursor_moved and ev.event == 'CursorMovedI' then
+        if trigger.context ~= nil then trigger.show({ send_upstream = false }) end
+        trigger.ignore_next_cursor_moved = false
+        return
+      end
+
       -- characters added so let textchanged handle it
       if last_char ~= '' then return end
 
@@ -61,25 +79,26 @@ function trigger.activate_autocmds()
         and not vim.tbl_contains(config.show_on_insert_blocked_trigger_characters, char_under_cursor)
       local is_on_context_char = char_under_cursor:match(config.keyword_regex) ~= nil
 
+      local insert_enter_on_trigger_character = config.show_on_insert_on_trigger_character
+        and is_on_trigger_for_show_on_insert
+        and ev.event == 'InsertEnter'
+
       -- check if we're still within the bounds of the query used for the context
       if trigger.within_query_bounds(vim.api.nvim_win_get_cursor(0)) then
         trigger.show()
 
-      -- check if we've entered insert mode on a trigger character
-      -- or if we've moved onto a trigger character
-      elseif
-        (config.show_on_insert_on_trigger_character and is_on_trigger_for_show_on_insert and ev.event == 'InsertEnter')
-        or (is_on_trigger and trigger.context ~= nil)
-      then
+        -- check if we've entered insert mode on a trigger character
+        -- or if we've moved onto a trigger character
+      elseif insert_enter_on_trigger_character or (is_on_trigger and trigger.context ~= nil) then
         trigger.context = nil
         trigger.show({ trigger_character = char_under_cursor })
 
-      -- show if we currently have a context, and we've moved outside of it's bounds by 1 char
+        -- show if we currently have a context, and we've moved outside of it's bounds by 1 char
       elseif is_on_context_char and trigger.context ~= nil and cursor_col == trigger.context.bounds.start_col - 1 then
         trigger.context = nil
         trigger.show()
 
-      -- otherwise hide
+        -- otherwise hide
       else
         trigger.hide()
       end
@@ -103,7 +122,26 @@ function trigger.activate_autocmds()
   return trigger
 end
 
---- @param opts { trigger_character: string } | nil
+-- todo: extract into an autocmd module
+-- hack: there's likely edge cases with this since we can't know for sure
+-- if the autocmds will fire for cursor_moved afaik
+function trigger.ignore_autocmds_for_callback(cb)
+  local cursor_before = vim.api.nvim_win_get_cursor(0)
+  local changed_tick_before = vim.api.nvim_buf_get_changedtick(0)
+
+  cb()
+
+  local cursor_after = vim.api.nvim_win_get_cursor(0)
+  local changed_tick_after = vim.api.nvim_buf_get_changedtick(0)
+
+  local is_insert_mode = vim.api.nvim_get_mode().mode == 'i'
+  trigger.ignore_next_text_changed = changed_tick_after ~= changed_tick_before and is_insert_mode
+  -- todo: does this guarantee that the CursorMovedI event will fire?
+  trigger.ignore_next_cursor_moved = (cursor_after[1] ~= cursor_before[1] or cursor_after[2] ~= cursor_before[2])
+    and is_insert_mode
+end
+
+--- @param opts { trigger_character?: string, send_upstream?: boolean } | nil
 function trigger.show(opts)
   opts = opts or {}
 
@@ -128,7 +166,7 @@ function trigger.show(opts)
     },
   }
 
-  trigger.event_targets.on_show(trigger.context)
+  if opts.send_upstream ~= false then trigger.event_targets.on_show(trigger.context) end
 end
 
 --- @param callback fun(context: blink.cmp.Context)
@@ -138,7 +176,6 @@ 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

@@ -7,6 +7,7 @@
 
 local config = require('blink.cmp.config')
 local renderer = require('blink.cmp.windows.lib.render')
+local text_edits_lib = require('blink.cmp.accept.text-edits')
 local autocmp_config = config.windows.autocomplete
 local autocomplete = {
   ---@type blink.cmp.CompletionItem[]
@@ -74,7 +75,7 @@ function autocomplete.open_with_items(context, items)
 
   autocomplete.context = context
   autocomplete.update_position(context)
-  autocomplete.set_has_selected(autocmp_config.preselect)
+  autocomplete.set_has_selected(autocmp_config.selection == 'preselect')
 
   -- todo: some logic to maintain the selection if the user moved the cursor?
   vim.api.nvim_win_set_cursor(autocomplete.win:get_win(), { 1, 0 })
@@ -85,13 +86,13 @@ function autocomplete.open()
   if autocomplete.win:is_open() then return end
   vim.iter(autocomplete.event_targets.on_open):each(function(callback) callback() end)
   autocomplete.win:open()
-  autocomplete.set_has_selected(autocmp_config.preselect)
+  autocomplete.set_has_selected(autocmp_config.selection == 'preselect')
 end
 
 function autocomplete.close()
   if not autocomplete.win:is_open() then return end
   autocomplete.win:close()
-  autocomplete.has_selected = autocmp_config.preselect
+  autocomplete.set_has_selected(autocmp_config.selection == 'preselect')
 
   vim.iter(autocomplete.event_targets.on_close):each(function(callback) callback() end)
 end
@@ -157,6 +158,43 @@ end
 
 ---------- Selection ----------
 
+--- @param line number
+local function select(line)
+  local prev_selected_item = autocomplete.get_selected_item()
+
+  autocomplete.set_has_selected(true)
+  vim.api.nvim_win_set_cursor(autocomplete.win:get_win(), { line, 0 })
+
+  local selected_item = autocomplete.get_selected_item()
+
+  -- when auto_insert is enabled, we immediately apply the text edit
+  -- todo: move this to the accept module
+  if config.windows.autocomplete.selection == 'auto_insert' and selected_item ~= nil then
+    require('blink.cmp.trigger.completion').ignore_autocmds_for_callback(function()
+      local text_edit = text_edits_lib.get_from_item(selected_item)
+
+      if selected_item.insertTextFormat == vim.lsp.protocol.InsertTextFormat.Snippet then
+        text_edit.newText = selected_item.label
+      end
+
+      if
+        prev_selected_item ~= nil and prev_selected_item.insertTextFormat == vim.lsp.protocol.InsertTextFormat.Snippet
+      then
+        local current_col = vim.api.nvim_win_get_cursor(0)[2]
+        text_edit.range.start.character = current_col - #prev_selected_item.label
+      end
+
+      text_edits_lib.apply_text_edits(selected_item.client_id, { text_edit })
+      vim.api.nvim_win_set_cursor(0, {
+        text_edit.range.start.line + 1,
+        text_edit.range.start.character + #text_edit.newText,
+      })
+    end)
+  end
+
+  autocomplete.event_targets.on_select(selected_item, autocomplete.context)
+end
+
 function autocomplete.select_next()
   if not autocomplete.win:is_open() then return end
 
@@ -166,6 +204,7 @@ function autocomplete.select_next()
   -- We need to ajust the disconnect between the line position
   -- on the window and the selected item
   if not autocomplete.has_selected then line = line - 1 end
+  if autocomplete.has_selected and l == 1 then return end
   if line == l then
     -- at the end of completion list and the config is not enabled: do nothing
     if not cycle_from_bottom then return end
@@ -174,10 +213,7 @@ function autocomplete.select_next()
     line = line + 1
   end
 
-  autocomplete.set_has_selected(true)
-
-  vim.api.nvim_win_set_cursor(autocomplete.win:get_win(), { line, 0 })
-  autocomplete.event_targets.on_select(autocomplete.get_selected_item(), autocomplete.context)
+  select(line)
 end
 
 function autocomplete.select_prev()
@@ -186,17 +222,15 @@ function autocomplete.select_prev()
   local cycle_from_top = config.windows.autocomplete.cycle.from_top
   local l = #autocomplete.items
   local line = vim.api.nvim_win_get_cursor(autocomplete.win:get_win())[1]
+  if autocomplete.has_selected and l == 1 then return end
   if line <= 1 then
     if not cycle_from_top then return end
     line = l
   else
     line = line - 1
   end
 
-  autocomplete.set_has_selected(true)
-
-  vim.api.nvim_win_set_cursor(autocomplete.win:get_win(), { line, 0 })
-  autocomplete.event_targets.on_select(autocomplete.get_selected_item(), autocomplete.context)
+  select(line)
 end
 
 function autocomplete.listen_on_select(callback) autocomplete.event_targets.on_select = callback end
@@ -289,6 +323,8 @@ function autocomplete.render_item_reversed(ctx)
   }
 end
 
+--- @param ctx blink.cmp.CompletionRenderContext
+--- @return blink.cmp.Component[]
 function autocomplete.render_item_minimal(ctx)
   return {
     ' ',