feat: custom drawing support

Author: Saghen

README.md

@@ -155,15 +155,24 @@ For LazyVim/distro users, you can disable nvim-cmp via:
       max_width = 60,
       max_height = 10,
       border = 'none',
+      winhighlight = 'Normal:BlinkCmpMenu,FloatBorder:BlinkCmpMenuBorder,CursorLine:BlinkCmpMenuSelection,Search:None',
+      -- keep the cursor X lines away from the top/bottom of the window
+      scrolloff = 2,
       -- which directions to show the window,
       -- falling back to the next direction when there's not enough space
       direction_priority = { 's', 'n' },
+      -- Controls how the completion items are rendered on the popup window
+      -- 'simple' will render the item's kind icon the left alongside the label
+      -- 'reversed' will render the label on the left and the kind icon + name on the right
+      -- 'function(blink.cmp.CompletionRenderContext): blink.cmp.Component[]' for custom rendering
+      draw = 'simple',
     },
     documentation = {
       min_width = 10,
       max_width = 60,
       max_height = 20,
       border = 'padded',
+      winhighlight = 'Normal:BlinkCmpDoc,FloatBorder:BlinkCmpDocBorder,CursorLine:BlinkCmpDocCursorLine,Search:None',
       -- 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
@@ -180,6 +189,7 @@ For LazyVim/distro users, you can disable nvim-cmp via:
       max_width = 100,
       max_height = 10,
       border = 'padded',
+      winhighlight = 'Normal:BlinkCmpSignatureHelp,FloatBorder:BlinkCmpSignatureHelpBorder',
     },
   },
 
@@ -260,10 +270,11 @@ The plugin use a 4 stage pipeline: trigger -> sources -> fuzzy -> render
 - Boosts completion item score via frecency *and* proximity bonus. nvim-cmp only boosts score via proximity bonus and optionally by recency
 - Typo-resistant fuzzy matching unlike nvim-cmp's fzf-style fuzzy matching
 - Core sources (buffer, snippets, path, lsp) are built-in versus nvim-cmp's exclusively external sources
+- Built-in auto bracket and signature help support
 
 ### Planned missing features
 
-- Less customizable across the board wrt trigger, sources, sorting, filtering, and rendering
+- Less customizable with regards to trigger, sources, sorting, filtering
 - Significantly less testing and documentation
 - Ghost text
 - Matched character highlighting

lua/blink/cmp/config.lua

@@ -84,6 +84,7 @@
 --- @field preselect boolean
 --- @field winhighlight string
 --- @field scrolloff number
+--- @field draw 'simple' | 'reversed' | function(blink.cmp.CompletionRenderContext): blink.cmp.Component[]
 
 --- @class blink.cmp.DocumentationDirectionPriorityConfig
 --- @field autocomplete_north ("n" | "s" | "e" | "w")[]
@@ -213,6 +214,7 @@ local config = {
       max_height = 10,
       border = 'none',
       winhighlight = 'Normal:BlinkCmpMenu,FloatBorder:BlinkCmpMenuBorder,CursorLine:BlinkCmpMenuSelection,Search:None',
+      -- keep the cursor X lines away from the top/bottom of the window
       scrolloff = 2,
       -- todo: implement
       order = 'top_down',
@@ -221,6 +223,11 @@ local config = {
       direction_priority = { 's', 'n' },
       -- todo: implement
       preselect = true,
+      -- Controls how the completion items are rendered on the popup window
+      -- 'simple' will render the item's kind icon the left alongside the label
+      -- 'reversed' will render the label on the left and the kind icon + name on the right
+      -- 'function(blink.cmp.CompletionRenderContext): blink.cmp.Component[]' for custom rendering
+      draw = 'simple',
     },
     documentation = {
       min_width = 10,

lua/blink/cmp/windows/autocomplete.lua

@@ -1,5 +1,12 @@
+--- @class blink.cmp.CompletionRenderContext
+--- @field item blink.cmp.CompletionItem
+--- @field kind string
+--- @field kind_icon string
+--- @field icon_gap string
+
 -- todo: track cursor position
 local config = require('blink.cmp.config')
+local renderer = require('blink.cmp.windows.lib.render')
 local autocmp_config = config.windows.autocomplete
 local autocomplete = {
   items = {},
@@ -30,32 +37,9 @@ function autocomplete.setup()
       return autocomplete.win:get_win() == winnr and bufnr == autocomplete.win:get_buf()
     end,
     on_line = function(_, _, bufnr, line_number)
-      local item = autocomplete.items[line_number + 1]
-      if item == nil then return end
-      local line_text = vim.api.nvim_buf_get_lines(bufnr, line_number, line_number + 1, false)[1]
-
-      local kind = vim.lsp.protocol.CompletionItemKind[item.kind] or 'Unknown'
-      local kind_hl = 'BlinkCmpKind' .. kind
-
-      -- todo: handle .labelDetails and others
-      vim.api.nvim_buf_set_extmark(bufnr, config.highlight.ns, line_number, 0, {
-        end_col = 4,
-        hl_group = kind_hl,
-        hl_mode = 'combine',
-        hl_eol = true,
-        ephemeral = true,
-      })
-
-      -- todo: use vim.lsp.protocol.CompletionItemTag
-      if item.deprecated or (item.tags and vim.tbl_contains(item.tags, 1)) then
-        -- todo: why 7?
-        vim.api.nvim_buf_set_extmark(bufnr, config.highlight.ns, line_number, 7, {
-          end_col = #line_text - 1,
-          hl_group = 'BlinkCmpLabelDeprecated',
-          hl_mode = 'combine',
-          ephemeral = true,
-        })
-      end
+      local rendered_item = autocomplete.rendered_items[line_number + 1]
+      if rendered_item == nil then return end
+      renderer.draw_highlights(rendered_item, bufnr, config.highlight.ns, line_number)
     end,
   })
 
@@ -174,42 +158,68 @@ function autocomplete.listen_on_select(callback) autocomplete.event_targets.on_s
 ---------- Rendering ----------
 
 function autocomplete.draw()
-  local max_line_width = 0
+  local draw_fn = autocomplete.get_draw_fn()
+  local icon_gap = config.nerd_font_variant == 'mono' and ' ' or '  '
+  local arr_of_components = {}
   for _, item in ipairs(autocomplete.items) do
-    max_line_width = math.max(max_line_width, autocomplete.get_item_max_length(item))
+    local kind = vim.lsp.protocol.CompletionItemKind[item.kind] or 'Unknown'
+    local kind_icon = config.kind_icons[kind] or config.kind_icons.Field
+
+    table.insert(
+      arr_of_components,
+      draw_fn({
+        item = item,
+        kind = kind,
+        kind_icon = kind_icon,
+        icon_gap = icon_gap,
+      })
+    )
   end
-  local target_width =
-    math.max(math.min(max_line_width, autocomplete.win.config.max_width), autocomplete.win.config.min_width)
 
-  local lines = {}
-  for _, item in ipairs(autocomplete.items) do
-    table.insert(lines, autocomplete.draw_item(item, target_width))
-  end
+  local max_line_length = renderer.get_max_length(arr_of_components)
+  autocomplete.rendered_items = vim.tbl_map(
+    function(component) return renderer.render(component, max_line_length) end,
+    arr_of_components
+  )
 
+  local lines = vim.tbl_map(function(rendered) return rendered.text end, autocomplete.rendered_items)
   local bufnr = autocomplete.win:get_buf()
   vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
   vim.api.nvim_set_option_value('modified', false, { buf = bufnr })
 end
 
-function autocomplete.get_item_max_length(item)
-  local icon_width = 4
-  local label_width = vim.api.nvim_strwidth(autocomplete.get_label(item))
-  return icon_width + label_width
+function autocomplete.get_draw_fn()
+  if type(autocmp_config.draw) == 'function' then
+    return autocmp_config.draw
+  elseif autocmp_config.draw == 'simple' then
+    return autocomplete.render_item_simple
+  elseif autocmp_config.draw == 'reversed' then
+    return autocomplete.render_item_reversed
+  end
+  error('Invalid autocomplete window draw config')
 end
 
-function autocomplete.draw_item(item, max_length)
-  local kind = vim.lsp.protocol.CompletionItemKind[item.kind] or 'Unknown'
-  local kind_icon = config.kind_icons[kind] or config.kind_icons.Field
-
-  -- get line text
-  local label = autocomplete.get_label(item)
-  local other_content_length = 5
-  local abbr = string.sub(label, 1, max_length - other_content_length)
-
-  return string.format(' %s%s%s ', kind_icon, config.nerd_font_variant == 'mono' and ' ' or '  ', abbr)
+--- @param ctx blink.cmp.CompletionRenderContext
+--- @return blink.cmp.Component[]
+function autocomplete.render_item_simple(ctx)
+  return {
+    { ' ', ctx.kind_icon, ctx.icon_gap, hl_group = 'BlinkCmpKind' .. ctx.kind },
+    { ctx.item.label, fill = true, hl_group = ctx.item.deprecated and 'BlinkCmpLabelDeprecated' or 'BlinkCmpLabel' },
+  }
 end
 
-function autocomplete.get_label(item) return item.label end
+--- @param ctx blink.cmp.CompletionRenderContext
+--- @return blink.cmp.Component[]
+function autocomplete.render_item_reversed(ctx)
+  return {
+    {
+      ' ' .. ctx.item.label,
+      fill = true,
+      hl_group = ctx.item.deprecated and 'BlinkCmpLabelDeprecated' or 'BlinkCmpLabel',
+    },
+    { ' ', ctx.kind_icon, ctx.icon_gap, ctx.kind .. ' ', hl_group = 'BlinkCmpKind' .. ctx.kind },
+  }
+end
 
 function autocomplete.get_selected_item()
   if not autocomplete.win:is_open() then return end

lua/blink/cmp/windows/lib.lua renamed to lua/blink/cmp/windows/lib/init.lua

@@ -0,0 +1,136 @@
+--- @class blink.cmp.Component
+--- @field [number] blink.cmp.Component | string
+--- @field fill boolean | nil
+--- @field hl_group string | nil
+--- @field hl_params table | nil
+
+--- @class blink.cmp.RenderedComponentTree
+--- @field text string
+--- @field highlights { start: number, stop: number, group: string | nil, params: table | nil }[]
+
+local renderer = {}
+
+--- Draws the highlights for the rendered component tree
+--- as ephemeral extmarks
+--- @param rendered blink.cmp.RenderedComponentTree
+function renderer.draw_highlights(rendered, bufnr, ns, line_number)
+  for _, highlight in ipairs(rendered.highlights) do
+    vim.api.nvim_buf_set_extmark(bufnr, ns, line_number, highlight.start - 1, {
+      end_col = highlight.stop - 1,
+      hl_group = highlight.group,
+      hl_mode = 'combine',
+      hl_eol = true,
+      ephemeral = true,
+    })
+  end
+end
+
+--- @param components blink.cmp.Component[]
+--- @param length number
+--- @return blink.cmp.RenderedComponentTree
+function renderer.render(components, length)
+  local left_of_fill = {}
+  local right_of_fill = {}
+  local fill = nil
+  for _, component in ipairs(components) do
+    if component.fill then
+      fill = component
+    else
+      table.insert(fill and right_of_fill or left_of_fill, component)
+    end
+  end
+
+  local left_rendered = renderer.render_components(left_of_fill)
+  local fill_rendered = renderer.render_components({ fill })
+  local right_rendered = renderer.render_components(right_of_fill)
+
+  -- expanad/truncate the fill component to the width
+  fill_rendered.text = fill_rendered.text
+    .. string.rep(' ', length - vim.api.nvim_strwidth(left_rendered.text .. fill_rendered.text .. right_rendered.text))
+  fill_rendered.text = fill_rendered.text:sub(
+    1,
+    length - vim.api.nvim_strwidth(left_rendered.text) - vim.api.nvim_strwidth(right_rendered.text)
+  )
+
+  renderer.add_offset_to_rendered_component(fill_rendered, left_rendered.text:len())
+  renderer.add_offset_to_rendered_component(right_rendered, left_rendered.text:len() + fill_rendered.text:len())
+
+  local highlights = {}
+  vim.list_extend(highlights, left_rendered.highlights)
+  vim.list_extend(highlights, fill_rendered.highlights)
+  vim.list_extend(highlights, right_rendered.highlights)
+
+  return {
+    text = left_rendered.text .. fill_rendered.text .. right_rendered.text,
+    highlights = highlights,
+  }
+end
+
+--- @param components (blink.cmp.Component | string)[]
+--- @return blink.cmp.RenderedComponentTree
+function renderer.render_components(components)
+  local text = ''
+  local offset = 0
+  local highlights = {}
+
+  for _, component in ipairs(components) do
+    if type(component) == 'string' then
+      text = text .. component
+      offset = offset + #component
+    else
+      local rendered = renderer.render_components(component)
+
+      renderer.add_offset_to_rendered_component(rendered, offset)
+      table.insert(highlights, {
+        start = offset + 1,
+        stop = offset + #rendered.text + 1,
+        group = component.hl_group,
+        params = component.hl_params,
+      })
+      vim.list_extend(highlights, rendered.highlights)
+
+      text = text .. rendered.text
+      offset = offset + #rendered.text
+    end
+  end
+
+  return { text = text, highlights = highlights }
+end
+
+--- @param components blink.cmp.Component[]
+--- @return number
+function renderer.get_length(components)
+  local length = 0
+  for _, component in ipairs(components) do
+    if type(component) == 'string' then
+      length = length + #component
+    else
+      length = length + renderer.get_length(component)
+    end
+  end
+  return length
+end
+
+--- @param arr_of_components blink.cmp.Component[][]
+--- @return number
+function renderer.get_max_length(arr_of_components)
+  local max_length = 0
+  for _, components in ipairs(arr_of_components) do
+    local length = renderer.get_length(components)
+    if length > max_length then max_length = length end
+  end
+  return max_length
+end
+
+--- @param component blink.cmp.RenderedComponentTree
+--- @param offset number
+--- @return blink.cmp.RenderedComponentTree
+function renderer.add_offset_to_rendered_component(component, offset)
+  for _, highlight in ipairs(component.highlights) do
+    highlight.start = highlight.start + offset
+    highlight.stop = highlight.stop + offset
+  end
+  return component
+end
+
+return renderer