feat: signature help and misc

Author: Saghen

README.md

@@ -11,6 +11,7 @@
 - Native `vim.snippet` support (including `friendly-snippets`)
 - External sources support (currently incompatible with `nvim-cmp` sources)
 - Auto-bracket support based on semantic tokens (experimental, opt-in)
+- Signature help (experimental, opt-in)
 - [Comparison with nvim-cmp](#compared-to-nvim-cmp)
 
 ## Installation
@@ -42,6 +43,9 @@
 
     -- experimental auto-brackets support
     -- accept = { auto_brackets = { enabled = true } }
+    
+    -- experimental signature help support
+    -- trigger = { signature_help = { enabled = true } }
   }
 }
 ```
@@ -99,16 +103,26 @@ For LazyVim/distro users, you can disable nvim-cmp via:
   },
 
   trigger = {
-    -- 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_\\-]',
-    -- 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
-    blocked_trigger_characters = { ' ', '\n', '\t' },
-    -- when true, will show the completion window when the cursor comes after a trigger character when entering insert mode
-    show_on_insert_on_trigger_character = true,
+    completion = {
+      -- 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_\\-]',
+      -- 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
+      blocked_trigger_characters = { ' ', '\n', '\t' },
+      -- when true, will show the completion window when the cursor comes after a trigger character when entering insert mode
+      show_on_insert_on_trigger_character = true,
+    },
+
+    signature_help = {
+      enabled = false,
+      blocked_trigger_characters = {},
+      blocked_retrigger_characters = {},
+      -- when true, will show the signature help window when the cursor comes after a trigger character when entering insert mode
+      show_on_insert_on_trigger_character = true,
+    },
   },
 
   fuzzy = {
@@ -140,17 +154,16 @@ For LazyVim/distro users, you can disable nvim-cmp via:
       min_width = 30,
       max_width = 60,
       max_height = 10,
-      order = 'top_down',
+      border = 'none',
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
-      direction_priority = { 'n', 's' },
-      -- todo: implement
-      preselect = true,
+      direction_priority = { 's', 'n' },
     },
     documentation = {
       min_width = 10,
       max_width = 60,
       max_height = 20,
+      border = 'padded',
       -- which directions to show the documentation window,
       -- for each of the possible autocomplete window directions,
       -- falling back to the next direction when there's not enough space
@@ -159,9 +172,15 @@ For LazyVim/distro users, you can disable nvim-cmp via:
         autocomplete_south = { 'e', 'w', 's', 'n' },
       },
       auto_show = true,
-      auto_show_delay_ms = 0,
+      auto_show_delay_ms = 500,
       update_delay_ms = 100,
     },
+    signature_help = {
+      min_width = 1,
+      max_width = 100,
+      max_height = 10,
+      border = 'padded',
+    },
   },
 
   highlight = {
@@ -247,6 +266,7 @@ The plugin use a 4 stage pipeline: trigger -> sources -> fuzzy -> render
 - Less customizable across the board wrt trigger, sources, sorting, filtering, and rendering
 - Significantly less testing and documentation
 - Ghost text
+- Matched character highlighting
 
 ### Missing features, not planned
 

lua/blink/cmp/accept/brackets.lua

@@ -118,9 +118,8 @@ function brackets.add_brackets_via_semantic_token(filetype, item, callback)
     -- cancel if it's been too long, or if the cursor moved
     local ms_since_call = (vim.uv.hrtime() - start_time) / 1000000
     local cursor_after_call = vim.api.nvim_win_get_cursor(0)
-    vim.print('semanticTokens: ' .. ms_since_call .. 'ms')
     if
-      ms_since_call > 100
+      ms_since_call > config.semantic_token_resolution.timeout_ms
       or cursor_before_call[1] ~= cursor_after_call[1]
       or cursor_before_call[2] ~= cursor_after_call[2]
     then

lua/blink/cmp/accept/init.lua

@@ -44,12 +44,14 @@ local function accept(item)
 
   -- Check semantic tokens for brackets, if needed, and apply additional text edits
   if brackets_status == 'check_semantic_token' then
-    brackets_lib.add_brackets_via_semantic_token(
-      vim.bo.filetype,
-      item,
-      function() text_edits_lib.apply_additional_text_edits(item) end
-    )
+    -- 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.trigger.signature').show_if_on_trigger_character()
+      text_edits_lib.apply_additional_text_edits(item)
+    end)
   else
+    require('blink.cmp.trigger.signature').show_if_on_trigger_character()
     text_edits_lib.apply_additional_text_edits(item)
   end
 

lua/blink/cmp/config.lua

@@ -20,16 +20,29 @@
 --- @field force_allow_filetypes string[] Overrides the default blocked filetypes
 --- @field blocked_filetypes string[]
 --- @field kind_resolution blink.cmp.AutoBracketResolutionConfig Synchronously use the kind of the item to determine if brackets should be added
---- @field semantic_token_resolution blink.cmp.AutoBracketResolutionConfig Asynchronously use semantic token to determine if brackets should be added
+--- @field semantic_token_resolution blink.cmp.AutoBracketSemanticTokenResolutionConfig Asynchronously use semantic token to determine if brackets should be added
 
 --- @class blink.cmp.AutoBracketResolutionConfig
 --- @field enabled boolean
 --- @field blocked_filetypes string[]
+---
+--- @class blink.cmp.AutoBracketSemanticTokenResolutionConfig : blink.cmp.AutoBracketResolutionConfig
+--- @field timeout_ms number How long to wait for semantic tokens to return before assuming no brackets should be added
 
---- @class blink.cmp.TriggerConfig
+--- @class blink.cmp.CompletionTriggerConfig
 --- @field context_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
+---
+--- @class blink.cmp.SignatureHelpTriggerConfig
+--- @field enabled boolean
+--- @field blocked_trigger_characters string[]
+--- @field blocked_retrigger_characters string[]
+--- @field show_on_insert_on_trigger_character boolean When true, will show the signature help window when the cursor comes after a trigger character when entering insert mode
+---
+--- @class blink.cmp.TriggerConfig
+--- @field completion blink.cmp.CompletionTriggerConfig
+--- @field signature_help blink.cmp.SignatureHelpTriggerConfig
 
 --- @class blink.cmp.SourceConfig
 --- @field providers blink.cmp.SourceProviderConfig[][]
@@ -55,6 +68,7 @@
 --- @class blink.cmp.WindowConfig
 --- @field autocomplete blink.cmp.AutocompleteConfig
 --- @field documentation blink.cmp.DocumentationConfig
+--- @field signature_help blink.cmp.SignatureHelpConfig
 
 --- @class blink.cmp.HighlightConfig
 --- @field ns number
@@ -64,6 +78,7 @@
 --- @field min_width number
 --- @field max_width number
 --- @field max_height number
+--- @field border blink.cmp.WindowBorder
 --- @field order "top_down" | "bottom_up"
 --- @field direction_priority ("n" | "s")[]
 --- @field preselect boolean
@@ -72,15 +87,24 @@
 --- @field autocomplete_north ("n" | "s" | "e" | "w")[]
 --- @field autocomplete_south ("n" | "s" | "e" | "w")[]
 ---
+--- @alias blink.cmp.WindowBorder 'single' | 'double' | 'rounded' | 'solid' | 'shadow' | 'padded' | 'none'
+---
 --- @class blink.cmp.DocumentationConfig
 --- @field min_width number
 --- @field max_width number
 --- @field max_height number
+--- @field border blink.cmp.WindowBorder
 --- @field direction_priority blink.cmp.DocumentationDirectionPriorityConfig
 --- @field auto_show boolean
 --- @field auto_show_delay_ms number Delay before showing the documentation window
 --- @field update_delay_ms number Delay before updating the documentation window
 
+--- @class blink.cmp.SignatureHelpConfig
+--- @field min_width number
+--- @field max_width number
+--- @field max_height number
+--- @field border blink.cmp.WindowBorder
+
 --- @class blink.cmp.Config
 --- @field keymap blink.cmp.KeymapConfig
 --- @field accept blink.cmp.AcceptConfig
@@ -126,21 +150,32 @@ local config = {
       semantic_token_resolution = {
         enabled = true,
         blocked_filetypes = {},
+        timeout_ms = 400,
       },
     },
   },
 
   trigger = {
-    -- 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_\\-]',
-    -- 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
-    blocked_trigger_characters = { ' ', '\n', '\t' },
-    -- when true, will show the completion window when the cursor comes after a trigger character when entering insert mode
-    show_on_insert_on_trigger_character = true,
+    completion = {
+      -- 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_\\-]',
+      -- 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
+      blocked_trigger_characters = { ' ', '\n', '\t' },
+      -- when true, will show the completion window when the cursor comes after a trigger character when entering insert mode
+      show_on_insert_on_trigger_character = true,
+    },
+
+    signature_help = {
+      enabled = false,
+      blocked_trigger_characters = {},
+      blocked_retrigger_characters = {},
+      -- when true, will show the signature help window when the cursor comes after a trigger character when entering insert mode
+      show_on_insert_on_trigger_character = true,
+    },
   },
 
   fuzzy = {
@@ -172,17 +207,20 @@ local config = {
       min_width = 30,
       max_width = 60,
       max_height = 10,
+      border = 'none',
+      -- todo: implement
       order = 'top_down',
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
-      direction_priority = { 'n', 's' },
+      direction_priority = { 's', 'n' },
       -- todo: implement
       preselect = true,
     },
     documentation = {
       min_width = 10,
       max_width = 60,
       max_height = 20,
+      border = 'padded',
       -- which directions to show the documentation window,
       -- for each of the possible autocomplete window directions,
       -- falling back to the next direction when there's not enough space
@@ -194,6 +232,12 @@ local config = {
       auto_show_delay_ms = 500,
       update_delay_ms = 100,
     },
+    signature_help = {
+      min_width = 1,
+      max_width = 100,
+      max_height = 10,
+      border = 'padded',
+    },
   },
 
   highlight = {

lua/blink/cmp/fuzzy/fuzzy.rs

@@ -1,3 +1,5 @@
+// TODO: refactor this heresy
+
 use crate::frecency::FrecencyTracker;
 use lua_marshalling::LuaMarshalling;
 use serde::{Deserialize, Serialize};

lua/blink/cmp/init.lua

@@ -11,24 +11,22 @@ cmp.setup = function(opts)
       return
     end
 
-    require('blink.cmp.keymap').setup(config.keymap)
-
     cmp.add_default_highlights()
-    -- todo: do we need to clear first?
-    vim.api.nvim_create_autocmd('ColorScheme', { callback = cmp.add_default_highlights })
+
+    require('blink.cmp.keymap').setup(config.keymap)
 
     -- STRUCTURE
     -- trigger -> sources -> fuzzy (filter/sort) -> windows (render)
 
     -- trigger controls when to show the window and the current context for caching
     -- TODO: add first_trigger event for setting up the rest of the plugin
-    cmp.trigger = require('blink.cmp.trigger').activate_autocmds()
+    cmp.trigger = require('blink.cmp.trigger.completion').activate_autocmds()
 
-    -- sources fetch autocomplete items and documentation
+    -- sources fetch autocomplete items, documentation and signature help
     cmp.sources = require('blink.cmp.sources.lib')
     cmp.sources.register()
 
-    -- windows render and apply items
+    -- windows render and apply completion items and signature help
     cmp.windows = {
       autocomplete = require('blink.cmp.windows.autocomplete').setup(),
       documentation = require('blink.cmp.windows.documentation').setup(),
@@ -64,9 +62,31 @@ cmp.setup = function(opts)
       cmp.windows.autocomplete.close()
     end)
     cmp.sources.listen_on_completions(update_completions)
+
+    -- setup signature help if enabled
+    if config.trigger.signature_help.enabled then cmp.setup_signature_help() end
   end)
 end
 
+cmp.setup_signature_help = function()
+  local signature_trigger = require('blink.cmp.trigger.signature').activate_autocmds()
+  local signature_window = require('blink.cmp.windows.signature').setup()
+
+  signature_trigger.listen_on_show(function(context)
+    cmp.sources.cancel_signature_help()
+    cmp.sources.get_signature_help(context, function(signature_help)
+      if signature_help ~= nil then
+        signature_trigger.set_active_signature_help(signature_help)
+        signature_window.open_with_signature_help(context, signature_help)
+      else
+        signature_trigger.hide()
+      end
+    end)
+  end)
+
+  signature_trigger.listen_on_hide(function() cmp.windows.signature.close() end)
+end
+
 cmp.add_default_highlights = function()
   local use_nvim_cmp = require('blink.cmp.config').highlight.use_nvim_cmp_as_default
 
@@ -79,6 +99,7 @@ cmp.add_default_highlights = function()
   set_hl('BlinkCmpLabelDeprecated', { link = use_nvim_cmp and 'CmpItemAbbrDeprecated' or 'Comment' })
   set_hl('BlinkCmpLabelMatch', { link = use_nvim_cmp and 'CmpItemAbbrMatch' or 'Pmenu' })
   set_hl('BlinkCmpKind', { link = use_nvim_cmp and 'CmpItemKind' or 'Special' })
+  set_hl('BlinkCmpSignatureHelpActiveParameter', { link = 'LspSignatureActiveParameter' })
   for _, kind in pairs(vim.lsp.protocol.CompletionItemKind) do
     set_hl('BlinkCmpKind' .. kind, { link = use_nvim_cmp and 'CmpItemKind' .. kind or 'BlinkCmpItemKind' })
   end