feat: support editRange, use textEditText when editRange is defined

closes #310

Author: Saghen

lua/blink/cmp/accept/text-edits.lua

@@ -56,46 +56,54 @@ local function get_line_byte_from_position(position, offset_encoding)
 end
 
 --- Gets the text edit from an item, handling insert/replace ranges and converts
---- offset encodings (utf-16 | utf-32) to byte offset (equivalent to utf-8)
+--- offset encodings (utf-16 | utf-32) to utf-8
 --- @param item blink.cmp.CompletionItem
 --- @return lsp.TextEdit
 function text_edits.get_from_item(item)
-  -- Adjust the position of the text edit to be the current cursor position
-  -- since the data might be outdated. We compare the cursor column position
-  -- from when the items were fetched versus the current.
-  -- hack: is there a better way?
-  if item.textEdit ~= nil then
-    -- FIXME: temporarily convert insertReplaceEdit to regular textEdit
-    if item.textEdit.insert ~= nil then
-      item.textEdit.range = item.textEdit.insert
-    elseif item.textEdit.replace ~= nil then
-      item.textEdit.range = item.textEdit.replace
-    end
+  local text_edit = vim.deepcopy(item.textEdit)
+
+  -- Fallback to default edit range if defined, and no text edit was set
+  if text_edit == nil and item.editRange ~= nil then
+    text_edit = {
+      newText = item.textEditText or item.insertText or item.label,
+      -- FIXME: temporarily convert insertReplaceEdit to regular textEdit
+      range = item.editRange.insert or item.editRange.replace or item.editRange,
+    }
+  end
 
-    local text_edit = vim.deepcopy(item.textEdit)
+  -- Guess the text edit if the item doesn't define it
+  if text_edit == nil then return text_edits.guess(item) end
 
-    local client = vim.lsp.get_client_by_id(item.client_id)
-    local offset_encoding = client ~= nil and client.offset_encoding or 'utf-8'
+  -- FIXME: temporarily convert insertReplaceEdit to regular textEdit
+  text_edit.range = text_edit.range or text_edit.insert or text_edit.replace
+  text_edit.insert = nil
+  text_edit.replace = nil
+  --- @cast text_edit lsp.TextEdit
 
-    if offset_encoding ~= 'utf-8' then
-      text_edit.range.start.character = get_line_byte_from_position(text_edit.range.start, offset_encoding)
-      text_edit.range['end'].character = get_line_byte_from_position(text_edit.range['end'], offset_encoding)
-    end
+  local client = vim.lsp.get_client_by_id(item.client_id)
+  local offset_encoding = client ~= nil and client.offset_encoding or 'utf-8'
 
-    local offset = vim.api.nvim_win_get_cursor(0)[2] - item.cursor_column
-    text_edit.range['end'].character = text_edit.range['end'].character + offset
-    return text_edit
+  -- convert the offset encoding to utf-8 if necessary
+  if offset_encoding ~= 'utf-8' then
+    text_edit.range.start.character = get_line_byte_from_position(text_edit.range.start, offset_encoding)
+    text_edit.range['end'].character = get_line_byte_from_position(text_edit.range['end'], offset_encoding)
   end
 
-  -- No text edit so we fallback to our own resolution
-  return text_edits.guess(item)
+  -- Adjust the position of the text edit to be the current cursor position
+  -- since the data might be outdated. We compare the cursor column position
+  -- from when the items were fetched versus the current.
+  -- HACK: is there a better way?
+  -- TODO: take into account the offset_encoding
+  local offset = vim.api.nvim_win_get_cursor(0)[2] - item.cursor_column
+  text_edit.range['end'].character = text_edit.range['end'].character + offset
+  return text_edit
 end
 
 --- Uses the keyword_regex to guess the text edit ranges
 --- @param item blink.cmp.CompletionItem
 --- TODO: doesnt work when the item contains characters not included in the context regex
 function text_edits.guess(item)
-  local word = item.textEditText or item.insertText or item.label
+  local word = item.insertText or item.label
 
   local cmp_config = config.trigger.completion
   local range = require('blink.cmp.utils').get_regex_around_cursor(

lua/blink/cmp/sources/lib/utils.lua

@@ -52,11 +52,12 @@ end
 --- @return lsp.CompletionItem
 function utils.blink_item_to_lsp_item(item)
   local lsp_item = vim.deepcopy(item)
-  lsp_item.cursor_column = nil
   lsp_item.score_offset = nil
-  lsp_item.client_id = nil
   lsp_item.source_id = nil
   lsp_item.source_name = nil
+  lsp_item.cursor_column = nil
+  lsp_item.client_id = nil
+  lsp_item.editRange = nil
   return lsp_item
 end
 

lua/blink/cmp/sources/lsp.lua

@@ -110,16 +110,16 @@ function lsp:get_completions(context, callback)
 
       -- convert full response to our internal format
       else
+        -- add defaults to the items
         local defaults = response.result and response.result.itemDefaults or {}
-        -- TODO: excluding editRange for now
         local known_defaults = {
           'commitCharacters',
+          'editRange',
           'insertTextFormat',
           'insertTextMode',
           'data',
         }
         for _, item in ipairs(response.result.items) do
-          -- add defaults to the item
           for key, value in pairs(defaults) do
             if vim.tbl_contains(known_defaults, key) then item[key] = item[key] or value end
           end

lua/blink/cmp/types.lua

@@ -1,9 +1,10 @@
 --- @class blink.cmp.CompletionItem : lsp.CompletionItem
---- @field score_offset number | nil
+--- @field score_offset? number
 --- @field source_id string
 --- @field source_name string
 --- @field cursor_column number
---- @field client_id number
+--- @field client_id? number
+--- @field editRange? lsp.Range | { insert: lsp.Range, replace: lsp.Range }
 
 return {
   -- some plugins mutate the vim.lsp.protocol.CompletionItemKind table