feat: add option completion.menu.draw.snippet_desc_column

Show snippet desc in completion column label_detail or label_description

Author: xieyonn

doc/configuration/reference.md

@@ -74,7 +74,7 @@ completion.trigger = {
 
   -- When true, will show the completion window after entering insert mode
   show_on_insert = false,
-  
+
   -- LSPs can indicate when to show the completion window via trigger characters
   -- however, some LSPs (i.e. tsserver) return characters that would essentially
   -- always show the window. We block these by default.
@@ -219,6 +219,12 @@ completion.menu.draw = {
   cursorline_priority = 10000,
   -- Appends an indicator to snippets label
   snippet_indicator = '~',
+  -- Display snippet description in completion menu column.
+  -- `nil` Do NOT show description in completion menu.
+  -- `label_detail` Show in column label_detail.
+  -- `label_description` Show in column label_description.
+  -- menu column see config `completion.menu.draw.columns`
+  snippet_desc_column = nil,
   -- Use treesitter to highlight the label text for the given list of sources
   treesitter = {},
   -- treesitter = { 'lsp' }

lua/blink/cmp/completion/windows/render/types.lua

@@ -4,6 +4,7 @@
 --- @field gap? number Gap between columns
 --- @field cursorline_priority? number Priority of the background highlight for the cursorline, defaults to 10000. Setting this to 0 will render it below other highlights
 --- @field snippet_indicator? string Appends an indicator to snippets label, `'~'` by default
+--- @field snippet_desc_column? string Display snippet description in completion menu column.
 --- @field treesitter? string[] Use treesitter to highlight the label text of completions from these sources
 --- @field columns? blink.cmp.DrawColumnDefinition[] | fun(context: blink.cmp.Context): blink.cmp.DrawColumnDefinition[] Components to render, grouped by column
 --- @field components? table<string, blink.cmp.DrawComponent> Component definitions

lua/blink/cmp/config/completion/menu.lua

@@ -64,6 +64,11 @@ local window = {
       cursorline_priority = 10000,
       -- Appends an indicator to snippets label, `'~'` by default
       snippet_indicator = '~',
+      -- Display snippet description in completion menu column.
+      -- `nil` Do NOT show description in completion menu.
+      -- `label_detail` Show in menu column label_detail.
+      -- `label_description` Show in menu column label_description.
+      snippet_desc_column = nil,
       -- Use treesitter to highlight the label text of completions from these sources
       treesitter = {},
       -- Components to render, grouped by column
@@ -197,6 +202,7 @@ function window.validate(config)
     gap = { config.draw.gap, 'number' },
     cursorline_priority = { config.draw.cursorline_priority, 'number' },
     snippet_indicator = { config.draw.snippet_indicator, 'string' },
+    snippet_desc_column = { config.draw.snippet_desc_column, 'string', true },
 
     treesitter = { config.draw.treesitter, 'table' },
 

lua/blink/cmp/sources/snippets/default/registry.lua

@@ -116,6 +116,7 @@ function registry:snippet_to_completion_item(snippet, cache_key)
     insertTextFormat = vim.lsp.protocol.InsertTextFormat.Snippet,
     insertText = self:expand_vars(body, cache_key),
     description = snippet.description,
+    labelDetails = require('blink.cmp.sources.snippets.utils').build_label_details(snippet.description or ''),
   }
 end
 

lua/blink/cmp/sources/snippets/luasnip.lua

@@ -111,6 +111,9 @@ function source:get_completions(ctx, callback)
         insertTextFormat = vim.lsp.protocol.InsertTextFormat.PlainText,
         sortText = sort_text,
         data = { snip_id = snip.id, show_condition = snip.show_condition },
+        labelDetails = require('blink.cmp.sources.snippets.utils').build_label_details(
+          snip.dscr and table.concat(snip.dscr, ' ') or ''
+        ),
       }
       -- populate snippet cache for this filetype
       table.insert(self.items_cache[ft], item)

lua/blink/cmp/sources/snippets/mini_snippets.lua

@@ -53,6 +53,7 @@ local function to_completion_items(snippets)
       insertText = snip.prefix,
       insertTextFormat = vim.lsp.protocol.InsertTextFormat.Snippet,
       data = { snip = snip },
+      labelDetails = require('blink.cmp.sources.snippets.utils').build_label_details(snip.desc),
     }
     table.insert(result, item)
   end

lua/blink/cmp/sources/snippets/utils.lua

@@ -111,4 +111,24 @@ function utils.get_tab_stops(snippet)
   return tabstops
 end
 
+--- Build field `labelDetails` for snippet source.
+---
+--- @param desc string
+--- @return nil | lsp.CompletionItemLabelDetails
+function utils.build_label_details(desc)
+  local column = require('blink.cmp.config').completion.menu.draw.snippet_desc_column
+
+  if column == nil then return nil end
+
+  if column == 'label_detail' then return {
+    detail = desc,
+  } end
+
+  if column == 'label_description' then return {
+    description = desc,
+  } end
+
+  return nil
+end
+
 return utils