feat: keymaps in config

Author: Saghen

lua/blink/cmp/config.lua

@@ -1,3 +1,11 @@
+--- @class KeymapConfig
+--- @field show string | string[]
+--- @field accept string | string[]
+--- @field select_prev string | string[]
+--- @field select_next string | string[]
+--- @field snippet_forward string | string[]
+--- @field snippet_backward string | string[]
+
 --- @class TriggerConfig
 --- @field context_regex string
 --- @field blocked_trigger_characters string[]
@@ -63,6 +71,15 @@
 
 --- @type CmpConfig
 local config = {
+  keymap = {
+    show = '<C-space>',
+    hide = '<C-e>',
+    accept = '<Tab>',
+    select_prev = { '<Up>', '<C-j>' },
+    select_next = { '<Down>', '<C-k>' },
+    snippet_forward = '<Tab>',
+    snippet_backward = '<S-Tab>',
+  },
   trigger = {
     context_regex = '[%w_\\-]',
     blocked_trigger_characters = { ' ', '\n', '\t' },
@@ -142,6 +159,6 @@ local config = {
 local M = {}
 
 --- @param opts CmpConfig
-function M.merge_with(opts) end
+function M.merge_with(opts) config = vim.tbl_deep_extend('force', config, opts or {}) end
 
 return setmetatable(M, { __index = function(_, k) return config[k] end })

lua/blink/cmp/init.lua

@@ -2,15 +2,18 @@ local cmp = {}
 
 --- @param opts CmpConfig
 cmp.setup = function(opts)
-  require('blink.cmp.config').merge_with(opts)
+  local config = require('blink.cmp.config')
+  config.merge_with(opts)
+
+  require('blink.cmp.keymap').setup(config.keymap)
 
   cmp.add_default_highlights()
   vim.api.nvim_create_autocmd('ColorScheme', { callback = cmp.add_default_highlights })
 
+  -- STRUCTURE
   -- trigger -> sources -> fuzzy (filter/sort) -> windows (render)
-  --
-  -- trigger controls when to show the window and the current context
-  -- for caching
+
+  -- trigger controls when to show the window and the current context for caching
   cmp.trigger = require('blink.cmp.trigger').activate_autocmds()
 
   -- sources fetch autocomplete items and documentation
@@ -28,11 +31,7 @@ cmp.setup = function(opts)
   cmp.fuzzy = require('blink.cmp.fuzzy')
   cmp.fuzzy.init_db(vim.fn.stdpath('data') .. '/blink/cmp/fuzzy.db')
 
-  local start_time = vim.loop.hrtime()
-  cmp.trigger.listen_on_show(function(context)
-    start_time = vim.loop.hrtime()
-    cmp.sources.completions(context)
-  end)
+  cmp.trigger.listen_on_show(function(context) cmp.sources.completions(context) end)
   cmp.trigger.listen_on_hide(function()
     cmp.sources.cancel_completions()
     cmp.windows.autocomplete.close()
@@ -50,30 +49,13 @@ cmp.setup = function(opts)
   end)
 end
 
--- todo: dont default to cmp, use new hl groups
 cmp.add_default_highlights = function()
-  --- @class Opts
-  --- @field name string
-  --- @field cmp_name string | nil
-  --- @field default_name string
-
-  --- @param opts Opts
-  local function default_to_cmp(opts)
-    local cmp_hl_name = 'CmpItem' .. (opts.cmp_name or opts.name)
-    local blink_hl_name = 'BlinkCmp' .. opts.name
-    if vim.api.nvim_get_hl(0, { name = cmp_hl_name, create = false }) ~= nil then
-      vim.api.nvim_set_hl(0, blink_hl_name, { link = cmp_hl_name, default = true })
-    else
-      vim.api.nvim_set_hl(0, blink_hl_name, { link = opts.default_name, default = true })
-    end
-  end
-
-  default_to_cmp({ name = 'Label', cmp_name = 'Abbr', default_name = 'Pmenu' })
-  default_to_cmp({ name = 'LabelDeprecated', cmp_name = 'AbbrDeprecated', default_name = 'Comment' })
-  default_to_cmp({ name = 'LabelMatch', cmp_name = 'AbbrMatch', default_name = 'Pmenu' })
-  default_to_cmp({ name = 'Kind', default_name = 'Special' })
+  vim.api.nvim_set_hl(0, 'BlinkCmpLabel', { link = 'Pmenu', default = true })
+  vim.api.nvim_set_hl(0, 'BlinkCmpLabelDeprecated', { link = 'Comment', default = true })
+  vim.api.nvim_set_hl(0, 'BlinkCmpLabelMatch', { link = 'Pmenu', default = true })
+  vim.api.nvim_set_hl(0, 'BlinkCmpKind', { link = 'Special', default = true })
   for _, kind in pairs(vim.lsp.protocol.CompletionItemKind) do
-    default_to_cmp({ name = 'Kind' .. kind, default_name = 'BlinkCmpItemKind' })
+    vim.api.nvim_set_hl(0, 'BlinkCmpKind' .. kind, { link = 'BlinkCmpItemKind', default = true })
   end
 end
 
@@ -82,6 +64,11 @@ cmp.show = function()
   return true
 end
 
+cmp.hide = function()
+  vim.schedule(function() cmp.trigger.hide() end)
+  return true
+end
+
 cmp.accept = function()
   local item = cmp.windows.autocomplete.get_selected_item()
   if item == nil then return end

lua/blink/cmp/keymap.lua

@@ -0,0 +1,27 @@
+local keymap = {}
+
+local insert_commands = { 'show', 'hide', 'accept', 'select_prev', 'select_next' }
+local snippet_commands = { 'snippet_forward', 'snippet_backward' }
+
+--- @param opts KeymapConfig
+function keymap.setup(opts)
+  for command, keys in pairs(opts) do
+    local is_snippet_command = vim.tbl_contains(snippet_commands, command)
+    local is_insert_command = vim.tbl_contains(insert_commands, command)
+    if not is_snippet_command and not is_insert_command then error('Invalid command in keymap config: ' .. command) end
+
+    -- convert string to string[] for consistency
+    if type(keys) == 'string' then keys = { keys } end
+
+    -- add keymaps
+    for _, key in ipairs(keys) do
+      local mode = is_snippet_command and 's' or 'i'
+      vim.keymap.set(mode, key, function()
+        local did_run = require('blink.cmp')[command]()
+        if not did_run then return key end
+      end, { expr = true, silent = true })
+    end
+  end
+end
+
+return keymap