feat: support keyword_length on sources

Author: Saghen

lua/blink/cmp/config.lua

@@ -30,7 +30,7 @@
 --- @field timeout_ms number How long to wait for semantic tokens to return before assuming no brackets should be added
 
 --- @class blink.cmp.CompletionTriggerConfig
---- @field context_regex string
+--- @field keyword_regex string
 --- @field blocked_trigger_characters string[]
 --- @field show_on_insert_on_trigger_character boolean When true, will show the completion window when the cursor comes after a trigger character when entering insert mode
 ---
@@ -165,7 +165,7 @@ local config = {
       -- regex used to get the text when fuzzy matching
       -- changing this may break some sources, so please report if you run into issues
       -- todo: shouldnt this also affect the accept command? should this also be per language?
-      context_regex = '[%w_\\-]',
+      keyword_regex = '[%w_\\-]',
       -- LSPs can indicate when to show the completion window via trigger characters
       -- however, some LSPs (*cough* tsserver *cough*) return characters that would essentially
       -- always show the window. We block these by default

lua/blink/cmp/sources/lib/context.lua

@@ -95,7 +95,7 @@ function sources_context:get_completions_for_group(sources_group_idx, sources_gr
           --- @type blink.cmp.CompletionResponse
           local response = task_result.result
           response.items = source:filter_completions(response)
-          if source:should_show_completions(response) then vim.list_extend(items, response.items) end
+          if source:should_show_completions(context, response) then vim.list_extend(items, response.items) end
         end
       end
       return { sources_group_idx = sources_group_idx, is_cached = is_cached, items = items }

lua/blink/cmp/sources/lib/source.lua

@@ -18,8 +18,10 @@ end
 
 --- @return string[]
 function source:get_trigger_characters()
-  if self.module.get_trigger_characters == nil then return {} end
-  return self.module:get_trigger_characters()
+  if self.module.get_trigger_characters == nil then return self.config.trigger_characters or {} end
+  local trigger_characters = self.module:get_trigger_characters()
+  vim.list_extend(trigger_characters, self.config.trigger_characters or {})
+  return trigger_characters
 end
 
 --- @param context blink.cmp.Context
@@ -59,11 +61,17 @@ function source:filter_completions(response)
   return self.module:filter_completions(response)
 end
 
+--- @param context blink.cmp.Context
 --- @param response blink.cmp.CompletionResponse
 --- @return boolean
-function source:should_show_completions(response)
+function source:should_show_completions(context, response)
+  -- if keyword length is configured, check if the context is long enough
+  local min_keyword_length = self.config.keyword_length or 0
+  local current_keyword_length = context.bounds.end_col - context.bounds.start_col
+  if self.config.keyword_length ~= nil and current_keyword_length < min_keyword_length then return false end
+
   if self.module.should_show_completions == nil then return true end
-  return self.module:should_show_completions(response)
+  return self.module:should_show_completions(context, response)
 end
 
 --- Resolve ---

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

@@ -13,5 +13,5 @@
 --- @field get_trigger_characters (fun(self: blink.cmp.Source): string[]) | nil
 --- @field get_completions fun(self: blink.cmp.Source, context: blink.cmp.Context, callback: fun(response: blink.cmp.CompletionResponse)): (fun(): nil) | nil
 --- @field filter_completions (fun(self: blink.cmp.Source, response: blink.cmp.CompletionResponse): blink.cmp.CompletionItem[]) | nil
---- @field should_show_completions (fun(self: blink.cmp.Source, response: blink.cmp.CompletionResponse): boolean) | nil
+--- @field should_show_completions (fun(self: blink.cmp.Source, context: blink.cmp.Context, response: blink.cmp.CompletionResponse): boolean) | nil
 --- @field resolve (fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem, callback: fun(resolved_item: lsp.CompletionItem | nil)): ((fun(): nil) | nil)) | nil

lua/blink/cmp/trigger/completion.lua

@@ -1,5 +1,5 @@
 -- Handles hiding and showing the completion window. When a user types a trigger character
--- (provided by the sources) or anything matching the `context_regex`, we create a new `context`.
+-- (provided by the sources) or anything matching the `keyword_regex`, we create a new `context`.
 -- This can be used downstream to determine if we should make new requests to the sources or not.
 
 local config = require('blink.cmp.config').trigger.completion
@@ -38,7 +38,7 @@ function trigger.activate_autocmds()
         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.context_regex) ~= nil then
+      elseif last_char:match(config.keyword_regex) ~= nil then
         trigger.show()
       -- nothing matches so hide
       else
@@ -60,7 +60,7 @@ function trigger.activate_autocmds()
       local cursor_col = vim.api.nvim_win_get_cursor(0)[2]
       local char_under_cursor = vim.api.nvim_get_current_line():sub(cursor_col, cursor_col)
       local is_on_trigger = vim.tbl_contains(sources.get_trigger_characters(), char_under_cursor)
-      local is_on_context_char = char_under_cursor:match(config.context_regex) ~= nil
+      local is_on_context_char = char_under_cursor:match(config.keyword_regex) ~= nil
 
       if is_within_bounds or (is_on_trigger and trigger.context ~= nil) then
         trigger.show()
@@ -94,7 +94,7 @@ function trigger.show(opts)
     bufnr = vim.api.nvim_get_current_buf(),
     cursor = cursor,
     line = vim.api.nvim_buf_get_lines(0, cursor[1] - 1, cursor[1], false)[1],
-    bounds = trigger.get_context_bounds(config.context_regex),
+    bounds = trigger.get_context_bounds(config.keyword_regex),
     trigger = {
       kind = opts.trigger_character and vim.lsp.protocol.CompletionTriggerKind.TriggerCharacter
         or vim.lsp.protocol.CompletionTriggerKind.Invoked,