feat: call execute after accepting, but before applying semantic brackets

Related to Saghen/blink.compat#14

Author: Saghen

lua/blink/cmp/completion/accept/init.lua

@@ -9,14 +9,7 @@ local function accept(ctx, item, callback)
   local sources = require('blink.cmp.sources.lib')
   require('blink.cmp.completion.trigger').hide()
 
-  -- let the source execute the item itself if it indicates it can
-  if sources.should_execute(item) then
-    sources.execute(ctx, item)
-    callback()
-    return
-  end
-
-  -- start the resolve immediately since text changes can invalidate the item
+  -- Start the resolve immediately since text changes can invalidate the item
   -- with some LSPs (i.e. rust-analyzer) causing them to return the item as-is
   -- without i.e. auto-imports
   sources
@@ -63,24 +56,27 @@ local function accept(ctx, item, callback)
         })
       end
 
-      -- Check semantic tokens for brackets, if needed, and apply additional text edits
-      if brackets_status == 'check_semantic_token' then
-        -- TODO: since we apply the additional text edits after, auto imported functions will not
-        -- get auto brackets. If we apply them before, we have to modify the textEdit to compensate
-        brackets_lib.add_brackets_via_semantic_token(vim.bo.filetype, item, function()
+      -- Let the source execute the item itself
+      sources.execute(ctx, item):map(function()
+        -- Check semantic tokens for brackets, if needed, and apply additional text edits
+        if brackets_status == 'check_semantic_token' then
+          -- TODO: since we apply the additional text edits after, auto imported functions will not
+          -- get auto brackets. If we apply them before, we have to modify the textEdit to compensate
+          brackets_lib.add_brackets_via_semantic_token(vim.bo.filetype, item, function()
+            require('blink.cmp.completion.trigger').show_if_on_trigger_character({ is_accept = true })
+            require('blink.cmp.signature.trigger').show_if_on_trigger_character()
+            callback()
+          end)
+        else
           require('blink.cmp.completion.trigger').show_if_on_trigger_character({ is_accept = true })
           require('blink.cmp.signature.trigger').show_if_on_trigger_character()
           callback()
-        end)
-      else
-        require('blink.cmp.completion.trigger').show_if_on_trigger_character({ is_accept = true })
-        require('blink.cmp.signature.trigger').show_if_on_trigger_character()
-        callback()
-      end
+        end
 
-      -- Notify the rust module that the item was accessed
-      -- TODO: why is this so slow? (10ms)
-      vim.schedule(function() require('blink.cmp.fuzzy').access(item) end)
+        -- Notify the rust module that the item was accessed
+        -- TODO: why is this so slow? (10ms)
+        vim.schedule(function() require('blink.cmp.fuzzy').access(item) end)
+      end)
     end)
     :catch(function(err) vim.notify(err, vim.log.levels.ERROR) end)
 end

lua/blink/cmp/sources/lib/init.lua

@@ -17,7 +17,6 @@ local config = require('blink.cmp.config')
 --- @field listen_on_completions fun(callback: fun(context: blink.cmp.Context, items: blink.cmp.CompletionItem[]))
 --- @field apply_max_items_for_completions fun(context: blink.cmp.Context, items: blink.cmp.CompletionItem[]): blink.cmp.CompletionItem[]
 --- @field resolve fun(item: blink.cmp.CompletionItem): blink.cmp.Task
---- @field should_execute fun(item: blink.cmp.CompletionItem): boolean
 --- @field execute fun(context: blink.cmp.Context, item: blink.cmp.CompletionItem): blink.cmp.Task
 ---
 --- @field get_signature_help_trigger_characters fun(): { trigger_characters: string[], retrigger_characters: string[] }
@@ -164,13 +163,6 @@ end
 
 --- Execute ---
 
-function sources.should_execute(item)
-  for _, source in pairs(sources.providers) do
-    if source.id == item.source_id then return source:should_execute(item) end
-  end
-  return false
-end
-
 function sources.execute(context, item)
   local item_source = nil
   for _, source in pairs(sources.providers) do

lua/blink/cmp/sources/lib/provider/init.lua

@@ -13,7 +13,6 @@
 --- @field get_completions fun(self: blink.cmp.SourceProvider, context: blink.cmp.Context, enabled_sources: string[]): blink.cmp.Task
 --- @field should_show_items fun(self: blink.cmp.SourceProvider, context: blink.cmp.Context, enabled_sources: string[], response: blink.cmp.CompletionResponse): boolean
 --- @field resolve fun(self: blink.cmp.SourceProvider, item: blink.cmp.CompletionItem): blink.cmp.Task
---- @field should_execute fun(self: blink.cmp.SourceProvider, item: blink.cmp.CompletionItem): boolean
 --- @field execute fun(self: blink.cmp.SourceProvider, context: blink.cmp.Context, item: blink.cmp.CompletionItem, callback: fun()): blink.cmp.Task
 --- @field get_signature_help_trigger_characters fun(self: blink.cmp.SourceProvider): { trigger_characters: string[], retrigger_characters: string[] }
 --- @field get_signature_help fun(self: blink.cmp.SourceProvider, context: blink.cmp.SignatureHelpContext): blink.cmp.Task
@@ -65,7 +64,9 @@ function source:get_completions(context, enabled_sources)
   -- and the data doesn't need to be updated
   if self.last_response ~= nil and self.last_response.context.id == context.id then
     if utils.should_run_request(context, self.last_response) == false then
-      return async.task.new(function(resolve) resolve(require('blink.cmp.lib.utils').shallow_copy(self.last_response)) end)
+      return async.task.new(
+        function(resolve) resolve(require('blink.cmp.lib.utils').shallow_copy(self.last_response)) end
+      )
     end
   end
 
@@ -138,11 +139,6 @@ end
 
 --- Execute ---
 
-function source:should_execute(item)
-  if self.module.should_execute == nil then return self.module.execute ~= nil end
-  return self.module:should_execute(item)
-end
-
 function source:execute(context, item)
   if self.module.execute == nil then return async.task.new(function(resolve) resolve() end) end
   return async.task.new(function(resolve) self.module:execute(context, item, resolve) end)

lua/blink/cmp/sources/lib/types.lua

@@ -15,7 +15,6 @@
 --- @field get_completions? fun(self: blink.cmp.Source, context: blink.cmp.Context, callback: fun(response?: blink.cmp.CompletionResponse)): (fun(): nil) | nil
 --- @field should_show_completions? fun(self: blink.cmp.Source, context: blink.cmp.Context, response: blink.cmp.CompletionResponse): boolean
 --- @field resolve? fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem, callback: fun(resolved_item?: lsp.CompletionItem)): ((fun(): nil) | nil)
---- @field should_execute? fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem): boolean Optional function to check if the source should execute the specified item
 --- @field execute? fun(self: blink.cmp.Source, context: blink.cmp.Context, item: blink.cmp.CompletionItem, callback: fun()): (fun(): nil) | nil
 --- @field get_signature_help_trigger_characters? fun(self: blink.cmp.Source): string[]
 --- @field get_signature_help? fun(self: blink.cmp.Source, context: blink.cmp.SignatureHelpContext, callback: fun(signature_help: lsp.SignatureHelp | nil)): (fun(): nil) | nil
@@ -27,7 +26,6 @@
 --- @field get_completions? fun(self: blink.cmp.Source, context: blink.cmp.Context, callback: fun(response: blink.cmp.CompletionResponse | nil)): (fun(): nil) | nil
 --- @field should_show_completions? fun(self: blink.cmp.Source, context: blink.cmp.Context, response: blink.cmp.CompletionResponse): boolean
 --- @field resolve? fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem, callback: fun(resolved_item: lsp.CompletionItem | nil)): ((fun(): nil) | nil)
---- @field should_execute? fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem): boolean
 --- @field execute? fun(self: blink.cmp.Source, context: blink.cmp.Context, item: blink.cmp.CompletionItem, callback: fun()): (fun(): nil) | nil
 --- @field get_signature_help_trigger_characters? fun(self: blink.cmp.Source): string[]
 --- @field get_signature_help? fun(self: blink.cmp.Source, context: blink.cmp.SignatureHelpContext, callback: fun(signature_help: lsp.SignatureHelp | nil)): (fun(): nil) | nil