feat: nerd font variant and misc cleanup

Author: Saghen

README.md

@@ -40,7 +40,10 @@ TODO: `nvim-cmp` sources are supported out of the box but migration to the `blin
         -- defaults to nvim-cmp's highlight groups for now
         -- will be removed in a future release, assuming themes add support
         use_nvim_cmp_as_default = true,
-      }
+      },
+      -- set to 'mono' for 'Nerd Font Mono' or 'normal' for 'Nerd Font'
+      -- adjusts spacing to ensure icons are aligned
+      nerd_font_variant = 'normal',
   }
 }
 ```
@@ -69,14 +72,19 @@ TODO: `nvim-cmp` sources are supported out of the box but migration to the `blin
     snippet_forward = '<Tab>',
     snippet_backward = '<S-Tab>',
   },
+
   trigger = {
     -- regex used to get the text when fuzzy matching
+    -- changing this may break some sources, so please report if you run into issues
     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,
   },
+
   fuzzy = {
     -- frencency tracks the most recently/frequently used items and boosts the score of the item
     use_frecency = true,
@@ -86,13 +94,21 @@ TODO: `nvim-cmp` sources are supported out of the box but migration to the `blin
     -- controls which sorts to use and in which order, these three are currently the only allowed options
     sorts = { 'label', 'kind', 'score' },
   },
+
   sources = {
+    -- similar to nvim-cmp's sources, but we point directly to the source module
+    -- multiple groups can be provided, where it'll fallback to the next group if the previous
+    -- returns no completion items
     providers = {
-      { module = 'blink.cmp.sources.lsp' },
-      { module = 'blink.cmp.sources.buffer' },
-      { module = 'blink.cmp.sources.snippets', fallback_for = { 'blink.cmp.sources.lsp' } },
+      {
+        { 'blink.cmp.sources.lsp' },
+        { 'blink.cmp.sources.path' },
+        { 'blink.cmp.sources.snippets', score_offset = -3 },
+      },
+      { { 'blink.cmp.sources.buffer' } },
     },
   },
+
   windows = {
     autocomplete = {
       min_width = 30,
@@ -102,8 +118,6 @@ TODO: `nvim-cmp` sources are supported out of the box but migration to the `blin
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 'n', 's' },
-      -- whether to preselect the first item in the window
-      preselect = true,
     },
     documentation = {
       min_width = 10,
@@ -117,15 +131,19 @@ TODO: `nvim-cmp` sources are supported out of the box but migration to the `blin
         autocomplete_south = { 'e', 'w', 's', 'n' },
       },
       auto_show = true,
-      delay_ms = 0,
-      debounce_ms = 100,
+      auto_show_delay_ms = 0,
+      update_delay_ms = 100,
     },
   },
 
   highlight = {
     ns = vim.api.nvim_create_namespace('blink_cmp'),
+    -- sets the fallback highlight groups to nvim-cmp's highlight groups
+    -- useful for when your theme doesn't support blink.cmp
     use_nvim_cmp_as_default = false,
   },
+
+  nerd_font_variant = 'mono',
   kind_icons = {
     Text = '󰉿',
     Method = '󰊕',
@@ -171,15 +189,15 @@ The plugin use a 4 stage pipeline: trigger -> sources -> fuzzy -> render
 
 **Trigger:** Controls when to request completion items from the sources and provides a context downstream with the current query (i.e. `hello.wo|`, the query would be `wo`) and the treesitter object under the cursor (i.e. for intelligently enabling/disabling sources). It respects trigger characters passed by the LSP (or any other source) and includes it in the context for sending to the LSP.
 
-**Sources:** Provides a common interface for and merges the results of completion, trigger character, resolution of additional information and cancellation. It also provides a compatibility layer to `nvim-cmp`'s sources. Many sources are builtin: `LSP`, `buffer`, `treesitter`, `path`, `snippets`
+**Sources:** Provides a common interface for and merges the results of completion, trigger character, resolution of additional information and cancellation. It also provides a compatibility layer to `nvim-cmp`'s sources. Some sources are builtin: `LSP`, `buffer`, `path`, `snippets`
 
 **Fuzzy:** Rust <-> Lua FFI which performs both filtering and sorting of the items
 
 &nbsp;&nbsp;&nbsp;&nbsp;**Filtering:** The fuzzy matching uses smith-waterman, same as FZF, but implemented in SIMD for ~6x the performance of FZF (todo: add benchmarks). Due to the SIMD's performance, the prefiltering phase on FZF was dropped to allow for typos. Similar to fzy/fzf, additional points are given to prefix matches, characters with capitals (to promote camelCase/PascalCase first char matching) and matches after delimiters (to promote snake_case first char matching)
 
-&nbsp;&nbsp;&nbsp;&nbsp;**Sorting:** Combines fuzzy matching score with frecency and proximity bonus. Each completion item may also include a `score_offset` which will be added to this score to demote certain sources. The `buffer` and `snippets` sources take advantage of this to avoid taking presedence over the LSP source. The paramaters here still need to be tuned and have been exposed, so please let me know if you find some magical parameters!
+&nbsp;&nbsp;&nbsp;&nbsp;**Sorting:** Combines fuzzy matching score with frecency and proximity bonus. Each completion item may also include a `score_offset` which will be added to this score to demote certain sources. The `snippets` source takes advantage of this to avoid taking presedence over the LSP source. The paramaters here still need to be tuned, so please let me know if you find some magical parameters!
 
-**Render:** Responsible for placing the autocomplete, documentation and function parameters windows. All of the rendering can be overriden following a syntax similar to incline.nvim. It uses the neovim window decoration provider to provide next to no overhead from highlighting. 
+**Windows:** Responsible for placing the autocomplete, documentation and function parameters windows. All of the rendering can be overriden following a syntax similar to incline.nvim. It uses the neovim window decoration provider to provide next to no overhead from highlighting. 
 
 ## Compared to nvim-cmp
 
@@ -190,7 +208,7 @@ The plugin use a 4 stage pipeline: trigger -> sources -> fuzzy -> render
     - Setting nvim-cmp's debounce to 0ms leads to visible stuttering. If you'd like to stick with nvim-cmp, try [yioneko's fork](https://github.com/yioneko/nvim-cmp)
 - Boosts completion item score via frecency *and* proximity bonus. nvim-cmp only boosts score via proximity bonus
 - Typo-resistant fuzzy matching unlike nvim-cmp's fzf-style fuzzy matching
-- Core sources (buffer, snippets, lsp) are built-in versus nvim-cmp's exclusively external sources
+- Core sources (buffer, snippets, path, lsp) are built-in versus nvim-cmp's exclusively external sources
 - Uses native snippets versus nvim-cmp's required snippet engine
 
 ### Disadvantages
@@ -204,6 +222,8 @@ All of the following are planned, but not yet implemented.
 
 ## Special Thanks
 
+@hrsh7th nvim-cmp used as inspiration, nvim-path implementation used for path source
+
 @garymjr nvim-snippets implementation used for snippets source
 
 @redxtech Help with design and testing

lua/blink/cmp/config.lua

@@ -62,18 +62,19 @@
 --- @field max_height number
 --- @field direction_priority blink.cmp.DocumentationDirectionPriorityConfig
 --- @field auto_show boolean
---- @field debounce_ms number
---- @field delay_ms number
+--- @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.CmpConfig
+--- @class blink.cmp.Config
 --- @field trigger blink.cmp.TriggerConfig
 --- @field fuzzy blink.cmp.FuzzyConfig
 --- @field sources blink.cmp.SourceConfig
 --- @field windows blink.cmp.WindowConfig
 --- @field highlight blink.cmp.HighlightConfig
+--- @field nerd_font_variant 'mono' | 'normal'
 --- @field kind_icons table<string, string>
 
---- @type blink.cmp.CmpConfig
+--- @type blink.cmp.Config
 local config = {
   keymap = {
     show = '<C-space>',
@@ -90,34 +91,40 @@ local config = {
     snippet_forward = '<Tab>',
     snippet_backward = '<S-Tab>',
   },
+
   trigger = {
+    -- todo: shouldnt this also affect the accept command? should this also be per language?
     context_regex = '[%w_\\-]',
     blocked_trigger_characters = { ' ', '\n', '\t' },
     show_on_insert_on_trigger_character = true,
   },
+
   fuzzy = {
     use_frecency = true,
     use_proximity = true,
     max_items = 200,
     sorts = { 'label', 'kind', 'score' },
   },
+
   sources = {
     providers = {
       {
         { 'blink.cmp.sources.lsp' },
         { 'blink.cmp.sources.path' },
         { 'blink.cmp.sources.snippets', score_offset = -3 },
       },
-      { { 'blink.cmp.sources.buffer', score_offset = -9 } },
+      { { 'blink.cmp.sources.buffer' } },
     },
   },
+
   windows = {
     autocomplete = {
       min_width = 30,
       max_width = 60,
       max_height = 10,
       order = 'top_down',
       direction_priority = { 'n', 's' },
+      -- todo: implement
       preselect = true,
     },
     documentation = {
@@ -129,15 +136,17 @@ local config = {
         autocomplete_south = { 'e', 'w', 's', 'n' },
       },
       auto_show = true,
-      delay_ms = 0,
-      debounce_ms = 100,
+      auto_show_delay_ms = 0,
+      update_delay_ms = 100,
     },
   },
 
   highlight = {
     ns = vim.api.nvim_create_namespace('blink_cmp'),
     use_nvim_cmp_as_default = false,
   },
+
+  nerd_font_variant = 'normal',
   kind_icons = {
     Text = '󰉿',
     Method = '󰊕',
@@ -172,10 +181,10 @@ local config = {
   },
 }
 
---- @class blink.cmp.CmpConfig
+--- @class blink.cmp.Config
 local M = {}
 
---- @param opts blink.cmp.CmpConfig
+--- @param opts blink.cmp.Config
 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

@@ -1,6 +1,6 @@
 local cmp = {}
 
---- @param opts blink.cmp.CmpConfig
+--- @param opts blink.cmp.Config
 cmp.setup = function(opts)
   local config = require('blink.cmp.config')
   config.merge_with(opts)

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

@@ -11,17 +11,13 @@ function sources_context.new(context, sources_groups, on_completions_callback)
 
   self.active_request = nil
   self.queued_request_context = nil
-  self.last_successful_completions = nil
   self.last_sources_group_idx = nil
   --- @type fun(context: blink.cmp.Context, items: blink.cmp.CompletionItem[])
   self.on_completions_callback = on_completions_callback
 
   return self
 end
 
---- @return blink.cmp.CompletionItem[]
-function sources_context:get_last_successful_completions() return self.last_successful_completions end
-
 --- @param context blink.cmp.Context
 function sources_context:get_completions(context)
   assert(context.id == self.id, 'Requested completions on a sources context with a different context ID')
@@ -46,7 +42,6 @@ function sources_context:get_completions(context)
   -- Send response upstream and run the queued request, if it exists
   self.active_request = request:map(function(response)
     self.active_request = nil
-    self.last_successful_completions = response.items
     -- only send upstream if the response contains something new
     if not response.is_cached or response.sources_group_idx ~= self.last_sources_group_idx then
       self.on_completions_callback(context, response.items)

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

@@ -51,10 +51,6 @@ function sources.request_completions(context)
   sources.current_context:get_completions(context)
 end
 
-function sources.get_last_successful_completions()
-  return sources.current_context and sources.current_context:get_last_successful_completions()
-end
-
 function sources.cancel_completions()
   if sources.current_context ~= nil then sources.current_context:destroy() end
   sources.current_context = nil

lua/blink/cmp/windows/autocomplete.lua

@@ -194,7 +194,7 @@ function autocomplete.draw_item(item, max_length)
   local other_content_length = 5
   local abbr = string.sub(label, 1, max_length - other_content_length)
 
-  return string.format(' %s  %s ', kind_icon, abbr)
+  return string.format(' %s%s%s ', kind_icon, config.nerd_font_variant == 'mono' and ' ' or '  ', abbr)
 end
 
 function autocomplete.get_label(item) return item.label end

lua/blink/cmp/windows/documentation.lua

@@ -15,14 +15,17 @@ function docs.setup()
   })
 
   autocomplete.listen_on_position_update(function()
-    if autocomplete.win:get_win() then docs.update_position() end
+    if autocomplete.win:is_open() then docs.update_position() end
   end)
   if config.auto_show then
-    if config.delay_ms > 0 then
-      autocomplete.listen_on_select(utils.debounce(docs.show_item, config.delay_ms))
-    else
-      autocomplete.listen_on_select(docs.show_item)
-    end
+    autocomplete.listen_on_select(function(item)
+      local delay = autocomplete.win:is_open() and config.update_delay_ms or config.auto_show_delay_ms
+      if delay == 0 then
+        return docs.show_item(item)
+      else
+        utils.debounce(docs.show_item, delay)(item)
+      end
+    end)
   end
   autocomplete.listen_on_close(function() docs.win:close() end)