From 5d26934c7cda191f0b519c1326fa318b857ffcb8 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Fri, 24 May 2024 18:31:25 -0500
Subject: feat(lsp): update LSP healthcheck format (#28980)

This is mostly an aesthetic change, although there are a few new pieces
of information included. Originally I wanted to investigate including
server capabilities in the healthcheck, but until we have the ability to
fold/unfold text in health checks that would be too much information.
---
 runtime/lua/vim/lsp/health.lua | 83 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 73 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index a79ae76eb9..b5dc710cc6 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -33,16 +33,22 @@ local function check_active_clients()
   local clients = vim.lsp.get_clients()
   if next(clients) then
     for _, client in pairs(clients) do
-      local attached_to = table.concat(vim.tbl_keys(client.attached_buffers or {}), ',')
-      report_info(
+      local cmd ---@type string
+      if type(client.config.cmd) == 'table' then
+        cmd = table.concat(client.config.cmd --[[@as table]], ' ')
+      elseif type(client.config.cmd) == 'function' then
+        cmd = tostring(client.config.cmd)
+      end
+      report_info(table.concat({
+        string.format('%s (id: %d)', client.name, client.id),
+        string.format('  Root directory: %s', vim.fn.fnamemodify(client.root_dir, ':~')),
+        string.format('  Command: %s', cmd),
+        string.format('  Settings: %s', vim.inspect(client.settings, { newline = '\n  ' })),
         string.format(
-          '%s (id=%s, root_dir=%s, attached_to=[%s])',
-          client.name,
-          client.id,
-          vim.fn.fnamemodify(client.root_dir, ':~'),
-          attached_to
-        )
-      )
+          '  Attached buffers: %s',
+          vim.iter(pairs(client.attached_buffers)):map(tostring):join(', ')
+        ),
+      }, '\n'))
     end
   else
     report_info('No active clients')
@@ -50,7 +56,7 @@ local function check_active_clients()
 end
 
 local function check_watcher()
-  vim.health.start('vim.lsp: File watcher')
+  vim.health.start('vim.lsp: File Watcher')
 
   -- Only run the check if file watching has been enabled by a client.
   local clients = vim.lsp.get_clients()
@@ -94,11 +100,68 @@ local function check_watcher()
   end
 end
 
+local function check_position_encodings()
+  vim.health.start('vim.lsp: Position Encodings')
+  local clients = vim.lsp.get_clients()
+  if next(clients) then
+    local position_encodings = {} ---@type table<integer, table<string, integer[]>>
+    for _, client in pairs(clients) do
+      for bufnr in pairs(client.attached_buffers) do
+        if not position_encodings[bufnr] then
+          position_encodings[bufnr] = {}
+        end
+        if not position_encodings[bufnr][client.offset_encoding] then
+          position_encodings[bufnr][client.offset_encoding] = {}
+        end
+        table.insert(position_encodings[bufnr][client.offset_encoding], client.id)
+      end
+    end
+
+    -- Check if any buffers are attached to multiple clients with different position encodings
+    local buffers = {} ---@type integer[]
+    for bufnr, encodings in pairs(position_encodings) do
+      local list = {} ---@type string[]
+      for k in pairs(encodings) do
+        list[#list + 1] = k
+      end
+
+      if #list > 1 then
+        buffers[#buffers + 1] = bufnr
+      end
+    end
+
+    if #buffers > 0 then
+      local lines =
+        { 'Found buffers attached to multiple clients with different position encodings.' }
+      for _, bufnr in ipairs(buffers) do
+        local encodings = position_encodings[bufnr]
+        local parts = {}
+        for encoding, client_ids in pairs(encodings) do
+          table.insert(
+            parts,
+            string.format('%s (client id(s): %s)', encoding:upper(), table.concat(client_ids, ', '))
+          )
+        end
+        table.insert(lines, string.format('- Buffer %d: %s', bufnr, table.concat(parts, ', ')))
+      end
+      report_warn(
+        table.concat(lines, '\n'),
+        'Use the positionEncodings client capability to ensure all clients use the same position encoding'
+      )
+    else
+      report_info('No buffers contain mixed position encodings')
+    end
+  else
+    report_info('No active clients')
+  end
+end
+
 --- Performs a healthcheck for LSP
 function M.check()
   check_log()
   check_active_clients()
   check_watcher()
+  check_position_encodings()
 end
 
 return M
-- 
cgit 


From f03b1622ad1b8e2df16504631f05e7577e217854 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 25 May 2024 21:22:41 +0200
Subject: fix(lsp): handle nil root_dir in health check (#29007)

The root directory could show up as something like:

    Root directory: ~/path/to/cwd/v:null

Despite being `nil`
---
 runtime/lua/vim/lsp/client.lua | 3 +--
 runtime/lua/vim/lsp/health.lua | 5 ++++-
 2 files changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index 4beb7fefda..58ea7d02b3 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -182,7 +182,7 @@ local validate = vim.validate
 --- It can be `null` if the client supports workspace folders but none are
 --- configured.
 --- @field workspace_folders lsp.WorkspaceFolder[]?
---- @field root_dir string
+--- @field root_dir string?
 ---
 --- @field attached_buffers table<integer,true>
 ---
@@ -470,7 +470,6 @@ function Client.create(config)
     _on_exit_cbs = ensure_list(config.on_exit),
     _on_attach_cbs = ensure_list(config.on_attach),
     _on_error_cb = config.on_error,
-    _root_dir = config.root_dir,
     _trace = get_trace(config.trace),
 
     --- Contains $/progress report messages.
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index b5dc710cc6..ffe595ab37 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -41,7 +41,10 @@ local function check_active_clients()
       end
       report_info(table.concat({
         string.format('%s (id: %d)', client.name, client.id),
-        string.format('  Root directory: %s', vim.fn.fnamemodify(client.root_dir, ':~')),
+        string.format(
+          '  Root directory: %s',
+          client.root_dir and vim.fn.fnamemodify(client.root_dir, ':~') or nil
+        ),
         string.format('  Command: %s', cmd),
         string.format('  Settings: %s', vim.inspect(client.settings, { newline = '\n  ' })),
         string.format(
-- 
cgit 


From 6e8a728e3dad747d0c46dc47a530b76e8997bc08 Mon Sep 17 00:00:00 2001
From: dundargoc <gocdundar@gmail.com>
Date: Sat, 25 May 2024 20:35:37 +0200
Subject: refactor: fix luals type warnings

---
 runtime/lua/vim/lsp/util.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 5a229a1169..0099e82f52 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -616,7 +616,7 @@ function M.rename(old_fname, new_fname, opts)
     buf_rename[b] = { from = old_bname, to = new_bname }
   end
 
-  local newdir = assert(vim.fs.dirname(new_fname))
+  local newdir = vim.fs.dirname(new_fname)
   vim.fn.mkdir(newdir, 'p')
 
   local ok, err = os.rename(old_fname_full, new_fname)
@@ -625,7 +625,7 @@ function M.rename(old_fname, new_fname, opts)
   local old_undofile = vim.fn.undofile(old_fname_full)
   if uv.fs_stat(old_undofile) ~= nil then
     local new_undofile = vim.fn.undofile(new_fname)
-    vim.fn.mkdir(assert(vim.fs.dirname(new_undofile)), 'p')
+    vim.fn.mkdir(vim.fs.dirname(new_undofile), 'p')
     os.rename(old_undofile, new_undofile)
   end
 
-- 
cgit 


From ff097f2091e7a970e5b12960683b4dade5563040 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 4 Feb 2024 14:13:23 -0800
Subject: feat(lsp): completion side effects

---
 runtime/lua/vim/lsp/_completion.lua | 276 --------------
 runtime/lua/vim/lsp/client.lua      |  23 +-
 runtime/lua/vim/lsp/completion.lua  | 734 ++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/handlers.lua    |   2 +-
 runtime/lua/vim/lsp/protocol.lua    |  10 +-
 5 files changed, 755 insertions(+), 290 deletions(-)
 delete mode 100644 runtime/lua/vim/lsp/_completion.lua
 create mode 100644 runtime/lua/vim/lsp/completion.lua

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_completion.lua b/runtime/lua/vim/lsp/_completion.lua
deleted file mode 100644
index a169f96565..0000000000
--- a/runtime/lua/vim/lsp/_completion.lua
+++ /dev/null
@@ -1,276 +0,0 @@
-local M = {}
-local api = vim.api
-local lsp = vim.lsp
-local protocol = lsp.protocol
-local ms = protocol.Methods
-
---- @alias vim.lsp.CompletionResult lsp.CompletionList | lsp.CompletionItem[]
-
--- TODO(mariasolos): Remove this declaration once we figure out a better way to handle
--- literal/anonymous types (see https://github.com/neovim/neovim/pull/27542/files#r1495259331).
---- @class lsp.ItemDefaults
---- @field editRange lsp.Range | { insert: lsp.Range, replace: lsp.Range } | nil
---- @field insertTextFormat lsp.InsertTextFormat?
---- @field insertTextMode lsp.InsertTextMode?
---- @field data any
-
----@param input string unparsed snippet
----@return string parsed snippet
-local function parse_snippet(input)
-  local ok, parsed = pcall(function()
-    return vim.lsp._snippet_grammar.parse(input)
-  end)
-  return ok and tostring(parsed) or input
-end
-
---- Returns text that should be inserted when selecting completion item. The
---- precedence is as follows: textEdit.newText > insertText > label
----
---- See https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
----
----@param item lsp.CompletionItem
----@return string
-local function get_completion_word(item)
-  if item.textEdit ~= nil and item.textEdit.newText ~= nil and item.textEdit.newText ~= '' then
-    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
-      return item.textEdit.newText
-    else
-      return parse_snippet(item.textEdit.newText)
-    end
-  elseif item.insertText ~= nil and item.insertText ~= '' then
-    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
-      return item.insertText
-    else
-      return parse_snippet(item.insertText)
-    end
-  end
-  return item.label
-end
-
---- Applies the given defaults to the completion item, modifying it in place.
----
---- @param item lsp.CompletionItem
---- @param defaults lsp.ItemDefaults?
-local function apply_defaults(item, defaults)
-  if not defaults then
-    return
-  end
-
-  item.insertTextFormat = item.insertTextFormat or defaults.insertTextFormat
-  item.insertTextMode = item.insertTextMode or defaults.insertTextMode
-  item.data = item.data or defaults.data
-  if defaults.editRange then
-    local textEdit = item.textEdit or {}
-    item.textEdit = textEdit
-    textEdit.newText = textEdit.newText or item.textEditText or item.insertText
-    if defaults.editRange.start then
-      textEdit.range = textEdit.range or defaults.editRange
-    elseif defaults.editRange.insert then
-      textEdit.insert = defaults.editRange.insert
-      textEdit.replace = defaults.editRange.replace
-    end
-  end
-end
-
----@param result vim.lsp.CompletionResult
----@return lsp.CompletionItem[]
-local function get_items(result)
-  if result.items then
-    for _, item in ipairs(result.items) do
-      ---@diagnostic disable-next-line: param-type-mismatch
-      apply_defaults(item, result.itemDefaults)
-    end
-    return result.items
-  else
-    return result
-  end
-end
-
---- Turns the result of a `textDocument/completion` request into vim-compatible
---- |complete-items|.
----
----@param result vim.lsp.CompletionResult Result of `textDocument/completion`
----@param prefix string prefix to filter the completion items
----@return table[]
----@see complete-items
-function M._lsp_to_complete_items(result, prefix)
-  local items = get_items(result)
-  if vim.tbl_isempty(items) then
-    return {}
-  end
-
-  local function matches_prefix(item)
-    return vim.startswith(get_completion_word(item), prefix)
-  end
-
-  items = vim.tbl_filter(matches_prefix, items) --[[@as lsp.CompletionItem[]|]]
-  table.sort(items, function(a, b)
-    return (a.sortText or a.label) < (b.sortText or b.label)
-  end)
-
-  local matches = {}
-  for _, item in ipairs(items) do
-    local info = ''
-    local documentation = item.documentation
-    if documentation then
-      if type(documentation) == 'string' and documentation ~= '' then
-        info = documentation
-      elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
-        info = documentation.value
-      else
-        vim.notify(
-          ('invalid documentation value %s'):format(vim.inspect(documentation)),
-          vim.log.levels.WARN
-        )
-      end
-    end
-    local word = get_completion_word(item)
-    table.insert(matches, {
-      word = word,
-      abbr = item.label,
-      kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
-      menu = item.detail or '',
-      info = #info > 0 and info or nil,
-      icase = 1,
-      dup = 1,
-      empty = 1,
-      user_data = {
-        nvim = {
-          lsp = {
-            completion_item = item,
-          },
-        },
-      },
-    })
-  end
-  return matches
-end
-
----@param lnum integer 0-indexed
----@param items lsp.CompletionItem[]
-local function adjust_start_col(lnum, line, items, encoding)
-  local min_start_char = nil
-  for _, item in pairs(items) do
-    if item.textEdit and item.textEdit.range.start.line == lnum then
-      if min_start_char and min_start_char ~= item.textEdit.range.start.character then
-        return nil
-      end
-      min_start_char = item.textEdit.range.start.character
-    end
-  end
-  if min_start_char then
-    return vim.lsp.util._str_byteindex_enc(line, min_start_char, encoding)
-  else
-    return nil
-  end
-end
-
----@private
----@param line string line content
----@param lnum integer 0-indexed line number
----@param client_start_boundary integer 0-indexed word boundary
----@param server_start_boundary? integer 0-indexed word boundary, based on textEdit.range.start.character
----@param result vim.lsp.CompletionResult
----@param encoding string
----@return table[] matches
----@return integer? server_start_boundary
-function M._convert_results(
-  line,
-  lnum,
-  cursor_col,
-  client_start_boundary,
-  server_start_boundary,
-  result,
-  encoding
-)
-  -- Completion response items may be relative to a position different than `client_start_boundary`.
-  -- Concrete example, with lua-language-server:
-  --
-  -- require('plenary.asy|
-  --         ▲       ▲   ▲
-  --         │       │   └── cursor_pos:                     20
-  --         │       └────── client_start_boundary:          17
-  --         └────────────── textEdit.range.start.character: 9
-  --                                 .newText = 'plenary.async'
-  --                  ^^^
-  --                  prefix (We'd remove everything not starting with `asy`,
-  --                  so we'd eliminate the `plenary.async` result
-  --
-  -- `adjust_start_col` is used to prefer the language server boundary.
-  --
-  local candidates = get_items(result)
-  local curstartbyte = adjust_start_col(lnum, line, candidates, encoding)
-  if server_start_boundary == nil then
-    server_start_boundary = curstartbyte
-  elseif curstartbyte ~= nil and curstartbyte ~= server_start_boundary then
-    server_start_boundary = client_start_boundary
-  end
-  local prefix = line:sub((server_start_boundary or client_start_boundary) + 1, cursor_col)
-  local matches = M._lsp_to_complete_items(result, prefix)
-  return matches, server_start_boundary
-end
-
----@param findstart integer 0 or 1, decides behavior
----@param base integer findstart=0, text to match against
----@return integer|table Decided by {findstart}:
---- - findstart=0: column where the completion starts, or -2 or -3
---- - findstart=1: list of matches (actually just calls |complete()|)
-function M.omnifunc(findstart, base)
-  assert(base) -- silence luals
-  local bufnr = api.nvim_get_current_buf()
-  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
-  local remaining = #clients
-  if remaining == 0 then
-    return findstart == 1 and -1 or {}
-  end
-
-  local win = api.nvim_get_current_win()
-  local cursor = api.nvim_win_get_cursor(win)
-  local lnum = cursor[1] - 1
-  local cursor_col = cursor[2]
-  local line = api.nvim_get_current_line()
-  local line_to_cursor = line:sub(1, cursor_col)
-  local client_start_boundary = vim.fn.match(line_to_cursor, '\\k*$') --[[@as integer]]
-  local server_start_boundary = nil
-  local items = {}
-
-  local function on_done()
-    local mode = api.nvim_get_mode()['mode']
-    if mode == 'i' or mode == 'ic' then
-      vim.fn.complete((server_start_boundary or client_start_boundary) + 1, items)
-    end
-  end
-
-  local util = vim.lsp.util
-  for _, client in ipairs(clients) do
-    local params = util.make_position_params(win, client.offset_encoding)
-    client.request(ms.textDocument_completion, params, function(err, result)
-      if err then
-        vim.lsp.log.warn(err.message)
-      end
-      if result and vim.fn.mode() == 'i' then
-        local matches
-        matches, server_start_boundary = M._convert_results(
-          line,
-          lnum,
-          cursor_col,
-          client_start_boundary,
-          server_start_boundary,
-          result,
-          client.offset_encoding
-        )
-        vim.list_extend(items, matches)
-      end
-      remaining = remaining - 1
-      if remaining == 0 then
-        vim.schedule(on_done)
-      end
-    end, bufnr)
-  end
-
-  -- Return -2 to signal that we should continue completion so that we can
-  -- async complete.
-  return -2
-end
-
-return M
diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index 4beb7fefda..c8616bf728 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -869,7 +869,8 @@ end
 --- @param command lsp.Command
 --- @param context? {bufnr: integer}
 --- @param handler? lsp.Handler only called if a server command
-function Client:_exec_cmd(command, context, handler)
+--- @param on_unsupported? function handler invoked when the command is not supported by the client.
+function Client:_exec_cmd(command, context, handler, on_unsupported)
   context = vim.deepcopy(context or {}, true) --[[@as lsp.HandlerContext]]
   context.bufnr = context.bufnr or api.nvim_get_current_buf()
   context.client_id = self.id
@@ -883,14 +884,18 @@ function Client:_exec_cmd(command, context, handler)
   local command_provider = self.server_capabilities.executeCommandProvider
   local commands = type(command_provider) == 'table' and command_provider.commands or {}
   if not vim.list_contains(commands, cmdname) then
-    vim.notify_once(
-      string.format(
-        'Language server `%s` does not support command `%s`. This command may require a client extension.',
-        self.name,
-        cmdname
-      ),
-      vim.log.levels.WARN
-    )
+    if on_unsupported then
+      on_unsupported()
+    else
+      vim.notify_once(
+        string.format(
+          'Language server `%s` does not support command `%s`. This command may require a client extension.',
+          self.name,
+          cmdname
+        ),
+        vim.log.levels.WARN
+      )
+    end
     return
   end
   -- Not using command directly to exclude extra properties,
diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
new file mode 100644
index 0000000000..25b3d53c8c
--- /dev/null
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -0,0 +1,734 @@
+local M = {}
+
+local api = vim.api
+local lsp = vim.lsp
+local protocol = lsp.protocol
+local ms = protocol.Methods
+
+local rtt_ms = 50
+local ns_to_ms = 0.000001
+
+--- @alias vim.lsp.CompletionResult lsp.CompletionList | lsp.CompletionItem[]
+
+-- TODO(mariasolos): Remove this declaration once we figure out a better way to handle
+-- literal/anonymous types (see https://github.com/neovim/neovim/pull/27542/files#r1495259331).
+--- @nodoc
+--- @class lsp.ItemDefaults
+--- @field editRange lsp.Range | { insert: lsp.Range, replace: lsp.Range } | nil
+--- @field insertTextFormat lsp.InsertTextFormat?
+--- @field insertTextMode lsp.InsertTextMode?
+--- @field data any
+
+--- @nodoc
+--- @class vim.lsp.completion.BufHandle
+--- @field clients table<integer, vim.lsp.Client>
+--- @field triggers table<string, vim.lsp.Client[]>
+
+--- @type table<integer, vim.lsp.completion.BufHandle>
+local buf_handles = {}
+
+--- @nodoc
+--- @class vim.lsp.completion.Context
+local Context = {
+  cursor = nil, --- @type { [1]: integer, [2]: integer }?
+  last_request_time = nil, --- @type integer?
+  pending_requests = {}, --- @type function[]
+  isIncomplete = false,
+}
+
+--- @nodoc
+function Context:cancel_pending()
+  for _, cancel in ipairs(self.pending_requests) do
+    cancel()
+  end
+
+  self.pending_requests = {}
+end
+
+--- @nodoc
+function Context:reset()
+  -- Note that the cursor isn't reset here, it needs to survive a `CompleteDone` event.
+  self.isIncomplete = false
+  self.last_request_time = nil
+  self:cancel_pending()
+end
+
+--- @type uv.uv_timer_t?
+local completion_timer = nil
+
+--- @return uv.uv_timer_t
+local function new_timer()
+  return assert(vim.uv.new_timer())
+end
+
+local function reset_timer()
+  if completion_timer then
+    completion_timer:stop()
+    completion_timer:close()
+  end
+
+  completion_timer = nil
+end
+
+--- @param window integer
+--- @param warmup integer
+--- @return fun(sample: number): number
+local function exp_avg(window, warmup)
+  local count = 0
+  local sum = 0
+  local value = 0
+
+  return function(sample)
+    if count < warmup then
+      count = count + 1
+      sum = sum + sample
+      value = sum / count
+    else
+      local factor = 2.0 / (window + 1)
+      value = value * (1 - factor) + sample * factor
+    end
+    return value
+  end
+end
+local compute_new_average = exp_avg(10, 10)
+
+--- @return number
+local function next_debounce()
+  if not Context.last_request_time then
+    return rtt_ms
+  end
+
+  local ms_since_request = (vim.uv.hrtime() - Context.last_request_time) * ns_to_ms
+  return math.max((ms_since_request - rtt_ms) * -1, 0)
+end
+
+--- @param input string Unparsed snippet
+--- @return string # Parsed snippet if successful, else returns its input
+local function parse_snippet(input)
+  local ok, parsed = pcall(function()
+    return lsp._snippet_grammar.parse(input)
+  end)
+  return ok and tostring(parsed) or input
+end
+
+--- @param item lsp.CompletionItem
+--- @param suffix? string
+local function apply_snippet(item, suffix)
+  if item.textEdit then
+    vim.snippet.expand(item.textEdit.newText .. suffix)
+  elseif item.insertText then
+    vim.snippet.expand(item.insertText .. suffix)
+  end
+end
+
+--- Returns text that should be inserted when a selecting completion item. The
+--- precedence is as follows: textEdit.newText > insertText > label
+---
+--- See https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
+---
+--- @param item lsp.CompletionItem
+--- @return string
+local function get_completion_word(item)
+  if item.textEdit ~= nil and item.textEdit.newText ~= nil and item.textEdit.newText ~= '' then
+    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
+      return item.textEdit.newText
+    else
+      return parse_snippet(item.textEdit.newText)
+    end
+  elseif item.insertText ~= nil and item.insertText ~= '' then
+    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
+      return item.insertText
+    else
+      return parse_snippet(item.insertText)
+    end
+  end
+  return item.label
+end
+
+--- Applies the given defaults to the completion item, modifying it in place.
+---
+--- @param item lsp.CompletionItem
+--- @param defaults lsp.ItemDefaults?
+local function apply_defaults(item, defaults)
+  if not defaults then
+    return
+  end
+
+  item.insertTextFormat = item.insertTextFormat or defaults.insertTextFormat
+  item.insertTextMode = item.insertTextMode or defaults.insertTextMode
+  item.data = item.data or defaults.data
+  if defaults.editRange then
+    local textEdit = item.textEdit or {}
+    item.textEdit = textEdit
+    textEdit.newText = textEdit.newText or item.textEditText or item.insertText
+    if defaults.editRange.start then
+      textEdit.range = textEdit.range or defaults.editRange
+    elseif defaults.editRange.insert then
+      textEdit.insert = defaults.editRange.insert
+      textEdit.replace = defaults.editRange.replace
+    end
+  end
+end
+
+--- @param result vim.lsp.CompletionResult
+--- @return lsp.CompletionItem[]
+local function get_items(result)
+  if result.items then
+    -- When we have a list, apply the defaults and return an array of items.
+    for _, item in ipairs(result.items) do
+      ---@diagnostic disable-next-line: param-type-mismatch
+      apply_defaults(item, result.itemDefaults)
+    end
+    return result.items
+  else
+    -- Else just return the items as they are.
+    return result
+  end
+end
+
+--- Turns the result of a `textDocument/completion` request into vim-compatible
+--- |complete-items|.
+---
+--- @private
+--- @param result vim.lsp.CompletionResult Result of `textDocument/completion`
+--- @param prefix string prefix to filter the completion items
+--- @param client_id integer? Client ID
+--- @return table[]
+--- @see complete-items
+function M._lsp_to_complete_items(result, prefix, client_id)
+  local items = get_items(result)
+  if vim.tbl_isempty(items) then
+    return {}
+  end
+
+  local function matches_prefix(item)
+    return vim.startswith(get_completion_word(item), prefix)
+  end
+
+  items = vim.tbl_filter(matches_prefix, items) --[[@as lsp.CompletionItem[]|]]
+  table.sort(items, function(a, b)
+    return (a.sortText or a.label) < (b.sortText or b.label)
+  end)
+
+  local matches = {}
+  for _, item in ipairs(items) do
+    local info = ''
+    local documentation = item.documentation
+    if documentation then
+      if type(documentation) == 'string' and documentation ~= '' then
+        info = documentation
+      elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
+        info = documentation.value
+      else
+        vim.notify(
+          ('invalid documentation value %s'):format(vim.inspect(documentation)),
+          vim.log.levels.WARN
+        )
+      end
+    end
+    local word = get_completion_word(item)
+    table.insert(matches, {
+      word = word,
+      abbr = item.label,
+      kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
+      menu = item.detail or '',
+      info = #info > 0 and info or '',
+      icase = 1,
+      dup = 1,
+      empty = 1,
+      user_data = {
+        nvim = {
+          lsp = {
+            completion_item = item,
+            client_id = client_id,
+          },
+        },
+      },
+    })
+  end
+  return matches
+end
+
+--- @param lnum integer 0-indexed
+--- @param line string
+--- @param items lsp.CompletionItem[]
+--- @param encoding string
+--- @return integer?
+local function adjust_start_col(lnum, line, items, encoding)
+  local min_start_char = nil
+  for _, item in pairs(items) do
+    if item.textEdit and item.textEdit.range.start.line == lnum then
+      if min_start_char and min_start_char ~= item.textEdit.range.start.character then
+        return nil
+      end
+      min_start_char = item.textEdit.range.start.character
+    end
+  end
+  if min_start_char then
+    return lsp.util._str_byteindex_enc(line, min_start_char, encoding)
+  else
+    return nil
+  end
+end
+
+--- @private
+--- @param line string line content
+--- @param lnum integer 0-indexed line number
+--- @param cursor_col integer
+--- @param client_id integer client ID
+--- @param client_start_boundary integer 0-indexed word boundary
+--- @param server_start_boundary? integer 0-indexed word boundary, based on textEdit.range.start.character
+--- @param result vim.lsp.CompletionResult
+--- @param encoding string
+--- @return table[] matches
+--- @return integer? server_start_boundary
+function M._convert_results(
+  line,
+  lnum,
+  cursor_col,
+  client_id,
+  client_start_boundary,
+  server_start_boundary,
+  result,
+  encoding
+)
+  -- Completion response items may be relative to a position different than `client_start_boundary`.
+  -- Concrete example, with lua-language-server:
+  --
+  -- require('plenary.asy|
+  --         ▲       ▲   ▲
+  --         │       │   └── cursor_pos:                     20
+  --         │       └────── client_start_boundary:          17
+  --         └────────────── textEdit.range.start.character: 9
+  --                                 .newText = 'plenary.async'
+  --                  ^^^
+  --                  prefix (We'd remove everything not starting with `asy`,
+  --                  so we'd eliminate the `plenary.async` result
+  --
+  -- `adjust_start_col` is used to prefer the language server boundary.
+  --
+  local candidates = get_items(result)
+  local curstartbyte = adjust_start_col(lnum, line, candidates, encoding)
+  if server_start_boundary == nil then
+    server_start_boundary = curstartbyte
+  elseif curstartbyte ~= nil and curstartbyte ~= server_start_boundary then
+    server_start_boundary = client_start_boundary
+  end
+  local prefix = line:sub((server_start_boundary or client_start_boundary) + 1, cursor_col)
+  local matches = M._lsp_to_complete_items(result, prefix, client_id)
+  return matches, server_start_boundary
+end
+
+--- Implements 'omnifunc' compatible LSP completion.
+---
+--- @see |complete-functions|
+--- @see |complete-items|
+--- @see |CompleteDone|
+---
+--- @param findstart integer 0 or 1, decides behavior
+--- @param base integer findstart=0, text to match against
+---
+--- @return integer|table Decided by {findstart}:
+--- - findstart=0: column where the completion starts, or -2 or -3
+--- - findstart=1: list of matches (actually just calls |complete()|)
+function M._omnifunc(findstart, base)
+  vim.lsp.log.debug('omnifunc.findstart', { findstart = findstart, base = base })
+  assert(base) -- silence luals
+  local bufnr = api.nvim_get_current_buf()
+  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
+  local remaining = #clients
+  if remaining == 0 then
+    return findstart == 1 and -1 or {}
+  end
+
+  local win = api.nvim_get_current_win()
+  local cursor = api.nvim_win_get_cursor(win)
+  local lnum = cursor[1] - 1
+  local cursor_col = cursor[2]
+  local line = api.nvim_get_current_line()
+  local line_to_cursor = line:sub(1, cursor_col)
+  local client_start_boundary = vim.fn.match(line_to_cursor, '\\k*$') --[[@as integer]]
+  local server_start_boundary = nil
+  local items = {}
+
+  local function on_done()
+    local mode = api.nvim_get_mode()['mode']
+    if mode == 'i' or mode == 'ic' then
+      vim.fn.complete((server_start_boundary or client_start_boundary) + 1, items)
+    end
+  end
+
+  local util = vim.lsp.util
+  for _, client in ipairs(clients) do
+    local params = util.make_position_params(win, client.offset_encoding)
+    client.request(ms.textDocument_completion, params, function(err, result)
+      if err then
+        lsp.log.warn(err.message)
+      end
+      if result and vim.fn.mode() == 'i' then
+        local matches
+        matches, server_start_boundary = M._convert_results(
+          line,
+          lnum,
+          cursor_col,
+          client.id,
+          client_start_boundary,
+          server_start_boundary,
+          result,
+          client.offset_encoding
+        )
+        vim.list_extend(items, matches)
+      end
+      remaining = remaining - 1
+      if remaining == 0 then
+        vim.schedule(on_done)
+      end
+    end, bufnr)
+  end
+
+  -- Return -2 to signal that we should continue completion so that we can
+  -- async complete.
+  return -2
+end
+
+--- @param clients table<integer, vim.lsp.Client>
+--- @param bufnr integer
+--- @param win integer
+--- @param callback fun(responses: table<integer, { err: lsp.ResponseError, result: vim.lsp.CompletionResult }>)
+--- @return function # Cancellation function
+local function request(clients, bufnr, win, callback)
+  local responses = {} --- @type table<integer, { err: lsp.ResponseError, result: any }>
+  local request_ids = {} --- @type table<integer, integer>
+  local remaining_requests = vim.tbl_count(clients)
+
+  for client_id, client in pairs(clients) do
+    local params = lsp.util.make_position_params(win, client.offset_encoding)
+    local ok, request_id = client.request(ms.textDocument_completion, params, function(err, result)
+      responses[client_id] = { err = err, result = result }
+      remaining_requests = remaining_requests - 1
+      if remaining_requests == 0 then
+        callback(responses)
+      end
+    end, bufnr)
+
+    if ok then
+      request_ids[client_id] = request_id
+    end
+  end
+
+  return function()
+    for client_id, request_id in pairs(request_ids) do
+      local client = lsp.get_client_by_id(client_id)
+      if client then
+        client.cancel_request(request_id)
+      end
+    end
+  end
+end
+
+--- @param handle vim.lsp.completion.BufHandle
+local function on_insert_char_pre(handle)
+  if tonumber(vim.fn.pumvisible()) == 1 then
+    if Context.isIncomplete then
+      reset_timer()
+
+      local debounce_ms = next_debounce()
+      if debounce_ms == 0 then
+        vim.schedule(M.trigger)
+      else
+        completion_timer = new_timer()
+        completion_timer:start(debounce_ms, 0, vim.schedule_wrap(M.trigger))
+      end
+    end
+
+    return
+  end
+
+  local char = api.nvim_get_vvar('char')
+  if not completion_timer and handle.triggers[char] then
+    completion_timer = assert(vim.uv.new_timer())
+    completion_timer:start(25, 0, function()
+      reset_timer()
+      vim.schedule(M.trigger)
+    end)
+  end
+end
+
+local function on_insert_leave()
+  reset_timer()
+  Context.cursor = nil
+  Context:reset()
+end
+
+local function on_complete_done()
+  local completed_item = api.nvim_get_vvar('completed_item')
+  if not completed_item or not completed_item.user_data or not completed_item.user_data.nvim then
+    Context:reset()
+    return
+  end
+
+  local cursor_row, cursor_col = unpack(api.nvim_win_get_cursor(0)) --- @type integer, integer
+  cursor_row = cursor_row - 1
+  local completion_item = completed_item.user_data.nvim.lsp.completion_item --- @type lsp.CompletionItem
+  local client_id = completed_item.user_data.nvim.lsp.client_id --- @type integer
+  if not completion_item or not client_id then
+    Context:reset()
+    return
+  end
+
+  local bufnr = api.nvim_get_current_buf()
+  local expand_snippet = completion_item.insertTextFormat == protocol.InsertTextFormat.Snippet
+    and (completion_item.textEdit ~= nil or completion_item.insertText ~= nil)
+
+  Context:reset()
+
+  local client = lsp.get_client_by_id(client_id)
+  if not client then
+    return
+  end
+
+  local offset_encoding = client.offset_encoding or 'utf-16'
+  local resolve_provider = (client.server_capabilities.completionProvider or {}).resolveProvider
+
+  local function clear_word()
+    if not expand_snippet then
+      return nil
+    end
+
+    -- Remove the already inserted word.
+    local start_char = cursor_col - #completed_item.word
+    local line = api.nvim_buf_get_lines(bufnr, cursor_row, cursor_row + 1, true)[1]
+    api.nvim_buf_set_text(bufnr, cursor_row, start_char, cursor_row, #line, { '' })
+    return line:sub(cursor_col + 1)
+  end
+
+  --- @param suffix? string
+  local function apply_snippet_and_command(suffix)
+    if expand_snippet then
+      apply_snippet(completion_item, suffix)
+    end
+
+    local command = completion_item.command
+    if command then
+      client:_exec_cmd(command, { bufnr = bufnr }, nil, function()
+        vim.lsp.log.warn(
+          string.format(
+            'Language server `%s` does not support command `%s`. This command may require a client extension.',
+            client.name,
+            command.command
+          )
+        )
+      end)
+    end
+  end
+
+  if completion_item.additionalTextEdits and next(completion_item.additionalTextEdits) then
+    local suffix = clear_word()
+    lsp.util.apply_text_edits(completion_item.additionalTextEdits, bufnr, offset_encoding)
+    apply_snippet_and_command(suffix)
+  elseif resolve_provider and type(completion_item) == 'table' then
+    local changedtick = vim.b[bufnr].changedtick
+
+    --- @param result lsp.CompletionItem
+    client.request(ms.completionItem_resolve, completion_item, function(err, result)
+      if changedtick ~= vim.b[bufnr].changedtick then
+        return
+      end
+
+      local suffix = clear_word()
+      if err then
+        vim.notify_once(err.message, vim.log.levels.WARN)
+      elseif result and result.additionalTextEdits then
+        lsp.util.apply_text_edits(result.additionalTextEdits, bufnr, offset_encoding)
+        if result.command then
+          completion_item.command = result.command
+        end
+      end
+
+      apply_snippet_and_command(suffix)
+    end, bufnr)
+  else
+    local suffix = clear_word()
+    apply_snippet_and_command(suffix)
+  end
+end
+
+--- @class vim.lsp.completion.BufferOpts
+--- @field autotrigger? boolean Whether to trigger completion automatically. Default: false
+
+--- @param client_id integer
+---@param bufnr integer
+---@param opts vim.lsp.completion.BufferOpts
+local function enable_completions(client_id, bufnr, opts)
+  if not buf_handles[bufnr] then
+    buf_handles[bufnr] = { clients = {}, triggers = {} }
+
+    -- Attach to buffer events.
+    api.nvim_buf_attach(bufnr, false, {
+      on_detach = function(_, buf)
+        buf_handles[buf] = nil
+      end,
+      on_reload = function(_, buf)
+        M.enable(true, client_id, buf, opts)
+      end,
+    })
+
+    -- Set up autocommands.
+    local group =
+      api.nvim_create_augroup(string.format('vim/lsp/completion-%d', bufnr), { clear = true })
+    api.nvim_create_autocmd('CompleteDone', {
+      group = group,
+      buffer = bufnr,
+      callback = function()
+        local reason = api.nvim_get_vvar('event').reason --- @type string
+        if reason == 'accept' then
+          on_complete_done()
+        end
+      end,
+    })
+    if opts.autotrigger then
+      api.nvim_create_autocmd('InsertCharPre', {
+        group = group,
+        buffer = bufnr,
+        callback = function()
+          on_insert_char_pre(buf_handles[bufnr])
+        end,
+      })
+      api.nvim_create_autocmd('InsertLeave', {
+        group = group,
+        buffer = bufnr,
+        callback = on_insert_leave,
+      })
+    end
+  end
+
+  if not buf_handles[bufnr].clients[client_id] then
+    local client = lsp.get_client_by_id(client_id)
+    assert(client, 'invalid client ID')
+
+    -- Add the new client to the buffer's clients.
+    buf_handles[bufnr].clients[client_id] = client
+
+    -- Add the new client to the clients that should be triggered by its trigger characters.
+    --- @type string[]
+    local triggers = vim.tbl_get(
+      client.server_capabilities,
+      'completionProvider',
+      'triggerCharacters'
+    ) or {}
+    for _, char in ipairs(triggers) do
+      local clients_for_trigger = buf_handles[bufnr].triggers[char]
+      if not clients_for_trigger then
+        clients_for_trigger = {}
+        buf_handles[bufnr].triggers[char] = clients_for_trigger
+      end
+      local client_exists = vim.iter(clients_for_trigger):any(function(c)
+        return c.id == client_id
+      end)
+      if not client_exists then
+        table.insert(clients_for_trigger, client)
+      end
+    end
+  end
+end
+
+--- @param client_id integer
+--- @param bufnr integer
+local function disable_completions(client_id, bufnr)
+  local handle = buf_handles[bufnr]
+  if not handle then
+    return
+  end
+
+  handle.clients[client_id] = nil
+  if not next(handle.clients) then
+    buf_handles[bufnr] = nil
+    api.nvim_del_augroup_by_name(string.format('vim/lsp/completion-%d', bufnr))
+  else
+    for char, clients in pairs(handle.triggers) do
+      --- @param c vim.lsp.Client
+      handle.triggers[char] = vim.tbl_filter(function(c)
+        return c.id ~= client_id
+      end, clients)
+    end
+  end
+end
+
+--- Enables or disables completions from the given language client in the given buffer.
+---
+--- @param enable boolean True to enable, false to disable
+--- @param client_id integer Client ID
+--- @param bufnr integer Buffer handle, or 0 for the current buffer
+--- @param opts? vim.lsp.completion.BufferOpts
+function M.enable(enable, client_id, bufnr, opts)
+  bufnr = (bufnr == 0 and api.nvim_get_current_buf()) or bufnr
+
+  if enable then
+    enable_completions(client_id, bufnr, opts or {})
+  else
+    disable_completions(client_id, bufnr)
+  end
+end
+
+--- Trigger LSP completion in the current buffer.
+function M.trigger()
+  reset_timer()
+  Context:cancel_pending()
+
+  local win = api.nvim_get_current_win()
+  local bufnr = api.nvim_get_current_buf()
+  local cursor_row, cursor_col = unpack(api.nvim_win_get_cursor(win)) --- @type integer, integer
+  local line = api.nvim_get_current_line()
+  local line_to_cursor = line:sub(1, cursor_col)
+  local clients = (buf_handles[bufnr] or {}).clients or {}
+  local word_boundary = vim.fn.match(line_to_cursor, '\\k*$')
+  local start_time = vim.uv.hrtime()
+  Context.last_request_time = start_time
+
+  local cancel_request = request(clients, bufnr, win, function(responses)
+    local end_time = vim.uv.hrtime()
+    rtt_ms = compute_new_average((end_time - start_time) * ns_to_ms)
+
+    Context.pending_requests = {}
+    Context.isIncomplete = false
+
+    local row_changed = api.nvim_win_get_cursor(win)[1] ~= cursor_row
+    local mode = api.nvim_get_mode().mode
+    if row_changed or not (mode == 'i' or mode == 'ic') then
+      return
+    end
+
+    local matches = {}
+    local server_start_boundary --- @type integer?
+    for client_id, response in pairs(responses) do
+      if response.err then
+        vim.notify_once(response.err.message, vim.log.levels.warn)
+      end
+
+      local result = response.result
+      if result then
+        Context.isIncomplete = Context.isIncomplete or result.isIncomplete
+        local client = lsp.get_client_by_id(client_id)
+        local encoding = client and client.offset_encoding or 'utf-16'
+        local client_matches
+        client_matches, server_start_boundary = M._convert_results(
+          line,
+          cursor_row - 1,
+          cursor_col,
+          client_id,
+          word_boundary,
+          nil,
+          result,
+          encoding
+        )
+        vim.list_extend(matches, client_matches)
+      end
+    end
+    local start_col = (server_start_boundary or word_boundary) + 1
+    vim.fn.complete(start_col, matches)
+  end)
+
+  table.insert(Context.pending_requests, cancel_request)
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index f9d394642c..38c43893eb 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -3,7 +3,7 @@ local protocol = require('vim.lsp.protocol')
 local ms = protocol.Methods
 local util = require('vim.lsp.util')
 local api = vim.api
-local completion = require('vim.lsp._completion')
+local completion = require('vim.lsp.completion')
 
 --- @type table<string,lsp.Handler>
 local M = {}
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 419c2ff644..8ac4cc794b 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -738,14 +738,16 @@ function protocol.make_client_capabilities()
       completion = {
         dynamicRegistration = false,
         completionItem = {
-          -- Until we can actually expand snippet, move cursor and allow for true snippet experience,
-          -- this should be disabled out of the box.
-          -- However, users can turn this back on if they have a snippet plugin.
-          snippetSupport = false,
+          snippetSupport = true,
           commitCharactersSupport = false,
           preselectSupport = false,
           deprecatedSupport = false,
           documentationFormat = { constants.MarkupKind.Markdown, constants.MarkupKind.PlainText },
+          resolveSupport = {
+            properties = {
+              'additionalTextEdits',
+            },
+          },
         },
         completionItemKind = {
           valueSet = get_value_set(constants.CompletionItemKind),
-- 
cgit 


From 90a4b1a59cf0c204cb39ec7789ab8783626e449d Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 28 May 2024 03:07:13 -0700
Subject: refactor: deprecate vim.region() #28416

Problem:
`vim.region()` is redundant with `getregionpos()`.

Solution:
Deprecate `vim.region()`.
---
 runtime/lua/vim/lsp/buf.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 49833eaeec..299b68e134 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -135,7 +135,7 @@ end
 ---@param mode "v"|"V"
 ---@return table {start={row,col}, end={row,col}} using (1, 0) indexing
 local function range_from_selection(bufnr, mode)
-  -- TODO: Use `vim.region()` instead https://github.com/neovim/neovim/pull/13896
+  -- TODO: Use `vim.fn.getregionpos()` instead.
 
   -- [bufnum, lnum, col, off]; both row and column 1-indexed
   local start = vim.fn.getpos('v')
-- 
cgit 


From 0df2c6b5d09fab392dd1a14e4b2e6a3b03203aaa Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Tue, 28 May 2024 21:37:46 +0200
Subject: feat(lsp): use fuzzy match on filterText instead of prefix match

The `complete()` mechanism matches completion candidates against
the typed text, so strict pre-filtering isn't necessary.

This is a first step towards supporting postfix snippets (like
`items@insert` in luals)
---
 runtime/lua/vim/lsp/completion.lua | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 25b3d53c8c..f9b0563b86 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -201,11 +201,17 @@ function M._lsp_to_complete_items(result, prefix, client_id)
     return {}
   end
 
-  local function matches_prefix(item)
-    return vim.startswith(get_completion_word(item), prefix)
-  end
+  if prefix ~= '' then
+    ---@param item lsp.CompletionItem
+    local function match_prefix(item)
+      if item.filterText then
+        return next(vim.fn.matchfuzzy({ item.filterText }, prefix))
+      end
+      return true
+    end
 
-  items = vim.tbl_filter(matches_prefix, items) --[[@as lsp.CompletionItem[]|]]
+    items = vim.tbl_filter(match_prefix, items) --[[@as lsp.CompletionItem[]|]]
+  end
   table.sort(items, function(a, b)
     return (a.sortText or a.label) < (b.sortText or b.label)
   end)
-- 
cgit 


From b2bad0ac91ddb9b33c3547b6fd4f7278794818d9 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Tue, 28 May 2024 23:20:25 +0200
Subject: feat(lsp): support postfix snippets in completion

---
 runtime/lua/vim/lsp/completion.lua | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index f9b0563b86..39c0c5fa29 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -129,18 +129,33 @@ end
 --- @param item lsp.CompletionItem
 --- @return string
 local function get_completion_word(item)
-  if item.textEdit ~= nil and item.textEdit.newText ~= nil and item.textEdit.newText ~= '' then
-    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
-      return item.textEdit.newText
-    else
-      return parse_snippet(item.textEdit.newText)
-    end
-  elseif item.insertText ~= nil and item.insertText ~= '' then
-    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
-      return item.insertText
-    else
+  if item.insertTextFormat == protocol.InsertTextFormat.Snippet then
+    if item.textEdit then
+      -- Use label instead of text if text has different starting characters.
+      -- label is used as abbr (=displayed), but word is used for filtering
+      -- This is required for things like postfix completion.
+      -- E.g. in lua:
+      --
+      --    local f = {}
+      --    f@|
+      --      ▲
+      --      └─ cursor
+      --
+      --    item.textEdit.newText: table.insert(f, $0)
+      --    label: insert
+      --
+      -- Typing `i` would remove the candidate because newText starts with `t`.
+      local text = item.insertText or item.textEdit.newText
+      return #text < #item.label and text or item.label
+    elseif item.insertText and item.insertText ~= '' then
       return parse_snippet(item.insertText)
+    else
+      return item.label
     end
+  elseif item.textEdit then
+    return item.textEdit.newText
+  elseif item.insertText and item.insertText ~= '' then
+    return item.insertText
   end
   return item.label
 end
-- 
cgit 


From 5c33815448e11b514678f39cecc74e68131d4628 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 30 May 2024 10:46:26 +0200
Subject: refactor(lsp): replace util.buf_versions with changedtick (#28943)

`lsp.util.buf_versions` was already derived from changedtick (`on_lines`
from `buf_attach` synced the version)

As far as I can tell there is no need to keep track of the state in a
separate table.
---
 runtime/lua/vim/lsp/_changetracking.lua |  3 +--
 runtime/lua/vim/lsp/client.lua          |  5 ++---
 runtime/lua/vim/lsp/inlay_hint.lua      |  4 ++--
 runtime/lua/vim/lsp/semantic_tokens.lua |  6 +++---
 runtime/lua/vim/lsp/util.lua            | 16 +++++++++++-----
 5 files changed, 19 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_changetracking.lua b/runtime/lua/vim/lsp/_changetracking.lua
index b2be53269f..ce701f0772 100644
--- a/runtime/lua/vim/lsp/_changetracking.lua
+++ b/runtime/lua/vim/lsp/_changetracking.lua
@@ -1,6 +1,5 @@
 local protocol = require('vim.lsp.protocol')
 local sync = require('vim.lsp.sync')
-local util = require('vim.lsp.util')
 
 local api = vim.api
 local uv = vim.uv
@@ -277,7 +276,7 @@ local function send_changes(bufnr, sync_kind, state, buf_state)
       client.notify(protocol.Methods.textDocument_didChange, {
         textDocument = {
           uri = uri,
-          version = util.buf_versions[bufnr],
+          version = vim.b[bufnr].changedtick,
         },
         contentChanges = changes,
       })
diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index 327cd19125..b28fe2f797 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -673,8 +673,8 @@ function Client:_request(method, params, handler, bufnr)
   end
   -- Ensure pending didChange notifications are sent so that the server doesn't operate on a stale state
   changetracking.flush(self, bufnr)
-  local version = lsp.util.buf_versions[bufnr]
   bufnr = resolve_bufnr(bufnr)
+  local version = vim.b[bufnr].changedtick
   log.debug(self._log_prefix, 'client.request', self.id, method, params, handler, bufnr)
   local success, request_id = self.rpc.request(method, params, function(err, result)
     local context = {
@@ -922,14 +922,13 @@ function Client:_text_document_did_open_handler(bufnr)
 
   local params = {
     textDocument = {
-      version = 0,
+      version = vim.b[bufnr].changedtick,
       uri = vim.uri_from_bufnr(bufnr),
       languageId = self.get_language_id(bufnr, filetype),
       text = lsp._buf_get_full_text(bufnr),
     },
   }
   self.notify(ms.textDocument_didOpen, params)
-  lsp.util.buf_versions[bufnr] = params.textDocument.version
 
   -- Next chance we get, we should re-do the diagnostics
   vim.schedule(function()
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index f98496456b..78f309abf7 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -43,7 +43,7 @@ function M.on_inlayhint(err, result, ctx, _)
     return
   end
   local bufnr = assert(ctx.bufnr)
-  if util.buf_versions[bufnr] ~= ctx.version then
+  if vim.b[bufnr].changedtick ~= ctx.version then
     return
   end
   local client_id = ctx.client_id
@@ -324,7 +324,7 @@ api.nvim_set_decoration_provider(namespace, {
       return
     end
 
-    if bufstate.version ~= util.buf_versions[bufnr] then
+    if bufstate.version ~= vim.b[bufnr].changedtick then
       return
     end
 
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index ef2502b12e..278014a4ea 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -116,7 +116,7 @@ local function tokens_to_ranges(data, bufnr, client, request)
 
       if elapsed_ns > yield_interval_ns then
         vim.schedule(function()
-          coroutine.resume(co, util.buf_versions[bufnr])
+          coroutine.resume(co, vim.b[bufnr].changedtick)
         end)
         if request.version ~= coroutine.yield() then
           -- request became stale since the last time the coroutine ran.
@@ -275,7 +275,7 @@ end
 ---
 ---@package
 function STHighlighter:send_request()
-  local version = util.buf_versions[self.bufnr]
+  local version = vim.b[self.bufnr].changedtick
 
   self:reset_timer()
 
@@ -418,7 +418,7 @@ end
 function STHighlighter:on_win(topline, botline)
   for client_id, state in pairs(self.client_state) do
     local current_result = state.current_result
-    if current_result.version and current_result.version == util.buf_versions[self.bufnr] then
+    if current_result.version and current_result.version == vim.b[self.bufnr].changedtick then
       if not current_result.namespace_cleared then
         api.nvim_buf_clear_namespace(self.bufnr, state.namespace, 0, -1)
         current_result.namespace_cleared = true
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 0099e82f52..d1f0e97065 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -509,8 +509,7 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     and (
       text_document.version
       and text_document.version > 0
-      and M.buf_versions[bufnr]
-      and M.buf_versions[bufnr] > text_document.version
+      and vim.b[bufnr].changedtick > text_document.version
     )
   then
     print('Buffer ', text_document.uri, ' newer than edits.')
@@ -2200,9 +2199,16 @@ function M._refresh(method, opts)
   end
 end
 
-M._get_line_byte_from_position = get_line_byte_from_position
-
 ---@nodoc
-M.buf_versions = {} ---@type table<integer,integer>
+---@deprecated
+---@type table<integer,integer>
+M.buf_versions = setmetatable({}, {
+  __index = function(_, bufnr)
+    vim.deprecate('vim.lsp.util.buf_versions', 'vim.b.changedtick', '0.13')
+    return vim.b[bufnr].changedtick
+  end,
+})
+
+M._get_line_byte_from_position = get_line_byte_from_position
 
 return M
-- 
cgit 


From 6566a59b3a6c8dabfa40f8debd0de96d875825e9 Mon Sep 17 00:00:00 2001
From: Ilia Choly <ilia.choly@gmail.com>
Date: Fri, 31 May 2024 08:41:10 -0400
Subject: refactor(lsp): use predefined types in util function signatures
 (#29095)

---
 runtime/lua/vim/lsp/util.lua | 60 +++++++++++++++++++++++---------------------
 1 file changed, 31 insertions(+), 29 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index d1f0e97065..b33f6ccf69 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -173,11 +173,11 @@ local _str_byteindex_enc = M._str_byteindex_enc
 --- CAUTION: Changes in-place!
 ---
 ---@deprecated
----@param lines (table) Original list of strings
----@param A (table) Start position; a 2-tuple of {line,col} numbers
----@param B (table) End position; a 2-tuple of {line,col} numbers
----@param new_lines (table) list of strings to replace the original
----@return table The modified {lines} object
+---@param lines string[] Original list of strings
+---@param A [integer, integer] Start position; a 2-tuple of {line,col} numbers
+---@param B [integer, integer] End position; a 2-tuple {line,col} numbers
+---@param new_lines string[] list of strings to replace the original
+---@return string[] The modified {lines} object
 function M.set_lines(lines, A, B, new_lines)
   vim.deprecate('vim.lsp.util.set_lines()', 'nil', '0.12')
   -- 0-indexing to 1-indexing
@@ -343,7 +343,7 @@ local function get_line_byte_from_position(bufnr, position, offset_encoding)
 end
 
 --- Applies a list of text edits to a buffer.
----@param text_edits table list of `TextEdit` objects
+---@param text_edits lsp.TextEdit[]
 ---@param bufnr integer Buffer id
 ---@param offset_encoding string utf-8|utf-16|utf-32
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textEdit
@@ -481,8 +481,8 @@ end
 --- Applies a `TextDocumentEdit`, which is a list of changes to a single
 --- document.
 ---
----@param text_document_edit table: a `TextDocumentEdit` object
----@param index integer: Optional index of the edit, if from a list of edits (or nil, if not from a list)
+---@param text_document_edit lsp.TextDocumentEdit
+---@param index? integer: Optional index of the edit, if from a list of edits (or nil, if not from a list)
 ---@param offset_encoding? string
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentEdit
 function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
@@ -533,6 +533,7 @@ local function path_under_prefix(path, prefix)
 end
 
 --- Get list of buffers whose filename matches the given path prefix (normalized full path)
+---@param prefix string
 ---@return integer[]
 local function get_bufs_with_prefix(prefix)
   prefix = path_components(prefix)
@@ -677,7 +678,7 @@ end
 
 --- Applies a `WorkspaceEdit`.
 ---
----@param workspace_edit table `WorkspaceEdit`
+---@param workspace_edit lsp.WorkspaceEdit
 ---@param offset_encoding string utf-8|utf-16|utf-32 (required)
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit
 function M.apply_workspace_edit(workspace_edit, offset_encoding)
@@ -723,8 +724,8 @@ end
 --- Note that if the input is of type `MarkupContent` and its kind is `plaintext`,
 --- then the corresponding value is returned without further modifications.
 ---
----@param input (lsp.MarkedString | lsp.MarkedString[] | lsp.MarkupContent)
----@param contents (table|nil) List of strings to extend with converted lines. Defaults to {}.
+---@param input lsp.MarkedString|lsp.MarkedString[]|lsp.MarkupContent
+---@param contents string[]|nil List of strings to extend with converted lines. Defaults to {}.
 ---@return string[] extended with lines of converted markdown.
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
 function M.convert_input_to_markdown_lines(input, contents)
@@ -759,11 +760,11 @@ end
 
 --- Converts `textDocument/signatureHelp` response to markdown lines.
 ---
----@param signature_help table Response of `textDocument/SignatureHelp`
+---@param signature_help lsp.SignatureHelp Response of `textDocument/SignatureHelp`
 ---@param ft string|nil filetype that will be use as the `lang` for the label markdown code block
 ---@param triggers table|nil list of trigger characters from the lsp server. used to better determine parameter offsets
----@return table|nil table list of lines of converted markdown.
----@return table|nil table of active hl
+---@return string[]|nil table list of lines of converted markdown.
+---@return number[]|nil table of active hl
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
 function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers)
   if not signature_help.signatures then
@@ -960,7 +961,7 @@ end
 
 --- Shows document and optionally jumps to the location.
 ---
----@param location table (`Location`|`LocationLink`)
+---@param location lsp.Location|lsp.LocationLink
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32
 ---@param opts table|nil options
 ---        - reuse_win (boolean) Jump to existing window if buffer is already open.
@@ -1017,7 +1018,7 @@ end
 
 --- Jumps to a location.
 ---
----@param location table (`Location`|`LocationLink`)
+---@param location lsp.Location|lsp.LocationLink
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32
 ---@param reuse_win boolean|nil Jump to existing window if buffer is already open.
 ---@return boolean `true` if the jump succeeded
@@ -1038,7 +1039,7 @@ end
 ---   - for Location, range is shown (e.g., function definition)
 ---   - for LocationLink, targetRange is shown (e.g., body of function definition)
 ---
----@param location table a single `Location` or `LocationLink`
+---@param location lsp.Location|lsp.LocationLink
 ---@param opts table
 ---@return integer|nil buffer id of float window
 ---@return integer|nil window id of float window
@@ -1154,7 +1155,7 @@ end
 --- If you want to open a popup with fancy markdown, use `open_floating_preview` instead
 ---
 ---@param bufnr integer
----@param contents table of lines to show in window
+---@param contents string[] of lines to show in window
 ---@param opts table with optional fields
 ---  - height    of floating window
 ---  - width     of floating window
@@ -1669,7 +1670,7 @@ do --[[ References ]]
   --- Shows a list of document highlights for a certain buffer.
   ---
   ---@param bufnr integer Buffer id
-  ---@param references table List of `DocumentHighlight` objects to highlight
+  ---@param references lsp.DocumentHighlight[] objects to highlight
   ---@param offset_encoding string One of "utf-8", "utf-16", "utf-32".
   ---@see https://microsoft.github.io/language-server-protocol/specification/#textDocumentContentChangeEvent
   function M.buf_highlight_references(bufnr, references, offset_encoding)
@@ -1873,7 +1874,7 @@ end
 --- CAUTION: Modifies the input in-place!
 ---
 ---@deprecated
----@param lines table list of lines
+---@param lines string[] list of lines
 ---@return string filetype or "markdown" if it was unchanged.
 function M.try_trim_markdown_code_blocks(lines)
   vim.deprecate('vim.lsp.util.try_trim_markdown_code_blocks()', 'nil', '0.12')
@@ -1898,7 +1899,7 @@ function M.try_trim_markdown_code_blocks(lines)
 end
 
 ---@param window integer|nil: window handle or 0 for current, defaults to current
----@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
+---@param offset_encoding? string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
 local function make_position_param(window, offset_encoding)
   window = window or 0
   local buf = api.nvim_win_get_buf(window)
@@ -1919,7 +1920,7 @@ end
 ---
 ---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
----@return table `TextDocumentPositionParams` object
+---@return lsp.TextDocumentPositionParams
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentPositionParams
 function M.make_position_params(window, offset_encoding)
   window = window or 0
@@ -1932,7 +1933,7 @@ function M.make_position_params(window, offset_encoding)
 end
 
 --- Utility function for getting the encoding of the first LSP client on the given buffer.
----@param bufnr (integer) buffer handle or 0 for current, defaults to current
+---@param bufnr integer buffer handle or 0 for current, defaults to current
 ---@return string encoding first client if there is one, nil otherwise
 function M._get_offset_encoding(bufnr)
   validate({
@@ -2033,15 +2034,16 @@ end
 --- Creates a `TextDocumentIdentifier` object for the current buffer.
 ---
 ---@param bufnr integer|nil: Buffer handle, defaults to current
----@return table `TextDocumentIdentifier`
+---@return lsp.TextDocumentIdentifier
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
 function M.make_text_document_params(bufnr)
   return { uri = vim.uri_from_bufnr(bufnr or 0) }
 end
 
 --- Create the workspace params
----@param added table
----@param removed table
+---@param added lsp.WorkspaceFolder[]
+---@param removed lsp.WorkspaceFolder[]
+---@return lsp.WorkspaceFoldersChangeEvent
 function M.make_workspace_params(added, removed)
   return { event = { added = added, removed = removed } }
 end
@@ -2049,8 +2051,8 @@ end
 --- Returns indentation size.
 ---
 ---@see 'shiftwidth'
----@param bufnr (integer|nil): Buffer handle, defaults to current
----@return (integer) indentation size
+---@param bufnr integer|nil: Buffer handle, defaults to current
+---@return integer indentation size
 function M.get_effective_tabstop(bufnr)
   validate({ bufnr = { bufnr, 'n', true } })
   local bo = bufnr and vim.bo[bufnr] or vim.bo
@@ -2060,7 +2062,7 @@ end
 
 --- Creates a `DocumentFormattingParams` object for the current buffer and cursor position.
 ---
----@param options table|nil with valid `FormattingOptions` entries
+---@param options lsp.FormattingOptions|nil with valid `FormattingOptions` entries
 ---@return lsp.DocumentFormattingParams object
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting
 function M.make_formatting_params(options)
-- 
cgit 


From d62d181ce065556be51d5eda0425aa42f427cc27 Mon Sep 17 00:00:00 2001
From: Ilia Choly <ilia.choly@gmail.com>
Date: Fri, 31 May 2024 10:48:05 -0400
Subject: refactor(lsp): use tuple syntax in generated protocol types (#29110)

---
 runtime/lua/vim/lsp/_meta/protocol.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_meta/protocol.lua b/runtime/lua/vim/lsp/_meta/protocol.lua
index 9a11972007..cbddd24630 100644
--- a/runtime/lua/vim/lsp/_meta/protocol.lua
+++ b/runtime/lua/vim/lsp/_meta/protocol.lua
@@ -3235,7 +3235,7 @@ error('Cannot require a meta file')
 ---
 ---*Note*: a label of type string should be a substring of its containing signature label.
 ---Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
----@field label string|{ [1]: uinteger, [2]: uinteger }
+---@field label string|[uinteger, uinteger]
 ---
 ---The human-readable doc-comment of this parameter. Will be shown
 ---in the UI but can be omitted.
-- 
cgit 


From cc1f2d2ca6caa3da4cb7910f74fed4375202e888 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Thu, 30 May 2024 10:24:54 +0200
Subject: perf(lsp): don't copy completion items in filter pass

---
 runtime/lua/vim/lsp/completion.lua | 100 ++++++++++++++++++++-----------------
 1 file changed, 54 insertions(+), 46 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 39c0c5fa29..8777947acf 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -201,6 +201,24 @@ local function get_items(result)
   end
 end
 
+---@param item lsp.CompletionItem
+---@return string
+local function get_doc(item)
+  local doc = item.documentation
+  if not doc then
+    return ''
+  end
+  if type(doc) == 'string' then
+    return doc
+  end
+  if type(doc) == 'table' and type(doc.value) == 'string' then
+    return doc.value
+  end
+
+  vim.notify('invalid documentation value: ' .. vim.inspect(doc), vim.log.levels.WARN)
+  return ''
+end
+
 --- Turns the result of a `textDocument/completion` request into vim-compatible
 --- |complete-items|.
 ---
@@ -216,58 +234,48 @@ function M._lsp_to_complete_items(result, prefix, client_id)
     return {}
   end
 
-  if prefix ~= '' then
-    ---@param item lsp.CompletionItem
-    local function match_prefix(item)
-      if item.filterText then
-        return next(vim.fn.matchfuzzy({ item.filterText }, prefix))
-      end
-      return true
+  local matches = prefix == '' and function()
+    return true
+  end or function(item)
+    if item.filterText then
+      return next(vim.fn.matchfuzzy({ item.filterText }, prefix))
     end
-
-    items = vim.tbl_filter(match_prefix, items) --[[@as lsp.CompletionItem[]|]]
+    return true
   end
-  table.sort(items, function(a, b)
-    return (a.sortText or a.label) < (b.sortText or b.label)
-  end)
-
-  local matches = {}
+  local candidates = {}
   for _, item in ipairs(items) do
-    local info = ''
-    local documentation = item.documentation
-    if documentation then
-      if type(documentation) == 'string' and documentation ~= '' then
-        info = documentation
-      elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
-        info = documentation.value
-      else
-        vim.notify(
-          ('invalid documentation value %s'):format(vim.inspect(documentation)),
-          vim.log.levels.WARN
-        )
-      end
-    end
-    local word = get_completion_word(item)
-    table.insert(matches, {
-      word = word,
-      abbr = item.label,
-      kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
-      menu = item.detail or '',
-      info = #info > 0 and info or '',
-      icase = 1,
-      dup = 1,
-      empty = 1,
-      user_data = {
-        nvim = {
-          lsp = {
-            completion_item = item,
-            client_id = client_id,
+    if matches(item) then
+      local word = get_completion_word(item)
+      table.insert(candidates, {
+        word = word,
+        abbr = item.label,
+        kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
+        menu = item.detail or '',
+        info = get_doc(item),
+        icase = 1,
+        dup = 1,
+        empty = 1,
+        user_data = {
+          nvim = {
+            lsp = {
+              completion_item = item,
+              client_id = client_id,
+            },
           },
         },
-      },
-    })
+      })
+    end
   end
-  return matches
+  ---@diagnostic disable-next-line: no-unknown
+  table.sort(candidates, function(a, b)
+    ---@type lsp.CompletionItem
+    local itema = a.user_data.nvim.lsp.completion_item
+    ---@type lsp.CompletionItem
+    local itemb = b.user_data.nvim.lsp.completion_item
+    return (itema.sortText or itema.label) < (itemb.sortText or itemb.label)
+  end)
+
+  return candidates
 end
 
 --- @param lnum integer 0-indexed
-- 
cgit 


From 4c938f6d72710507db22074951eee23869ed49e0 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Thu, 30 May 2024 10:46:47 +0200
Subject: refactor(lsp): share completion request logic between omnifunc &
 trigger

---
 runtime/lua/vim/lsp/completion.lua | 209 +++++++++++++++----------------------
 1 file changed, 85 insertions(+), 124 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 8777947acf..c514c5ef4d 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -348,78 +348,6 @@ function M._convert_results(
   return matches, server_start_boundary
 end
 
---- Implements 'omnifunc' compatible LSP completion.
----
---- @see |complete-functions|
---- @see |complete-items|
---- @see |CompleteDone|
----
---- @param findstart integer 0 or 1, decides behavior
---- @param base integer findstart=0, text to match against
----
---- @return integer|table Decided by {findstart}:
---- - findstart=0: column where the completion starts, or -2 or -3
---- - findstart=1: list of matches (actually just calls |complete()|)
-function M._omnifunc(findstart, base)
-  vim.lsp.log.debug('omnifunc.findstart', { findstart = findstart, base = base })
-  assert(base) -- silence luals
-  local bufnr = api.nvim_get_current_buf()
-  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
-  local remaining = #clients
-  if remaining == 0 then
-    return findstart == 1 and -1 or {}
-  end
-
-  local win = api.nvim_get_current_win()
-  local cursor = api.nvim_win_get_cursor(win)
-  local lnum = cursor[1] - 1
-  local cursor_col = cursor[2]
-  local line = api.nvim_get_current_line()
-  local line_to_cursor = line:sub(1, cursor_col)
-  local client_start_boundary = vim.fn.match(line_to_cursor, '\\k*$') --[[@as integer]]
-  local server_start_boundary = nil
-  local items = {}
-
-  local function on_done()
-    local mode = api.nvim_get_mode()['mode']
-    if mode == 'i' or mode == 'ic' then
-      vim.fn.complete((server_start_boundary or client_start_boundary) + 1, items)
-    end
-  end
-
-  local util = vim.lsp.util
-  for _, client in ipairs(clients) do
-    local params = util.make_position_params(win, client.offset_encoding)
-    client.request(ms.textDocument_completion, params, function(err, result)
-      if err then
-        lsp.log.warn(err.message)
-      end
-      if result and vim.fn.mode() == 'i' then
-        local matches
-        matches, server_start_boundary = M._convert_results(
-          line,
-          lnum,
-          cursor_col,
-          client.id,
-          client_start_boundary,
-          server_start_boundary,
-          result,
-          client.offset_encoding
-        )
-        vim.list_extend(items, matches)
-      end
-      remaining = remaining - 1
-      if remaining == 0 then
-        vim.schedule(on_done)
-      end
-    end, bufnr)
-  end
-
-  -- Return -2 to signal that we should continue completion so that we can
-  -- async complete.
-  return -2
-end
-
 --- @param clients table<integer, vim.lsp.Client>
 --- @param bufnr integer
 --- @param win integer
@@ -455,6 +383,64 @@ local function request(clients, bufnr, win, callback)
   end
 end
 
+local function trigger(bufnr, clients)
+  reset_timer()
+  Context:cancel_pending()
+
+  local win = api.nvim_get_current_win()
+  local cursor_row, cursor_col = unpack(api.nvim_win_get_cursor(win)) --- @type integer, integer
+  local line = api.nvim_get_current_line()
+  local line_to_cursor = line:sub(1, cursor_col)
+  local word_boundary = vim.fn.match(line_to_cursor, '\\k*$')
+  local start_time = vim.uv.hrtime()
+  Context.last_request_time = start_time
+
+  local cancel_request = request(clients, bufnr, win, function(responses)
+    local end_time = vim.uv.hrtime()
+    rtt_ms = compute_new_average((end_time - start_time) * ns_to_ms)
+
+    Context.pending_requests = {}
+    Context.isIncomplete = false
+
+    local row_changed = api.nvim_win_get_cursor(win)[1] ~= cursor_row
+    local mode = api.nvim_get_mode().mode
+    if row_changed or not (mode == 'i' or mode == 'ic') then
+      return
+    end
+
+    local matches = {}
+    local server_start_boundary --- @type integer?
+    for client_id, response in pairs(responses) do
+      if response.err then
+        vim.notify_once(response.err.message, vim.log.levels.warn)
+      end
+
+      local result = response.result
+      if result then
+        Context.isIncomplete = Context.isIncomplete or result.isIncomplete
+        local client = lsp.get_client_by_id(client_id)
+        local encoding = client and client.offset_encoding or 'utf-16'
+        local client_matches
+        client_matches, server_start_boundary = M._convert_results(
+          line,
+          cursor_row - 1,
+          cursor_col,
+          client_id,
+          word_boundary,
+          nil,
+          result,
+          encoding
+        )
+        vim.list_extend(matches, client_matches)
+      end
+    end
+    local start_col = (server_start_boundary or word_boundary) + 1
+    vim.fn.complete(start_col, matches)
+  end)
+
+  table.insert(Context.pending_requests, cancel_request)
+end
+
 --- @param handle vim.lsp.completion.BufHandle
 local function on_insert_char_pre(handle)
   if tonumber(vim.fn.pumvisible()) == 1 then
@@ -701,63 +687,38 @@ end
 
 --- Trigger LSP completion in the current buffer.
 function M.trigger()
-  reset_timer()
-  Context:cancel_pending()
-
-  local win = api.nvim_get_current_win()
   local bufnr = api.nvim_get_current_buf()
-  local cursor_row, cursor_col = unpack(api.nvim_win_get_cursor(win)) --- @type integer, integer
-  local line = api.nvim_get_current_line()
-  local line_to_cursor = line:sub(1, cursor_col)
   local clients = (buf_handles[bufnr] or {}).clients or {}
-  local word_boundary = vim.fn.match(line_to_cursor, '\\k*$')
-  local start_time = vim.uv.hrtime()
-  Context.last_request_time = start_time
-
-  local cancel_request = request(clients, bufnr, win, function(responses)
-    local end_time = vim.uv.hrtime()
-    rtt_ms = compute_new_average((end_time - start_time) * ns_to_ms)
-
-    Context.pending_requests = {}
-    Context.isIncomplete = false
-
-    local row_changed = api.nvim_win_get_cursor(win)[1] ~= cursor_row
-    local mode = api.nvim_get_mode().mode
-    if row_changed or not (mode == 'i' or mode == 'ic') then
-      return
-    end
+  trigger(bufnr, clients)
+end
 
-    local matches = {}
-    local server_start_boundary --- @type integer?
-    for client_id, response in pairs(responses) do
-      if response.err then
-        vim.notify_once(response.err.message, vim.log.levels.warn)
-      end
+--- Implements 'omnifunc' compatible LSP completion.
+---
+--- @see |complete-functions|
+--- @see |complete-items|
+--- @see |CompleteDone|
+---
+--- @param findstart integer 0 or 1, decides behavior
+--- @param base integer findstart=0, text to match against
+---
+--- @return integer|table Decided by {findstart}:
+--- - findstart=0: column where the completion starts, or -2 or -3
+--- - findstart=1: list of matches (actually just calls |complete()|)
+function M._omnifunc(findstart, base)
+  vim.lsp.log.debug('omnifunc.findstart', { findstart = findstart, base = base })
+  assert(base) -- silence luals
+  local bufnr = api.nvim_get_current_buf()
+  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
+  local remaining = #clients
+  if remaining == 0 then
+    return findstart == 1 and -1 or {}
+  end
 
-      local result = response.result
-      if result then
-        Context.isIncomplete = Context.isIncomplete or result.isIncomplete
-        local client = lsp.get_client_by_id(client_id)
-        local encoding = client and client.offset_encoding or 'utf-16'
-        local client_matches
-        client_matches, server_start_boundary = M._convert_results(
-          line,
-          cursor_row - 1,
-          cursor_col,
-          client_id,
-          word_boundary,
-          nil,
-          result,
-          encoding
-        )
-        vim.list_extend(matches, client_matches)
-      end
-    end
-    local start_col = (server_start_boundary or word_boundary) + 1
-    vim.fn.complete(start_col, matches)
-  end)
+  trigger(bufnr, clients)
 
-  table.insert(Context.pending_requests, cancel_request)
+  -- Return -2 to signal that we should continue completion so that we can
+  -- async complete.
+  return -2
 end
 
 return M
-- 
cgit 


From 138a93a057dabd70673b7466bf5af41bd66f1385 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Thu, 30 May 2024 10:51:52 +0200
Subject: perf(lsp): avoid repeated table lookup in completion.enable

---
 runtime/lua/vim/lsp/completion.lua | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index c514c5ef4d..b77bf3e3c2 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -575,8 +575,10 @@ end
 ---@param bufnr integer
 ---@param opts vim.lsp.completion.BufferOpts
 local function enable_completions(client_id, bufnr, opts)
-  if not buf_handles[bufnr] then
-    buf_handles[bufnr] = { clients = {}, triggers = {} }
+  local buf_handle = buf_handles[bufnr]
+  if not buf_handle then
+    buf_handle = { clients = {}, triggers = {} }
+    buf_handles[bufnr] = buf_handle
 
     -- Attach to buffer events.
     api.nvim_buf_attach(bufnr, false, {
@@ -617,12 +619,12 @@ local function enable_completions(client_id, bufnr, opts)
     end
   end
 
-  if not buf_handles[bufnr].clients[client_id] then
+  if not buf_handle.clients[client_id] then
     local client = lsp.get_client_by_id(client_id)
     assert(client, 'invalid client ID')
 
     -- Add the new client to the buffer's clients.
-    buf_handles[bufnr].clients[client_id] = client
+    buf_handle.clients[client_id] = client
 
     -- Add the new client to the clients that should be triggered by its trigger characters.
     --- @type string[]
@@ -632,10 +634,10 @@ local function enable_completions(client_id, bufnr, opts)
       'triggerCharacters'
     ) or {}
     for _, char in ipairs(triggers) do
-      local clients_for_trigger = buf_handles[bufnr].triggers[char]
+      local clients_for_trigger = buf_handle.triggers[char]
       if not clients_for_trigger then
         clients_for_trigger = {}
-        buf_handles[bufnr].triggers[char] = clients_for_trigger
+        buf_handle.triggers[char] = clients_for_trigger
       end
       local client_exists = vim.iter(clients_for_trigger):any(function(c)
         return c.id == client_id
-- 
cgit 


From 19be3d26830ced203631045f2f622e75e6d857a7 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sun, 2 Jun 2024 09:54:15 +0200
Subject: fix(lsp): trim trailing whitespace from completion words (#29122)

the `complete()` mechanism doesn't play nicely with trailing newlines or
tabs. A newline causes it to insert a null character, showing up as
`^@`.
---
 runtime/lua/vim/lsp/completion.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index b77bf3e3c2..f8e17ae2f0 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -153,7 +153,8 @@ local function get_completion_word(item)
       return item.label
     end
   elseif item.textEdit then
-    return item.textEdit.newText
+    local word = item.textEdit.newText
+    return word:match('^(%S*)') or word
   elseif item.insertText and item.insertText ~= '' then
     return item.insertText
   end
-- 
cgit 


From 5aa9906676f3ad040b0ccb75eb5fd560def1e0ec Mon Sep 17 00:00:00 2001
From: ippachi <ippachi1018@gmail.com>
Date: Tue, 4 Jun 2024 01:07:09 +0900
Subject: fix(lsp): use client.id instead of pairs index (#29143)

Problem: Completion side effects not working randomly.

Solution: When creating the table of LSP responses, the table index
was used, but this is not the same as the actual client_id, so it was changed
to use the client_id directly.
---
 runtime/lua/vim/lsp/completion.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index f8e17ae2f0..c9326a0681 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -349,7 +349,7 @@ function M._convert_results(
   return matches, server_start_boundary
 end
 
---- @param clients table<integer, vim.lsp.Client>
+--- @param clients table<integer, vim.lsp.Client> # keys != client_id
 --- @param bufnr integer
 --- @param win integer
 --- @param callback fun(responses: table<integer, { err: lsp.ResponseError, result: vim.lsp.CompletionResult }>)
@@ -359,7 +359,8 @@ local function request(clients, bufnr, win, callback)
   local request_ids = {} --- @type table<integer, integer>
   local remaining_requests = vim.tbl_count(clients)
 
-  for client_id, client in pairs(clients) do
+  for _, client in pairs(clients) do
+    local client_id = client.id
     local params = lsp.util.make_position_params(win, client.offset_encoding)
     local ok, request_id = client.request(ms.textDocument_completion, params, function(err, result)
       responses[client_id] = { err = err, result = result }
-- 
cgit 


From 8cbb1f20e557461c8417583a7f69d53aaaef920b Mon Sep 17 00:00:00 2001
From: Ilia Choly <ilia.choly@gmail.com>
Date: Tue, 4 Jun 2024 09:06:02 -0400
Subject: refactor(lua): use tuple syntax everywhere #29111

---
 runtime/lua/vim/lsp/completion.lua | 2 +-
 runtime/lua/vim/lsp/inlay_hint.lua | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index c9326a0681..4b7deabf41 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -30,7 +30,7 @@ local buf_handles = {}
 --- @nodoc
 --- @class vim.lsp.completion.Context
 local Context = {
-  cursor = nil, --- @type { [1]: integer, [2]: integer }?
+  cursor = nil, --- @type [integer, integer]?
   last_request_time = nil, --- @type integer?
   pending_requests = {}, --- @type function[]
   isIncomplete = false,
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 78f309abf7..8fd4ceefd2 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -348,7 +348,7 @@ api.nvim_set_decoration_provider(namespace, {
                 text = text .. part.value
               end
             end
-            local vt = {} --- @type {[1]: string, [2]: string?}[]
+            local vt = {} --- @type [string, string?][]
             if hint.paddingLeft then
               vt[#vt + 1] = { ' ' }
             end
-- 
cgit 


From 2e6d295f799c27372e5c0c44727fa613c81717fd Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 4 Jun 2024 17:21:37 +0200
Subject: fix(lsp): account for changedtick version gap on modified reset
 (#29170)

Follow up to https://github.com/neovim/neovim/pull/28943
Fixes https://github.com/neovim/neovim/issues/29163
---
 runtime/lua/vim/lsp/util.lua | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index b33f6ccf69..3215b40d1d 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -502,6 +502,11 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     should_check_version = false
   end
 
+  -- changedtick increases on save but server only receives version updates
+  -- on line changes (via didChange)
+  -- This allows a gap of 1 to account for the servers outdated view
+  local version_offset = vim.b[bufnr].modified and 0 or 1
+
   -- `VersionedTextDocumentIdentifier`s version may be null
   --  https://microsoft.github.io/language-server-protocol/specification#versionedTextDocumentIdentifier
   if
@@ -509,7 +514,7 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     and (
       text_document.version
       and text_document.version > 0
-      and vim.b[bufnr].changedtick > text_document.version
+      and vim.b[bufnr].changedtick > (text_document.version + version_offset)
     )
   then
     print('Buffer ', text_document.uri, ' newer than edits.')
-- 
cgit 


From 43581011e41b54473427c2e90450a4f3126b7e66 Mon Sep 17 00:00:00 2001
From: jdrouhard <john@drouhard.dev>
Date: Tue, 4 Jun 2024 10:22:02 -0500
Subject: fix(lsp): remove superfluous on_detach callback from semantic tokens
 module (#29174)

LspDetach is now triggered by the main on_detach callback that is added
when an LSP client is attached to a buffer. The semantic_tokens module
already includes a LspDetach handler that does the right thing. When the
LspDetach trigger was added to the main LSP on_detach, it created a race
condition in semantic tokens when a buffer was deleted that would
trigger both its own on_detach and the LspDetach handlers. If the former
came last, an error was thrown trying to delete a non-existent augroup
(destroy() was being called twice).
---
 runtime/lua/vim/lsp/semantic_tokens.lua | 6 ------
 1 file changed, 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 278014a4ea..b2a8360aa2 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -197,12 +197,6 @@ function STHighlighter.new(bufnr)
         highlighter:send_request()
       end
     end,
-    on_detach = function(_, buf)
-      local highlighter = STHighlighter.active[buf]
-      if highlighter then
-        highlighter:destroy()
-      end
-    end,
   })
 
   api.nvim_create_autocmd({ 'BufWinEnter', 'InsertLeave' }, {
-- 
cgit 


From 6e45cd7f0026ee33b8c397b810dcfe5b4678bbd8 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Fri, 7 Jun 2024 11:36:46 +0200
Subject: fix(lsp): revert buf_versions deprecation/replacement (#29217)

* Revert "fix(lsp): account for changedtick version gap on modified reset (#29170)"

This reverts commit 2e6d295f799c27372e5c0c44727fa613c81717fd.

* Revert "refactor(lsp): replace util.buf_versions with changedtick (#28943)"

This reverts commit 5c33815448e11b514678f39cecc74e68131d4628.
---
 runtime/lua/vim/lsp/_changetracking.lua |  3 ++-
 runtime/lua/vim/lsp/client.lua          |  5 +++--
 runtime/lua/vim/lsp/inlay_hint.lua      |  4 ++--
 runtime/lua/vim/lsp/semantic_tokens.lua |  6 +++---
 runtime/lua/vim/lsp/util.lua            | 21 +++++----------------
 5 files changed, 15 insertions(+), 24 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_changetracking.lua b/runtime/lua/vim/lsp/_changetracking.lua
index ce701f0772..b2be53269f 100644
--- a/runtime/lua/vim/lsp/_changetracking.lua
+++ b/runtime/lua/vim/lsp/_changetracking.lua
@@ -1,5 +1,6 @@
 local protocol = require('vim.lsp.protocol')
 local sync = require('vim.lsp.sync')
+local util = require('vim.lsp.util')
 
 local api = vim.api
 local uv = vim.uv
@@ -276,7 +277,7 @@ local function send_changes(bufnr, sync_kind, state, buf_state)
       client.notify(protocol.Methods.textDocument_didChange, {
         textDocument = {
           uri = uri,
-          version = vim.b[bufnr].changedtick,
+          version = util.buf_versions[bufnr],
         },
         contentChanges = changes,
       })
diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index b28fe2f797..327cd19125 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -673,8 +673,8 @@ function Client:_request(method, params, handler, bufnr)
   end
   -- Ensure pending didChange notifications are sent so that the server doesn't operate on a stale state
   changetracking.flush(self, bufnr)
+  local version = lsp.util.buf_versions[bufnr]
   bufnr = resolve_bufnr(bufnr)
-  local version = vim.b[bufnr].changedtick
   log.debug(self._log_prefix, 'client.request', self.id, method, params, handler, bufnr)
   local success, request_id = self.rpc.request(method, params, function(err, result)
     local context = {
@@ -922,13 +922,14 @@ function Client:_text_document_did_open_handler(bufnr)
 
   local params = {
     textDocument = {
-      version = vim.b[bufnr].changedtick,
+      version = 0,
       uri = vim.uri_from_bufnr(bufnr),
       languageId = self.get_language_id(bufnr, filetype),
       text = lsp._buf_get_full_text(bufnr),
     },
   }
   self.notify(ms.textDocument_didOpen, params)
+  lsp.util.buf_versions[bufnr] = params.textDocument.version
 
   -- Next chance we get, we should re-do the diagnostics
   vim.schedule(function()
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 8fd4ceefd2..2d784816cb 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -43,7 +43,7 @@ function M.on_inlayhint(err, result, ctx, _)
     return
   end
   local bufnr = assert(ctx.bufnr)
-  if vim.b[bufnr].changedtick ~= ctx.version then
+  if util.buf_versions[bufnr] ~= ctx.version then
     return
   end
   local client_id = ctx.client_id
@@ -324,7 +324,7 @@ api.nvim_set_decoration_provider(namespace, {
       return
     end
 
-    if bufstate.version ~= vim.b[bufnr].changedtick then
+    if bufstate.version ~= util.buf_versions[bufnr] then
       return
     end
 
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index b2a8360aa2..279956658c 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -116,7 +116,7 @@ local function tokens_to_ranges(data, bufnr, client, request)
 
       if elapsed_ns > yield_interval_ns then
         vim.schedule(function()
-          coroutine.resume(co, vim.b[bufnr].changedtick)
+          coroutine.resume(co, util.buf_versions[bufnr])
         end)
         if request.version ~= coroutine.yield() then
           -- request became stale since the last time the coroutine ran.
@@ -269,7 +269,7 @@ end
 ---
 ---@package
 function STHighlighter:send_request()
-  local version = vim.b[self.bufnr].changedtick
+  local version = util.buf_versions[self.bufnr]
 
   self:reset_timer()
 
@@ -412,7 +412,7 @@ end
 function STHighlighter:on_win(topline, botline)
   for client_id, state in pairs(self.client_state) do
     local current_result = state.current_result
-    if current_result.version and current_result.version == vim.b[self.bufnr].changedtick then
+    if current_result.version and current_result.version == util.buf_versions[self.bufnr] then
       if not current_result.namespace_cleared then
         api.nvim_buf_clear_namespace(self.bufnr, state.namespace, 0, -1)
         current_result.namespace_cleared = true
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 3215b40d1d..fc027cfcc0 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -502,11 +502,6 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     should_check_version = false
   end
 
-  -- changedtick increases on save but server only receives version updates
-  -- on line changes (via didChange)
-  -- This allows a gap of 1 to account for the servers outdated view
-  local version_offset = vim.b[bufnr].modified and 0 or 1
-
   -- `VersionedTextDocumentIdentifier`s version may be null
   --  https://microsoft.github.io/language-server-protocol/specification#versionedTextDocumentIdentifier
   if
@@ -514,7 +509,8 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     and (
       text_document.version
       and text_document.version > 0
-      and vim.b[bufnr].changedtick > (text_document.version + version_offset)
+      and M.buf_versions[bufnr]
+      and M.buf_versions[bufnr] > text_document.version
     )
   then
     print('Buffer ', text_document.uri, ' newer than edits.')
@@ -2206,16 +2202,9 @@ function M._refresh(method, opts)
   end
 end
 
----@nodoc
----@deprecated
----@type table<integer,integer>
-M.buf_versions = setmetatable({}, {
-  __index = function(_, bufnr)
-    vim.deprecate('vim.lsp.util.buf_versions', 'vim.b.changedtick', '0.13')
-    return vim.b[bufnr].changedtick
-  end,
-})
-
 M._get_line_byte_from_position = get_line_byte_from_position
 
+---@nodoc
+M.buf_versions = {} ---@type table<integer,integer>
+
 return M
-- 
cgit 


From 2ce4a4d91e4abee0aab8b98c47eea9fbd4849ba6 Mon Sep 17 00:00:00 2001
From: Al Colmenar <57642956+alcolmenar@users.noreply.github.com>
Date: Fri, 7 Jun 2024 02:54:43 -0700
Subject: fix(lsp): fix reverse sorting of same position text edits (#29212)

Problem:
Text edits with the same position (both line and character) were being
reverse sorted prior to being applied which differs from the lsp spec

Solution:
Change the sort order for just the same position edits
---
 runtime/lua/vim/lsp/util.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index fc027cfcc0..3d61af8b15 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -391,7 +391,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
       return a.range.start.character > b.range.start.character
     end
     if a._index ~= b._index then
-      return a._index > b._index
+      return a._index < b._index
     end
   end)
 
-- 
cgit 


From 20f22f75ee629ae2db4cd99e730fa0af26553177 Mon Sep 17 00:00:00 2001
From: Tom Praschan <13141438+tom-anders@users.noreply.github.com>
Date: Mon, 10 Jun 2024 03:14:55 +0200
Subject: feat(lsp): include end_col, end_lnum in
 vim.lsp.buf.locations_to_items #29164

---
 runtime/lua/vim/lsp/util.lua | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 3d61af8b15..088d57b6d6 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1722,7 +1722,9 @@ end)
 ---@inlinedoc
 ---@field filename string
 ---@field lnum integer 1-indexed line number
+---@field end_lnum integer 1-indexed end line number
 ---@field col integer 1-indexed column
+---@field end_col integer 1-indexed end column
 ---@field text string
 ---@field user_data lsp.Location|lsp.LocationLink
 
@@ -1749,7 +1751,7 @@ function M.locations_to_items(locations, offset_encoding)
   end
 
   local items = {}
-  ---@type table<string, {start: lsp.Position, location: lsp.Location|lsp.LocationLink}[]>
+  ---@type table<string, {start: lsp.Position, end: lsp.Position, location: lsp.Location|lsp.LocationLink}[]>
   local grouped = setmetatable({}, {
     __index = function(t, k)
       local v = {}
@@ -1761,7 +1763,7 @@ function M.locations_to_items(locations, offset_encoding)
     -- locations may be Location or LocationLink
     local uri = d.uri or d.targetUri
     local range = d.range or d.targetSelectionRange
-    table.insert(grouped[uri], { start = range.start, location = d })
+    table.insert(grouped[uri], { start = range.start, ['end'] = range['end'], location = d })
   end
 
   ---@type string[]
@@ -1776,6 +1778,9 @@ function M.locations_to_items(locations, offset_encoding)
     local line_numbers = {}
     for _, temp in ipairs(rows) do
       table.insert(line_numbers, temp.start.line)
+      if temp.start.line ~= temp['end'].line then
+        table.insert(line_numbers, temp['end'].line)
+      end
     end
 
     -- get all the lines for this uri
@@ -1783,13 +1788,18 @@ function M.locations_to_items(locations, offset_encoding)
 
     for _, temp in ipairs(rows) do
       local pos = temp.start
+      local end_pos = temp['end']
       local row = pos.line
+      local end_row = end_pos.line
       local line = lines[row] or ''
       local col = M._str_byteindex_enc(line, pos.character, offset_encoding)
+      local end_col = M._str_byteindex_enc(lines[end_row] or '', end_pos.character, offset_encoding)
       table.insert(items, {
         filename = filename,
         lnum = row + 1,
+        end_lnum = end_row + 1,
         col = col + 1,
+        end_col = end_col + 1,
         text = line,
         user_data = temp.location,
       })
-- 
cgit 


From 5e49ef0af3cb8dba658e5d0dc6a807f8edebf590 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 11 Jun 2024 12:05:18 +0100
Subject: refactor(lua): improve type annotations

---
 runtime/lua/vim/lsp/_dynamic.lua        |   4 -
 runtime/lua/vim/lsp/client.lua          |  11 +-
 runtime/lua/vim/lsp/handlers.lua        |   1 +
 runtime/lua/vim/lsp/log.lua             |   2 +-
 runtime/lua/vim/lsp/protocol.lua        | 342 ++------------------------------
 runtime/lua/vim/lsp/rpc.lua             |   4 +-
 runtime/lua/vim/lsp/semantic_tokens.lua |   1 -
 runtime/lua/vim/lsp/util.lua            |  21 +-
 8 files changed, 33 insertions(+), 353 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_dynamic.lua b/runtime/lua/vim/lsp/_dynamic.lua
index 819b03a63a..27113c0e74 100644
--- a/runtime/lua/vim/lsp/_dynamic.lua
+++ b/runtime/lua/vim/lsp/_dynamic.lua
@@ -24,7 +24,6 @@ function M:supports_registration(method)
 end
 
 --- @param registrations lsp.Registration[]
---- @package
 function M:register(registrations)
   -- remove duplicates
   self:unregister(registrations)
@@ -38,7 +37,6 @@ function M:register(registrations)
 end
 
 --- @param unregisterations lsp.Unregistration[]
---- @package
 function M:unregister(unregisterations)
   for _, unreg in ipairs(unregisterations) do
     local method = unreg.method
@@ -58,7 +56,6 @@ end
 --- @param method string
 --- @param opts? {bufnr: integer?}
 --- @return lsp.Registration? (table|nil) the registration if found
---- @package
 function M:get(method, opts)
   opts = opts or {}
   opts.bufnr = opts.bufnr or vim.api.nvim_get_current_buf()
@@ -78,7 +75,6 @@ end
 
 --- @param method string
 --- @param opts? {bufnr: integer?}
---- @package
 function M:supports(method, opts)
   return self:get(method, opts) ~= nil
 end
diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index 327cd19125..d3ff918792 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -436,7 +436,7 @@ local function ensure_list(x)
   return { x }
 end
 
---- @package
+--- @nodoc
 --- @param config vim.lsp.ClientConfig
 --- @return vim.lsp.Client?
 function Client.create(config)
@@ -535,7 +535,7 @@ function Client:_run_callbacks(cbs, error_id, ...)
   end
 end
 
---- @package
+--- @nodoc
 function Client:initialize()
   local config = self.config
 
@@ -656,7 +656,7 @@ end
 --- @param method string LSP method name.
 --- @param params? table LSP request params.
 --- @param handler? lsp.Handler Response |lsp-handler| for this method.
---- @param bufnr? integer Buffer handle (0 for current).
+--- @param bufnr integer Buffer handle (0 for current).
 --- @return boolean status, integer? request_id {status} is a bool indicating
 --- whether the request was successful. If it is `false`, then it will
 --- always be `false` (the client has shutdown). If it was
@@ -861,7 +861,6 @@ function Client:_is_stopped()
   return self.rpc.is_closing()
 end
 
---- @package
 --- Execute a lsp command, either via client command function (if available)
 --- or via workspace/executeCommand (if supported by the server)
 ---
@@ -906,7 +905,6 @@ function Client:_exec_cmd(command, context, handler, on_unsupported)
   self.request(ms.workspace_executeCommand, params, handler, context.bufnr)
 end
 
---- @package
 --- Default handler for the 'textDocument/didOpen' LSP notification.
 ---
 --- @param bufnr integer Number of the buffer, or 0 for current
@@ -942,7 +940,6 @@ function Client:_text_document_did_open_handler(bufnr)
   end)
 end
 
---- @package
 --- Runs the on_attach function from the client's config if it was defined.
 --- @param bufnr integer Buffer number
 function Client:_on_attach(bufnr)
@@ -1065,7 +1062,6 @@ function Client:_on_exit(code, signal)
   )
 end
 
---- @package
 --- Add a directory to the workspace folders.
 --- @param dir string?
 function Client:_add_workspace_folder(dir)
@@ -1088,7 +1084,6 @@ function Client:_add_workspace_folder(dir)
   vim.list_extend(self.workspace_folders, wf)
 end
 
---- @package
 --- Remove a directory to the workspace folders.
 --- @param dir string?
 function Client:_remove_workspace_folder(dir)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 38c43893eb..44548fec92 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -646,6 +646,7 @@ M[ms.window_showMessage] = function(_, result, ctx, _)
   if message_type == protocol.MessageType.Error then
     err_message('LSP[', client_name, '] ', message)
   else
+    --- @type string
     local message_type_name = protocol.MessageType[message_type]
     api.nvim_out_write(string.format('LSP[%s][%s] %s\n', client_name, message_type_name, message))
   end
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 9f2bd71158..0438ca84af 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -9,7 +9,7 @@ local log_levels = vim.log.levels
 --- Can be used to lookup the number from the name or the name from the number.
 --- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
 --- Level numbers begin with "TRACE" at 0
---- @type table<string|integer, string|integer>
+--- @type table<string,integer> | table<integer, string>
 --- @nodoc
 log.levels = vim.deepcopy(log_levels)
 
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 8ac4cc794b..eb18043843 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -12,9 +12,6 @@ end
 
 local sysname = vim.uv.os_uname().sysname
 
--- Protocol for the Microsoft Language Server Protocol (mslsp)
-local protocol = {}
-
 local constants = {
   --- @enum lsp.DiagnosticSeverity
   DiagnosticSeverity = {
@@ -46,6 +43,8 @@ local constants = {
     Info = 3,
     -- A log message.
     Log = 4,
+    -- A debug message.
+    Debug = 5,
   },
 
   -- The file event type.
@@ -308,326 +307,18 @@ local constants = {
   },
 }
 
-for k1, v1 in pairs(constants) do
-  local tbl = vim.deepcopy(v1, true)
-  for _, k2 in ipairs(vim.tbl_keys(tbl)) do
-    local v2 = tbl[k2]
-    tbl[v2] = k2
+-- Protocol for the Microsoft Language Server Protocol (mslsp)
+local protocol = {}
+
+--- @diagnostic disable:no-unknown
+for k1, v1 in pairs(vim.deepcopy(constants, true)) do
+  for _, k2 in ipairs(vim.tbl_keys(v1)) do
+    local v2 = v1[k2]
+    v1[v2] = k2
   end
-  protocol[k1] = tbl
+  protocol[k1] = v1
 end
-
---[=[
---Text document specific client capabilities.
-export interface TextDocumentClientCapabilities {
-  synchronization?: {
-    --Whether text document synchronization supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports sending will save notifications.
-    willSave?: boolean;
-    --The client supports sending a will save request and
-    --waits for a response providing text edits which will
-    --be applied to the document before it is saved.
-    willSaveWaitUntil?: boolean;
-    --The client supports did save notifications.
-    didSave?: boolean;
-  }
-  --Capabilities specific to the `textDocument/completion`
-  completion?: {
-    --Whether completion supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports the following `CompletionItem` specific
-    --capabilities.
-    completionItem?: {
-      --The client supports snippets as insert text.
-      --
-      --A snippet can define tab stops and placeholders with `$1`, `$2`
-      --and `${3:foo}`. `$0` defines the final tab stop, it defaults to
-      --the end of the snippet. Placeholders with equal identifiers are linked,
-      --that is typing in one will update others too.
-      snippetSupport?: boolean;
-      --The client supports commit characters on a completion item.
-      commitCharactersSupport?: boolean
-      --The client supports the following content formats for the documentation
-      --property. The order describes the preferred format of the client.
-      documentationFormat?: MarkupKind[];
-      --The client supports the deprecated property on a completion item.
-      deprecatedSupport?: boolean;
-      --The client supports the preselect property on a completion item.
-      preselectSupport?: boolean;
-    }
-    completionItemKind?: {
-      --The completion item kind values the client supports. When this
-      --property exists the client also guarantees that it will
-      --handle values outside its set gracefully and falls back
-      --to a default value when unknown.
-      --
-      --If this property is not present the client only supports
-      --the completion items kinds from `Text` to `Reference` as defined in
-      --the initial version of the protocol.
-      valueSet?: CompletionItemKind[];
-    },
-    --The client supports to send additional context information for a
-    --`textDocument/completion` request.
-    contextSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/hover`
-  hover?: {
-    --Whether hover supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports the follow content formats for the content
-    --property. The order describes the preferred format of the client.
-    contentFormat?: MarkupKind[];
-  };
-  --Capabilities specific to the `textDocument/signatureHelp`
-  signatureHelp?: {
-    --Whether signature help supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports the following `SignatureInformation`
-    --specific properties.
-    signatureInformation?: {
-      --The client supports the follow content formats for the documentation
-      --property. The order describes the preferred format of the client.
-      documentationFormat?: MarkupKind[];
-      --Client capabilities specific to parameter information.
-      parameterInformation?: {
-        --The client supports processing label offsets instead of a
-        --simple label string.
-        --
-        --Since 3.14.0
-        labelOffsetSupport?: boolean;
-      }
-    };
-  };
-  --Capabilities specific to the `textDocument/references`
-  references?: {
-    --Whether references supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/documentHighlight`
-  documentHighlight?: {
-    --Whether document highlight supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/documentSymbol`
-  documentSymbol?: {
-    --Whether document symbol supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --Specific capabilities for the `SymbolKind`.
-    symbolKind?: {
-      --The symbol kind values the client supports. When this
-      --property exists the client also guarantees that it will
-      --handle values outside its set gracefully and falls back
-      --to a default value when unknown.
-      --
-      --If this property is not present the client only supports
-      --the symbol kinds from `File` to `Array` as defined in
-      --the initial version of the protocol.
-      valueSet?: SymbolKind[];
-    }
-    --The client supports hierarchical document symbols.
-    hierarchicalDocumentSymbolSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/formatting`
-  formatting?: {
-    --Whether formatting supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/rangeFormatting`
-  rangeFormatting?: {
-    --Whether range formatting supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/onTypeFormatting`
-  onTypeFormatting?: {
-    --Whether on type formatting supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/declaration`
-  declaration?: {
-    --Whether declaration supports dynamic registration. If this is set to `true`
-    --the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-    --return value for the corresponding server capability as well.
-    dynamicRegistration?: boolean;
-    --The client supports additional metadata in the form of declaration links.
-    --
-    --Since 3.14.0
-    linkSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/definition`.
-  --
-  --Since 3.14.0
-  definition?: {
-    --Whether definition supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports additional metadata in the form of definition links.
-    linkSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/typeDefinition`
-  --
-  --Since 3.6.0
-  typeDefinition?: {
-    --Whether typeDefinition supports dynamic registration. If this is set to `true`
-    --the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-    --return value for the corresponding server capability as well.
-    dynamicRegistration?: boolean;
-    --The client supports additional metadata in the form of definition links.
-    --
-    --Since 3.14.0
-    linkSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/implementation`.
-  --
-  --Since 3.6.0
-  implementation?: {
-    --Whether implementation supports dynamic registration. If this is set to `true`
-    --the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-    --return value for the corresponding server capability as well.
-    dynamicRegistration?: boolean;
-    --The client supports additional metadata in the form of definition links.
-    --
-    --Since 3.14.0
-    linkSupport?: boolean;
-  };
-  --Capabilities specific to the `textDocument/codeAction`
-  codeAction?: {
-    --Whether code action supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client support code action literals as a valid
-    --response of the `textDocument/codeAction` request.
-    --
-    --Since 3.8.0
-    codeActionLiteralSupport?: {
-      --The code action kind is support with the following value
-      --set.
-      codeActionKind: {
-        --The code action kind values the client supports. When this
-        --property exists the client also guarantees that it will
-        --handle values outside its set gracefully and falls back
-        --to a default value when unknown.
-        valueSet: CodeActionKind[];
-      };
-    };
-  };
-  --Capabilities specific to the `textDocument/codeLens`
-  codeLens?: {
-    --Whether code lens supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/documentLink`
-  documentLink?: {
-    --Whether document link supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `textDocument/documentColor` and the
-  --`textDocument/colorPresentation` request.
-  --
-  --Since 3.6.0
-  colorProvider?: {
-    --Whether colorProvider supports dynamic registration. If this is set to `true`
-    --the client supports the new `(ColorProviderOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-    --return value for the corresponding server capability as well.
-    dynamicRegistration?: boolean;
-  }
-  --Capabilities specific to the `textDocument/rename`
-  rename?: {
-    --Whether rename supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --The client supports testing for validity of rename operations
-    --before execution.
-    prepareSupport?: boolean;
-  };
-  --Capabilities specific to `textDocument/publishDiagnostics`.
-  publishDiagnostics?: {
-    --Whether the clients accepts diagnostics with related information.
-    relatedInformation?: boolean;
-    --Client supports the tag property to provide meta data about a diagnostic.
-	  --Clients supporting tags have to handle unknown tags gracefully.
-    --Since 3.15.0
-    tagSupport?: {
-      --The tags supported by this client
-      valueSet: DiagnosticTag[];
-    };
-  };
-  --Capabilities specific to `textDocument/foldingRange` requests.
-  --
-  --Since 3.10.0
-  foldingRange?: {
-    --Whether implementation supports dynamic registration for folding range providers. If this is set to `true`
-    --the client supports the new `(FoldingRangeProviderOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-    --return value for the corresponding server capability as well.
-    dynamicRegistration?: boolean;
-    --The maximum number of folding ranges that the client prefers to receive per document. The value serves as a
-    --hint, servers are free to follow the limit.
-    rangeLimit?: number;
-    --If set, the client signals that it only supports folding complete lines. If set, client will
-    --ignore specified `startCharacter` and `endCharacter` properties in a FoldingRange.
-    lineFoldingOnly?: boolean;
-  };
-}
---]=]
-
---[=[
---Workspace specific client capabilities.
-export interface WorkspaceClientCapabilities {
-  --The client supports applying batch edits to the workspace by supporting
-  --the request 'workspace/applyEdit'
-  applyEdit?: boolean;
-  --Capabilities specific to `WorkspaceEdit`s
-  workspaceEdit?: {
-    --The client supports versioned document changes in `WorkspaceEdit`s
-    documentChanges?: boolean;
-    --The resource operations the client supports. Clients should at least
-    --support 'create', 'rename' and 'delete' files and folders.
-    resourceOperations?: ResourceOperationKind[];
-    --The failure handling strategy of a client if applying the workspace edit
-    --fails.
-    failureHandling?: FailureHandlingKind;
-  };
-  --Capabilities specific to the `workspace/didChangeConfiguration` notification.
-  didChangeConfiguration?: {
-    --Did change configuration notification supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
-  didChangeWatchedFiles?: {
-    --Did change watched files notification supports dynamic registration. Please note
-    --that the current protocol doesn't support static configuration for file changes
-    --from the server side.
-    dynamicRegistration?: boolean;
-  };
-  --Capabilities specific to the `workspace/symbol` request.
-  symbol?: {
-    --Symbol request supports dynamic registration.
-    dynamicRegistration?: boolean;
-    --Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
-    symbolKind?: {
-      --The symbol kind values the client supports. When this
-      --property exists the client also guarantees that it will
-      --handle values outside its set gracefully and falls back
-      --to a default value when unknown.
-      --
-      --If this property is not present the client only supports
-      --the symbol kinds from `File` to `Array` as defined in
-      --the initial version of the protocol.
-      valueSet?: SymbolKind[];
-    }
-  };
-  --Capabilities specific to the `workspace/executeCommand` request.
-  executeCommand?: {
-    --Execute command supports dynamic registration.
-    dynamicRegistration?: boolean;
-  };
-  --The client has support for workspace folders.
-  --
-  --Since 3.6.0
-  workspaceFolders?: boolean;
-  --The client supports `workspace/configuration` requests.
-  --
-  --Since 3.6.0
-  configuration?: boolean;
-}
---]=]
+--- @diagnostic enable:no-unknown
 
 --- Gets a new ClientCapabilities object describing the LSP client
 --- capabilities.
@@ -1250,14 +941,5 @@ protocol.Methods = {
   --- The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
   workspace_workspaceFolders = 'workspace/workspaceFolders',
 }
-local function freeze(t)
-  return setmetatable({}, {
-    __index = t,
-    __newindex = function()
-      error('cannot modify immutable table')
-    end,
-  })
-end
-protocol.Methods = freeze(protocol.Methods)
 
 return protocol
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 3c63a12da2..5e2b041a0a 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -140,7 +140,7 @@ local client_errors = {
   SERVER_RESULT_CALLBACK_ERROR = 7,
 }
 
---- @type table<string|integer, string|integer>
+--- @type table<string,integer> | table<integer,string>
 --- @nodoc
 M.client_errors = vim.deepcopy(client_errors)
 for k, v in pairs(client_errors) do
@@ -502,7 +502,7 @@ function Client:handle_body(body)
       if decoded.error then
         decoded.error = setmetatable(decoded.error, {
           __tostring = M.format_rpc_error,
-        }) --- @type table
+        })
       end
       self:try_call(
         M.client_errors.SERVER_RESULT_CALLBACK_ERROR,
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 279956658c..f92c0eb2e6 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -773,7 +773,6 @@ function M.highlight_token(token, bufnr, client_id, hl_group, opts)
   })
 end
 
---- @package
 --- |lsp-handler| for the method `workspace/semanticTokens/refresh`
 ---
 --- Refresh requests are sent by the server to indicate a project-wide change
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 088d57b6d6..ae6de591b3 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -238,6 +238,7 @@ end
 ---@param rows integer[] zero-indexed line numbers
 ---@return table<integer, string>|string a table mapping rows to lines
 local function get_lines(bufnr, rows)
+  --- @type integer[]
   rows = type(rows) == 'table' and rows or { rows }
 
   -- This is needed for bufload and bufloaded
@@ -246,7 +247,7 @@ local function get_lines(bufnr, rows)
   end
 
   local function buf_lines()
-    local lines = {}
+    local lines = {} --- @type table<integer,string>
     for _, row in ipairs(rows) do
       lines[row] = (api.nvim_buf_get_lines(bufnr, row, row + 1, false) or { '' })[1]
     end
@@ -274,11 +275,11 @@ local function get_lines(bufnr, rows)
   if not fd then
     return ''
   end
-  local stat = uv.fs_fstat(fd)
-  local data = uv.fs_read(fd, stat.size, 0)
+  local stat = assert(uv.fs_fstat(fd))
+  local data = assert(uv.fs_read(fd, stat.size, 0))
   uv.fs_close(fd)
 
-  local lines = {} -- rows we need to retrieve
+  local lines = {} --- @type table<integer,true|string> rows we need to retrieve
   local need = 0 -- keep track of how many unique rows we need
   for _, row in pairs(rows) do
     if not lines[row] then
@@ -307,7 +308,7 @@ local function get_lines(bufnr, rows)
       lines[i] = ''
     end
   end
-  return lines
+  return lines --[[@as table<integer,string>]]
 end
 
 --- Gets the zero-indexed line from the given buffer.
@@ -322,7 +323,8 @@ local function get_line(bufnr, row)
 end
 
 --- Position is a https://microsoft.github.io/language-server-protocol/specifications/specification-current/#position
----@param offset_encoding string|nil utf-8|utf-16|utf-32
+---@param position lsp.Position
+---@param offset_encoding? string utf-8|utf-16|utf-32
 ---@return integer
 local function get_line_byte_from_position(bufnr, position, offset_encoding)
   -- LSP's line and characters are 0-indexed
@@ -366,6 +368,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
 
   -- Fix reversed range and indexing each text_edits
   local index = 0
+  --- @param text_edit lsp.TextEdit
   text_edits = vim.tbl_map(function(text_edit)
     index = index + 1
     text_edit._index = index
@@ -383,6 +386,9 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
   end, text_edits)
 
   -- Sort text_edits
+  ---@param a lsp.TextEdit | { _index: integer }
+  ---@param b lsp.TextEdit | { _index: integer }
+  ---@return boolean
   table.sort(text_edits, function(a, b)
     if a.range.start.line ~= b.range.start.line then
       return a.range.start.line > b.range.start.line
@@ -393,10 +399,11 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
     if a._index ~= b._index then
       return a._index < b._index
     end
+    return false
   end)
 
   -- save and restore local marks since they get deleted by nvim_buf_set_lines
-  local marks = {}
+  local marks = {} --- @type table<string,[integer,integer]>
   for _, m in pairs(vim.fn.getmarklist(bufnr)) do
     if m.mark:match("^'[a-z]$") then
       marks[m.mark:sub(2, 2)] = { m.pos[2], m.pos[3] - 1 } -- api-indexed
-- 
cgit 


From 81b372fecd749d350fbd86be1f65146b2df97b70 Mon Sep 17 00:00:00 2001
From: Tama McGlinn <t.mcglinn@gmail.com>
Date: Fri, 14 Jun 2024 11:02:36 +0200
Subject: fix(lsp): check for nil response from server (#29196)

this only changes the error message, so that it is clear that
the error is with the LSP server, rather than being a crash inside
nvim runtime scripts. We are already doing a lot of validation,
it's just that nil was being overlooked here.

This fixes issue #27395
---
 runtime/lua/vim/lsp/rpc.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 5e2b041a0a..7acb67b25e 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -407,7 +407,9 @@ function Client:handle_body(body)
   end
   log.debug('rpc.receive', decoded)
 
-  if type(decoded.method) == 'string' and decoded.id then
+  if type(decoded) ~= 'table' then
+    self:on_error(M.client_errors.INVALID_SERVER_MESSAGE, decoded)
+  elseif type(decoded.method) == 'string' and decoded.id then
     local err --- @type lsp.ResponseError|nil
     -- Schedule here so that the users functions don't trigger an error and
     -- we can still use the result.
-- 
cgit 


From 0a9c81d70964f905112857900fbaa6aae590a96d Mon Sep 17 00:00:00 2001
From: Ilia Choly <ilia.choly@gmail.com>
Date: Fri, 14 Jun 2024 05:03:58 -0400
Subject: refactor(lsp): use metatable for buf_versions (#29304)

This reduces the number of nil checks around buf_versions usage
Test changes were lifted from 5c33815

Co-authored-by: Mathias Fussenegger <f.mathias@zignar.net>
---
 runtime/lua/vim/lsp/client.lua          | 10 ++++------
 runtime/lua/vim/lsp/semantic_tokens.lua |  2 +-
 runtime/lua/vim/lsp/util.lua            |  8 ++++++--
 3 files changed, 11 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index d3ff918792..8cdfdd4b90 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -916,18 +916,16 @@ function Client:_text_document_did_open_handler(bufnr)
   if not api.nvim_buf_is_loaded(bufnr) then
     return
   end
-  local filetype = vim.bo[bufnr].filetype
 
-  local params = {
+  local filetype = vim.bo[bufnr].filetype
+  self.notify(ms.textDocument_didOpen, {
     textDocument = {
-      version = 0,
+      version = lsp.util.buf_versions[bufnr],
       uri = vim.uri_from_bufnr(bufnr),
       languageId = self.get_language_id(bufnr, filetype),
       text = lsp._buf_get_full_text(bufnr),
     },
-  }
-  self.notify(ms.textDocument_didOpen, params)
-  lsp.util.buf_versions[bufnr] = params.textDocument.version
+  })
 
   -- Next chance we get, we should re-do the diagnostics
   vim.schedule(function()
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index f92c0eb2e6..2ae86851d1 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -412,7 +412,7 @@ end
 function STHighlighter:on_win(topline, botline)
   for client_id, state in pairs(self.client_state) do
     local current_result = state.current_result
-    if current_result.version and current_result.version == util.buf_versions[self.bufnr] then
+    if current_result.version == util.buf_versions[self.bufnr] then
       if not current_result.namespace_cleared then
         api.nvim_buf_clear_namespace(self.bufnr, state.namespace, 0, -1)
         current_result.namespace_cleared = true
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index ae6de591b3..a5cf13ed0f 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -516,7 +516,6 @@ function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
     and (
       text_document.version
       and text_document.version > 0
-      and M.buf_versions[bufnr]
       and M.buf_versions[bufnr] > text_document.version
     )
   then
@@ -2222,6 +2221,11 @@ end
 M._get_line_byte_from_position = get_line_byte_from_position
 
 ---@nodoc
-M.buf_versions = {} ---@type table<integer,integer>
+---@type table<integer,integer>
+M.buf_versions = setmetatable({}, {
+  __index = function(t, bufnr)
+    return rawget(t, bufnr) or 0
+  end,
+})
 
 return M
-- 
cgit 


From aa47af7e69bb32c4486510dce27f45d9028e0a6c Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Fri, 14 Jun 2024 19:32:34 +0200
Subject: fix(lsp): tune completion word extraction for decorated labels
 (#29331)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:

For snippets lsp.completion prefers the label if it is shorter than the
insertText or textEdit to support postfix completion cases but clangd
adds decoration characters to labels. E.g.: `•INT16_C(c)`

Solution:

Use parse_snippet on insertText/textEdit before checking if it is
shorter than the label.

Fixes https://github.com/neovim/neovim/issues/29301
---
 runtime/lua/vim/lsp/completion.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 4b7deabf41..2e6d82b367 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -145,8 +145,8 @@ local function get_completion_word(item)
       --    label: insert
       --
       -- Typing `i` would remove the candidate because newText starts with `t`.
-      local text = item.insertText or item.textEdit.newText
-      return #text < #item.label and text or item.label
+      local text = parse_snippet(item.insertText or item.textEdit.newText)
+      return #text < #item.label and vim.fn.matchstr(text, '\\k*') or item.label
     elseif item.insertText and item.insertText ~= '' then
       return parse_snippet(item.insertText)
     else
-- 
cgit 


From 6e28589e00a32045d5a62654151299802e40fdb0 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sat, 15 Jun 2024 01:04:27 +0200
Subject: docs: misc (#29229)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Ilia Choly <ilia.choly@gmail.com>
Co-authored-by: Jose Pedro Oliveira <jose.p.oliveira.oss@gmail.com>
Co-authored-by: Maria José Solano <majosolano99@gmail.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>
---
 runtime/lua/vim/lsp/inlay_hint.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 2d784816cb..aa84294cc4 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -370,7 +370,7 @@ api.nvim_set_decoration_provider(namespace, {
 })
 
 --- Query whether inlay hint is enabled in the {filter}ed scope
---- @param filter vim.lsp.inlay_hint.enable.Filter
+--- @param filter? vim.lsp.inlay_hint.enable.Filter
 --- @return boolean
 --- @since 12
 function M.is_enabled(filter)
-- 
cgit 


From 5581a95534e44b8714e715c925c9de2d95ae1c21 Mon Sep 17 00:00:00 2001
From: Tom Praschan <13141438+tom-anders@users.noreply.github.com>
Date: Mon, 24 Jun 2024 16:54:56 +0200
Subject: feat(lsp): vim.lsp.buf.format() supports
 textDocument/rangesFormatting #27323

While this relies on a proposed LSP 3.18 feature, it's fully backwards
compatible, so IMO there's no harm in adding this already.

Looks like some servers already support for this e.g.
- gopls: https://go-review.googlesource.com/c/tools/+/510235
- clangd: https://github.com/llvm/llvm-project/pull/80180

Fixes #27293
---
 runtime/lua/vim/lsp/buf.lua      | 28 ++++++++++++++++++++++------
 runtime/lua/vim/lsp/protocol.lua |  1 +
 2 files changed, 23 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 299b68e134..f20730b8e6 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -205,9 +205,11 @@ end
 --- Range to format.
 --- Table must contain `start` and `end` keys with {row,col} tuples using
 --- (1,0) indexing.
+--- Can also be a list of tables that contain `start` and `end` keys as described above,
+--- in which case `textDocument/rangesFormatting` support is required.
 --- (Default: current selection in visual mode, `nil` in other modes,
 --- formatting the full buffer)
---- @field range? {start:integer[],end:integer[]}
+--- @field range? {start:[integer,integer],end:[integer, integer]}|{start:[integer,integer],end:[integer,integer]}[]
 
 --- Formats a buffer using the attached (and optionally filtered) language
 --- server clients.
@@ -218,10 +220,20 @@ function M.format(opts)
   local bufnr = opts.bufnr or api.nvim_get_current_buf()
   local mode = api.nvim_get_mode().mode
   local range = opts.range
+  -- Try to use visual selection if no range is given
   if not range and mode == 'v' or mode == 'V' then
     range = range_from_selection(bufnr, mode)
   end
-  local method = range and ms.textDocument_rangeFormatting or ms.textDocument_formatting
+
+  local passed_multiple_ranges = (range and #range ~= 0 and type(range[1]) == 'table')
+  local method ---@type string
+  if passed_multiple_ranges then
+    method = ms.textDocument_rangesFormatting
+  elseif range then
+    method = ms.textDocument_rangeFormatting
+  else
+    method = ms.textDocument_formatting
+  end
 
   local clients = vim.lsp.get_clients({
     id = opts.id,
@@ -241,10 +253,14 @@ function M.format(opts)
   --- @param params lsp.DocumentFormattingParams
   --- @return lsp.DocumentFormattingParams
   local function set_range(client, params)
-    if range then
-      local range_params =
-        util.make_given_range_params(range.start, range['end'], bufnr, client.offset_encoding)
-      params.range = range_params.range
+    local to_lsp_range = function(r) ---@return lsp.DocumentRangeFormattingParams|lsp.DocumentRangesFormattingParams
+      return util.make_given_range_params(r.start, r['end'], bufnr, client.offset_encoding).range
+    end
+
+    if passed_multiple_ranges then
+      params.ranges = vim.tbl_map(to_lsp_range, range)
+    elseif range then
+      params.range = to_lsp_range(range)
     end
     return params
   end
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index eb18043843..656921644d 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -425,6 +425,7 @@ function protocol.make_client_capabilities()
       },
       rangeFormatting = {
         dynamicRegistration = true,
+        rangesSupport = true,
       },
       completion = {
         dynamicRegistration = false,
-- 
cgit 


From 724d1110b1e4699a34f489e9cdb2d25098746499 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 27 Jun 2024 12:20:00 +0200
Subject: fix(lsp): pre-filter matches on label if filterText is missing
 (#29491)

Although the built-in pum completion mechanism will filter anyway on the
next input it is odd if the initial popup shows entries which don't
match the current prefix.

Using fuzzy match on the label/prefix is compatible with
`completeopt+=fuzzy` and also doesn't seem to break postfix snippet
cases

Closes https://github.com/neovim/neovim/issues/29287
---
 runtime/lua/vim/lsp/completion.lua | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 2e6d82b367..b935c48d3c 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -235,14 +235,20 @@ function M._lsp_to_complete_items(result, prefix, client_id)
     return {}
   end
 
-  local matches = prefix == '' and function()
-    return true
-  end or function(item)
-    if item.filterText then
-      return next(vim.fn.matchfuzzy({ item.filterText }, prefix))
+  ---@type fun(item: lsp.CompletionItem):boolean
+  local matches
+  if prefix == '' then
+    matches = function(_)
+      return true
+    end
+  else
+    ---@param item lsp.CompletionItem
+    matches = function(item)
+      local text = item.filterText or item.label
+      return next(vim.fn.matchfuzzy({ text }, prefix)) ~= nil
     end
-    return true
   end
+
   local candidates = {}
   for _, item in ipairs(items) do
     if matches(item) then
-- 
cgit 


From aa6b9c677d83d76d448c3bb0973bf8d14bfdf922 Mon Sep 17 00:00:00 2001
From: dundargoc <gocdundar@gmail.com>
Date: Sat, 8 Jun 2024 21:40:18 +0200
Subject: refactor: use `vim._with` where possible

This mostly means replacing `nvim_buf_call` and `nvim_win_call` with
`vim._with`.
---
 runtime/lua/vim/lsp/util.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index a5cf13ed0f..b0fd25af3a 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -640,7 +640,7 @@ function M.rename(old_fname, new_fname, opts)
     -- Rename with :saveas. This does two things:
     -- * Unset BF_WRITE_MASK, so that users don't get E13 when they do :write.
     -- * Send didClose and didOpen via textDocument/didSave handler.
-    api.nvim_buf_call(b, function()
+    vim._with({ buf = b }, function()
       vim.cmd('keepalt saveas! ' .. vim.fn.fnameescape(rename.to))
     end)
     -- Delete the new buffer with the old name created by :saveas. nvim_buf_delete and
@@ -1014,7 +1014,7 @@ function M.show_document(location, offset_encoding, opts)
     local row = range.start.line
     local col = get_line_byte_from_position(bufnr, range.start, offset_encoding)
     api.nvim_win_set_cursor(win, { row + 1, col })
-    api.nvim_win_call(win, function()
+    vim._with({ win = win }, function()
       -- Open folds under the cursor
       vim.cmd('normal! zv')
     end)
@@ -1334,7 +1334,7 @@ function M.stylize_markdown(bufnr, contents, opts)
   end
 
   -- needs to run in the buffer for the regions to work
-  api.nvim_buf_call(bufnr, function()
+  vim._with({ buf = bufnr }, function()
     -- we need to apply lsp_markdown regions speperately, since otherwise
     -- markdown regions can "bleed" through the other syntax regions
     -- and mess up the formatting
-- 
cgit 


From aec7f1979ada1b34cfb3d8fd33769232d0323ea8 Mon Sep 17 00:00:00 2001
From: Sebastian Lyng Johansen <sebastian@lyngjohansen.com>
Date: Tue, 2 Jul 2024 18:27:51 +0200
Subject: fix(lsp): fallback to `label` for completion items if all others are
 missing (#29522)

---
 runtime/lua/vim/lsp/completion.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index b935c48d3c..1078e3eb7e 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -176,7 +176,7 @@ local function apply_defaults(item, defaults)
   if defaults.editRange then
     local textEdit = item.textEdit or {}
     item.textEdit = textEdit
-    textEdit.newText = textEdit.newText or item.textEditText or item.insertText
+    textEdit.newText = textEdit.newText or item.textEditText or item.insertText or item.label
     if defaults.editRange.start then
       textEdit.range = textEdit.range or defaults.editRange
     elseif defaults.editRange.insert then
-- 
cgit 


From 55e4301036bb938474fc9768c41e28df867d9286 Mon Sep 17 00:00:00 2001
From: Andreas Schneider <asn@cryptomilk.org>
Date: Sat, 6 Jul 2024 11:44:19 +0200
Subject: feat(lsp): drop fswatch, use inotifywait (#29374)

This patch replaces fswatch with inotifywait from inotify-toools:

https://github.com/inotify-tools/inotify-tools

fswatch takes ~1min to set up recursively for the Samba source code
directory. inotifywait needs less than a second to do the same thing.

https://github.com/emcrisostomo/fswatch/issues/321

Also it fswatch seems to be unmaintained in the meantime.

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
---
 runtime/lua/vim/lsp/_watchfiles.lua | 4 ++--
 runtime/lua/vim/lsp/health.lua      | 6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 49328fbe9b..98e9818bcd 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -9,8 +9,8 @@ local M = {}
 
 if vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1 then
   M._watchfunc = watch.watch
-elseif vim.fn.executable('fswatch') == 1 then
-  M._watchfunc = watch.fswatch
+elseif vim.fn.executable('inotifywait') == 1 then
+  M._watchfunc = watch.inotify
 else
   M._watchfunc = watch.watchdirs
 end
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index ffe595ab37..18066a84db 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -90,8 +90,8 @@ local function check_watcher()
     watchfunc_name = 'libuv-watch'
   elseif watchfunc == vim._watch.watchdirs then
     watchfunc_name = 'libuv-watchdirs'
-  elseif watchfunc == vim._watch.fswatch then
-    watchfunc_name = 'fswatch'
+  elseif watchfunc == vim._watch.inotifywait then
+    watchfunc_name = 'inotifywait'
   else
     local nm = debug.getinfo(watchfunc, 'S').source
     watchfunc_name = string.format('Custom (%s)', nm)
@@ -99,7 +99,7 @@ local function check_watcher()
 
   report_info('File watch backend: ' .. watchfunc_name)
   if watchfunc_name == 'libuv-watchdirs' then
-    report_warn('libuv-watchdirs has known performance issues. Consider installing fswatch.')
+    report_warn('libuv-watchdirs has known performance issues. Consider installing inotify-tools.')
   end
 end
 
-- 
cgit 


From 1f2f460b4a77a8ff58872e03c071b5d0d882dd44 Mon Sep 17 00:00:00 2001
From: Riley Bruins <ribru17@hotmail.com>
Date: Tue, 16 Jul 2024 10:48:54 -0700
Subject: fix(lsp): don't show codelens for buffers that don't support it
 (#29690)

---
 runtime/lua/vim/lsp/codelens.lua | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index c85bb6aa32..c1b6bfb28c 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -307,7 +307,13 @@ function M.refresh(opts)
       }
       active_refreshes[buf] = true
 
-      local request_ids = vim.lsp.buf_request(buf, ms.textDocument_codeLens, params, M.on_codelens)
+      local request_ids = vim.lsp.buf_request(
+        buf,
+        ms.textDocument_codeLens,
+        params,
+        M.on_codelens,
+        function() end
+      )
       if vim.tbl_isempty(request_ids) then
         active_refreshes[buf] = nil
       end
-- 
cgit 


From e29f245a10821fcce454f7ede684aa0dd64efc33 Mon Sep 17 00:00:00 2001
From: Amit Singh <29333147+amitds1997@users.noreply.github.com>
Date: Wed, 17 Jul 2024 20:14:53 +0530
Subject: fix(lsp): inlay hints are rendered in the correct order (#29707)

Problem:
When there are multiple inlay hints present at the same position, they
should be rendered in the order they are received in the response from
LSP as per the LSP spec. Currently, this is not respected.

Solution:
Gather all hints for a given position, and then set it in a single
extmark call instead of multiple set_extmark calls. This leads to fewer
extmark calls and correct inlay hints being rendered.
---
 runtime/lua/vim/lsp/inlay_hint.lua | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index aa84294cc4..1e224d1bef 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -336,6 +336,8 @@ api.nvim_set_decoration_provider(namespace, {
     for lnum = topline, botline do
       if bufstate.applied[lnum] ~= bufstate.version then
         api.nvim_buf_clear_namespace(bufnr, namespace, lnum, lnum + 1)
+
+        local hint_virtual_texts = {} --- @type table<integer, [string, string?][]>
         for _, lnum_hints in pairs(client_hints) do
           local hints = lnum_hints[lnum] or {}
           for _, hint in pairs(hints) do
@@ -348,7 +350,7 @@ api.nvim_set_decoration_provider(namespace, {
                 text = text .. part.value
               end
             end
-            local vt = {} --- @type [string, string?][]
+            local vt = hint_virtual_texts[hint.position.character] or {}
             if hint.paddingLeft then
               vt[#vt + 1] = { ' ' }
             end
@@ -356,13 +358,18 @@ api.nvim_set_decoration_provider(namespace, {
             if hint.paddingRight then
               vt[#vt + 1] = { ' ' }
             end
-            api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
-              virt_text_pos = 'inline',
-              ephemeral = false,
-              virt_text = vt,
-            })
+            hint_virtual_texts[hint.position.character] = vt
           end
         end
+
+        for pos, vt in pairs(hint_virtual_texts) do
+          api.nvim_buf_set_extmark(bufnr, namespace, lnum, pos, {
+            virt_text_pos = 'inline',
+            ephemeral = false,
+            virt_text = vt,
+          })
+        end
+
         bufstate.applied[lnum] = bufstate.version
       end
     end
-- 
cgit 


From bdff50dee56ebf6de58d58315920abf2f8e262f7 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 27 Jul 2024 22:30:14 +0200
Subject: fix(lsp): revert text edit application order change (#29877)

Reverts https://github.com/neovim/neovim/pull/29212 and adds a few
additional test cases

From the spec

> All text edits ranges refer to positions in the document they are
> computed on. They therefore move a document from state S1 to S2 without
> describing any intermediate state. Text edits ranges must never overlap,
> that means no part of the original document must be manipulated by more
> than one edit. However, it is possible that multiple edits have the same
> start position: multiple inserts, or any number of inserts followed by a
> single remove or replace edit. If multiple inserts have the same
> position, the order in the array defines the order in which the inserted
> strings appear in the resulting text.

The previous fix seems wrong. The important part:

> If multiple inserts have the same position, the order in the array
> defines the order in which the inserted strings appear in the
> resulting text.

Emphasis on _appear in the resulting text_

Which means that in:

    local edits1 = {
      make_edit(0, 3, 0, 3, { 'World' }),
      make_edit(0, 3, 0, 3, { 'Hello' }),
    }

`World` must appear before `Hello` in the final text. That means the old
logic was correct, and the fix was wrong.
---
 runtime/lua/vim/lsp/util.lua | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index b0fd25af3a..59ae3beae4 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -396,10 +396,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
     if a.range.start.character ~= b.range.start.character then
       return a.range.start.character > b.range.start.character
     end
-    if a._index ~= b._index then
-      return a._index < b._index
-    end
-    return false
+    return a._index > b._index
   end)
 
   -- save and restore local marks since they get deleted by nvim_buf_set_lines
-- 
cgit 


From 4e90bc30237ae81bf15e77c17ac8089a2cc74046 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Wed, 31 Jul 2024 22:15:34 +0800
Subject: feat(lsp): lsp.completion support set deprecated (#29882)

Problem: CompletionItem in lsp spec mentioned the deprecated attribute

Solution: when item has deprecated attribute set hl_group to DiagnosticDeprecated
          in complete function
---
 runtime/lua/vim/lsp/completion.lua |  8 ++++++++
 runtime/lua/vim/lsp/protocol.lua   | 12 +++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 1078e3eb7e..6a6659fd25 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -253,6 +253,13 @@ function M._lsp_to_complete_items(result, prefix, client_id)
   for _, item in ipairs(items) do
     if matches(item) then
       local word = get_completion_word(item)
+      local hl_group = ''
+      if
+        item.deprecated
+        or vim.list_contains((item.tags or {}), protocol.CompletionTag.Deprecated)
+      then
+        hl_group = 'DiagnosticDeprecated'
+      end
       table.insert(candidates, {
         word = word,
         abbr = item.label,
@@ -262,6 +269,7 @@ function M._lsp_to_complete_items(result, prefix, client_id)
         icase = 1,
         dup = 1,
         empty = 1,
+        hl_group = hl_group,
         user_data = {
           nvim = {
             lsp = {
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 656921644d..b53f9a207a 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -99,6 +99,13 @@ local constants = {
     TriggerForIncompleteCompletions = 3,
   },
 
+  -- Completion item tags are extra annotations that tweak the rendering of a
+  -- completion item
+  CompletionTag = {
+    -- Render a completion as obsolete, usually using a strike-out.
+    Deprecated = 1,
+  },
+
   -- A document highlight kind.
   DocumentHighlightKind = {
     -- A textual occurrence.
@@ -433,13 +440,16 @@ function protocol.make_client_capabilities()
           snippetSupport = true,
           commitCharactersSupport = false,
           preselectSupport = false,
-          deprecatedSupport = false,
+          deprecatedSupport = true,
           documentationFormat = { constants.MarkupKind.Markdown, constants.MarkupKind.PlainText },
           resolveSupport = {
             properties = {
               'additionalTextEdits',
             },
           },
+          tagSupport = {
+            valueSet = get_value_set(constants.CompletionTag),
+          },
         },
         completionItemKind = {
           valueSet = get_value_set(constants.CompletionItemKind),
-- 
cgit 


From 6bb40f3dbffb4b9858d9b13486d1832db8f51755 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Wed, 31 Jul 2024 23:18:24 +0900
Subject: fix(lsp): prevent desync due to empty buffer (#29904)

Problem:
Some language servers (e.g., rust-analyzer, texlab) are desynced when
the user deletes the entire contents of the buffer. This is due to the
discrepancy between how nvim computes diff and how nvim treats empty
buffer.
* diff: If the buffer became empty, then the diff includes the last
  line's eol.
* empty buffer: Even if the buffer is empty, nvim regards it as having
  a single empty line with eol.

Solution:
Add special case for diff computation when the buffer becomes empty so
that it does not include the eol of the last line.
---
 runtime/lua/vim/lsp/sync.lua | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/sync.lua b/runtime/lua/vim/lsp/sync.lua
index 936579e003..bdfe8d51b8 100644
--- a/runtime/lua/vim/lsp/sync.lua
+++ b/runtime/lua/vim/lsp/sync.lua
@@ -212,7 +212,8 @@ end
 ---@param lastline integer
 ---@param new_lastline integer
 ---@param offset_encoding string
----@return vim.lsp.sync.Range, vim.lsp.sync.Range
+---@return vim.lsp.sync.Range prev_end_range
+---@return vim.lsp.sync.Range curr_end_range
 local function compute_end_range(
   prev_lines,
   curr_lines,
@@ -222,6 +223,16 @@ local function compute_end_range(
   new_lastline,
   offset_encoding
 )
+  -- A special case for the following `firstline == new_lastline` case where lines are deleted.
+  -- Even if the buffer has become empty, nvim behaves as if it has an empty line with eol.
+  if #curr_lines == 1 and curr_lines[1] == '' then
+    local prev_line = prev_lines[lastline - 1]
+    return {
+      line_idx = lastline - 1,
+      byte_idx = #prev_line + 1,
+      char_idx = compute_line_length(prev_line, offset_encoding) + 1,
+    }, { line_idx = 1, byte_idx = 1, char_idx = 1 }
+  end
   -- If firstline == new_lastline, the first change occurred on a line that was deleted.
   -- In this case, the last_byte...
   if firstline == new_lastline then
-- 
cgit 


From 720b309c786c4a258adccc9c468d433fb0f755b9 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 1 Aug 2024 16:01:15 +0200
Subject: fix(lsp): don't send foreign diagnostics to servers in
 buf.code_action (#29501)

`buf.code_action` always included diagnostics on a given line from all
clients. Servers should only receive diagnostics they published, and in
the exact same format they sent it.

Should fix https://github.com/neovim/neovim/issues/29500
---
 runtime/lua/vim/lsp/buf.lua        | 18 +++++++++++++-----
 runtime/lua/vim/lsp/diagnostic.lua | 18 ++++++++----------
 2 files changed, 21 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index f20730b8e6..a512d48a06 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -852,14 +852,10 @@ function M.code_action(opts)
   if opts.diagnostics or opts.only then
     opts = { options = opts }
   end
-  local context = opts.context or {}
+  local context = opts.context and vim.deepcopy(opts.context) or {}
   if not context.triggerKind then
     context.triggerKind = vim.lsp.protocol.CodeActionTriggerKind.Invoked
   end
-  if not context.diagnostics then
-    local bufnr = api.nvim_get_current_buf()
-    context.diagnostics = vim.lsp.diagnostic.get_line_diagnostics(bufnr)
-  end
   local mode = api.nvim_get_mode().mode
   local bufnr = api.nvim_get_current_buf()
   local win = api.nvim_get_current_win()
@@ -901,6 +897,18 @@ function M.code_action(opts)
     else
       params = util.make_range_params(win, client.offset_encoding)
     end
+    if not context.diagnostics then
+      local ns_push = vim.lsp.diagnostic.get_namespace(client.id, false)
+      local ns_pull = vim.lsp.diagnostic.get_namespace(client.id, true)
+      local diagnostics = {}
+      local lnum = api.nvim_win_get_cursor(0)[1] - 1
+      vim.list_extend(diagnostics, vim.diagnostic.get(bufnr, { namespace = ns_pull, lnum = lnum }))
+      vim.list_extend(diagnostics, vim.diagnostic.get(bufnr, { namespace = ns_push, lnum = lnum }))
+      ---@diagnostic disable-next-line: no-unknown
+      context.diagnostics = vim.tbl_map(function(d)
+        return d.user_data.lsp
+      end, diagnostics)
+    end
     params.context = context
     client.request(ms.textDocument_codeAction, params, on_result, bufnr)
   end
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 08cea13548..5ed42700e3 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -122,13 +122,7 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
       code = diagnostic.code,
       _tags = tags_lsp_to_vim(diagnostic, client_id),
       user_data = {
-        lsp = {
-          -- usage of user_data.lsp.code is deprecated in favor of the top-level code field
-          code = diagnostic.code,
-          codeDescription = diagnostic.codeDescription,
-          relatedInformation = diagnostic.relatedInformation,
-          data = diagnostic.data,
-        },
+        lsp = diagnostic,
       },
     }
   end, diagnostics)
@@ -157,8 +151,11 @@ local function diagnostic_vim_to_lsp(diagnostics)
   ---@param diagnostic vim.Diagnostic
   ---@return lsp.Diagnostic
   return vim.tbl_map(function(diagnostic)
-    return vim.tbl_extend('keep', {
-      -- "keep" the below fields over any duplicate fields in diagnostic.user_data.lsp
+    local user_data = diagnostic.user_data or {}
+    if user_data.lsp then
+      return user_data.lsp
+    end
+    return {
       range = {
         start = {
           line = diagnostic.lnum,
@@ -174,7 +171,7 @@ local function diagnostic_vim_to_lsp(diagnostics)
       source = diagnostic.source,
       code = diagnostic.code,
       tags = tags_vim_to_lsp(diagnostic),
-    }, diagnostic.user_data and (diagnostic.user_data.lsp or {}) or {})
+    }
   end, diagnostics)
 end
 
@@ -366,6 +363,7 @@ end
 ---              Structured: { [1] = {...}, [5] = {.... } }
 ---@private
 function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
+  vim.deprecate('vim.lsp.diagnostic.get_line_diagnostics', 'vim.diagnostic.get', '0.12')
   convert_severity(opts)
   local diag_opts = {} --- @type vim.diagnostic.GetOpts
 
-- 
cgit 


From 6072153796d1b1e54067ac9823583be96b24ede1 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 3 Aug 2024 11:14:12 +0200
Subject: feat(lsp): announce codeLens resolveSupport (#29956)

The codelens implementation can resolve command via `codeLens/resolve`.

The spec added client capabilities for that:

https://github.com/microsoft/language-server-protocol/pull/1979
---
 runtime/lua/vim/lsp/protocol.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index b53f9a207a..2514a62f89 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -427,6 +427,12 @@ function protocol.make_client_capabilities()
           properties = { 'edit' },
         },
       },
+      codeLens = {
+        dynamicRegistration = false,
+        resolveSupport = {
+          properties = { 'command' },
+        },
+      },
       formatting = {
         dynamicRegistration = true,
       },
-- 
cgit 


From eb629cce917155a4d436327db10c8b1b44ae7861 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 3 Aug 2024 18:14:34 +0900
Subject: fix(lsp): redundant spaces in lsp log (#29970)

---
 runtime/lua/vim/lsp/log.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 0438ca84af..4f177b47fd 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -19,7 +19,7 @@ local current_log_level = log_levels.WARN
 local log_date_format = '%F %H:%M:%S'
 
 local function format_func(arg)
-  return vim.inspect(arg, { newline = '' })
+  return vim.inspect(arg, { newline = ' ', indent = '' })
 end
 
 local function notify(msg, level)
-- 
cgit 


From 7031949be065870f0daf74a9f1be3df47f83312c Mon Sep 17 00:00:00 2001
From: Grzegorz Rozdzialik <voreny.gelio@gmail.com>
Date: Wed, 7 Aug 2024 17:28:01 +0200
Subject: fix(lsp): avoid reusing diagnostics from different servers in actions
 (#30002)

Problem: When preparing the parameters for a code actions LSP request,
the code set `context.diagnostics` when processing the first LSP client,
and then reused those `context.diagnostics` for subsequent LSP clients.

This meant that the second and next LSP clients got diagnostics that
did not originate from them, and they did not get the diagnostics that
they sent.

Solution: Avoid setting `context.diagnostics` (which is referenced by
all clients). Instead, set `params.context.diagnostics` directly, which
is specific to a single client.

Fixes #30001
Caused by #29501
---
 runtime/lua/vim/lsp/buf.lua | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index a512d48a06..d7463d74f8 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -897,19 +897,23 @@ function M.code_action(opts)
     else
       params = util.make_range_params(win, client.offset_encoding)
     end
-    if not context.diagnostics then
+    if context.diagnostics then
+      params.context = context
+    else
       local ns_push = vim.lsp.diagnostic.get_namespace(client.id, false)
       local ns_pull = vim.lsp.diagnostic.get_namespace(client.id, true)
       local diagnostics = {}
       local lnum = api.nvim_win_get_cursor(0)[1] - 1
       vim.list_extend(diagnostics, vim.diagnostic.get(bufnr, { namespace = ns_pull, lnum = lnum }))
       vim.list_extend(diagnostics, vim.diagnostic.get(bufnr, { namespace = ns_push, lnum = lnum }))
-      ---@diagnostic disable-next-line: no-unknown
-      context.diagnostics = vim.tbl_map(function(d)
-        return d.user_data.lsp
-      end, diagnostics)
+      params.context = vim.tbl_extend('force', context, {
+        ---@diagnostic disable-next-line: no-unknown
+        diagnostics = vim.tbl_map(function(d)
+          return d.user_data.lsp
+        end, diagnostics),
+      })
     end
-    params.context = context
+
     client.request(ms.textDocument_codeAction, params, on_result, bufnr)
   end
 end
-- 
cgit 


From 9b5ab66678f8efa1f5fe89205839fe053fe5efaf Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 11 Aug 2024 11:58:15 +0100
Subject: test(lsp): refactor and tidy

- Merge all the top level 'LSP' describe blocks
- Refactor text edit tests
- Fix typing errors
- Add linebreaks between tests
---
 runtime/lua/vim/lsp/util.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 59ae3beae4..cbbe3a66b7 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1442,7 +1442,7 @@ end
 --- Computes size of float needed to show contents (with optional wrapping)
 ---
 ---@param contents table of lines to show in window
----@param opts table with optional fields
+---@param opts? table with optional fields
 ---            - height  of floating window
 ---            - width   of floating window
 ---            - wrap_at character to wrap at for computing height
@@ -1821,7 +1821,7 @@ end
 --- Converts symbols to quickfix list items.
 ---
 ---@param symbols table DocumentSymbol[] or SymbolInformation[]
----@param bufnr integer
+---@param bufnr? integer
 function M.symbols_to_items(symbols, bufnr)
   local function _symbols_to_items(_symbols, _items, _bufnr)
     for _, symbol in ipairs(_symbols) do
-- 
cgit 


From 766d5036275e871932893f8dfc8c5bc1eb7a3726 Mon Sep 17 00:00:00 2001
From: Ricardo Casía <ricardocasia.dev@gmail.com>
Date: Tue, 20 Aug 2024 14:52:14 +0200
Subject: docs(lsp): annotate with `vim.lsp.protocol.Methods` enum #29521

Added the enum type annotation `vim.lsp.protocol.Methods` to provide some intellisense support.
---
 runtime/lua/vim/lsp/_meta/protocol.lua | 2164 ++++++++++++++++++--------------
 runtime/lua/vim/lsp/protocol.lua       |    9 +-
 2 files changed, 1212 insertions(+), 961 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/_meta/protocol.lua b/runtime/lua/vim/lsp/_meta/protocol.lua
index cbddd24630..d83c40a09f 100644
--- a/runtime/lua/vim/lsp/_meta/protocol.lua
+++ b/runtime/lua/vim/lsp/_meta/protocol.lua
@@ -134,7 +134,7 @@ error('Cannot require a meta file')
 ---The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
 ---@field endCharacter? uinteger
 ---
----Describes the kind of the folding range such as `comment' or 'region'. The kind
+---Describes the kind of the folding range such as 'comment' or 'region'. The kind
 ---is used to categorize folding ranges and used by commands like 'Fold all comments'.
 ---See {@link FoldingRangeKind} for an enumeration of standardized kinds.
 ---@field kind? lsp.FoldingRangeKind
@@ -681,6 +681,11 @@ error('Cannot require a meta file')
 ---of a notebook cell.
 ---@field cellTextDocuments lsp.TextDocumentItem[]
 
+---Registration options specific to a notebook.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
+
 ---The params sent in a change notebook document notification.
 ---
 ---@since 3.17.0
@@ -789,7 +794,7 @@ error('Cannot require a meta file')
 ---Information about the server.
 ---
 ---@since 3.15.0
----@field serverInfo? lsp._anonym1.serverInfo
+---@field serverInfo? lsp.ServerInfo
 
 ---The data type of the ResponseError if the
 ---initialize request fails.
@@ -1115,7 +1120,7 @@ error('Cannot require a meta file')
 ---capability.
 ---
 ---@since 3.17.0
----@field itemDefaults? lsp._anonym2.itemDefaults
+---@field itemDefaults? lsp.CompletionItemDefaults
 ---
 ---The completion items.
 ---@field items lsp.CompletionItem[]
@@ -1171,7 +1176,7 @@ error('Cannot require a meta file')
 ---
 ---If `null`, no parameter of the signature is active (for example a named
 ---argument that does not match any declared parameters). This is only valid
----since 3.18.0 and if the client specifies the client capability
+---if the client specifies the client capability
 ---`textDocument.signatureHelp.noActiveParameterSupport === true`
 ---
 ---If omitted or the value lies outside the range of
@@ -1307,6 +1312,12 @@ error('Cannot require a meta file')
 ---Title of the command, like `save`.
 ---@field title string
 ---
+---An optional tooltip.
+---
+---@since 3.18.0
+---@proposed
+---@field tooltip? string
+---
 ---The identifier of the actual command handler.
 ---@field command string
 ---
@@ -1355,7 +1366,7 @@ error('Cannot require a meta file')
 ---    error message with `reason` in the editor.
 ---
 ---@since 3.16.0
----@field disabled? lsp._anonym4.disabled
+---@field disabled? lsp.CodeActionDisabled
 ---
 ---The workspace edit this code action performs.
 ---@field edit? lsp.WorkspaceEdit
@@ -1379,6 +1390,12 @@ error('Cannot require a meta file')
 ---
 ---A query string to filter symbols by. Clients may send an empty
 ---string here to request all symbols.
+---
+---The `query`-parameter should be interpreted in a *relaxed way* as editors
+---will apply their own highlighting and scoring on the results. A good rule
+---of thumb is to match case-insensitive and to simply check that the
+---characters of *query* appear in their order in a candidate symbol.
+---Servers shouldn't use prefix, substring, or similar strict matching.
 ---@field query string
 
 ---A special workspace symbol that supports locations without a range.
@@ -1393,7 +1410,7 @@ error('Cannot require a meta file')
 ---capability `workspace.symbol.resolveSupport`.
 ---
 ---See SymbolInformation#location for more details.
----@field location lsp.Location|lsp._anonym5.location
+---@field location lsp.Location|lsp.LocationUriOnly
 ---
 ---A data entry field that is preserved on a workspace symbol between a
 ---workspace symbol request and a workspace symbol resolve request.
@@ -1566,6 +1583,12 @@ error('Cannot require a meta file')
 ---
 ---The edits to apply.
 ---@field edit lsp.WorkspaceEdit
+---
+---Additional data about the edit.
+---
+---@since 3.18.0
+---@proposed
+---@field metadata? lsp.WorkspaceEditMetadata
 
 ---The result returned from the apply workspace edit request.
 ---
@@ -1650,7 +1673,7 @@ error('Cannot require a meta file')
 
 ---@class lsp.SetTraceParams
 ---
----@field value lsp.TraceValues
+---@field value lsp.TraceValue
 
 ---@class lsp.LogTraceParams
 ---
@@ -1848,10 +1871,10 @@ error('Cannot require a meta file')
 ---
 ---Server supports providing semantic tokens for a specific range
 ---of a document.
----@field range? boolean|lsp._anonym6.range
+---@field range? boolean|lsp._anonym1.range
 ---
 ---Server supports providing semantic tokens for a full document.
----@field full? boolean|lsp._anonym7.full
+---@field full? boolean|lsp.SemanticTokensFullDelta
 
 ---@since 3.16.0
 ---@class lsp.SemanticTokensEdit
@@ -1888,7 +1911,10 @@ error('Cannot require a meta file')
 ---
 ---@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
 ---client capability.
----@field edits (lsp.TextEdit|lsp.AnnotatedTextEdit)[]
+---
+---@since 3.18.0 - support for SnippetTextEdit. This is guarded using a
+---client capability.
+---@field edits (lsp.TextEdit|lsp.AnnotatedTextEdit|lsp.SnippetTextEdit)[]
 
 ---Create file operation.
 ---@class lsp.CreateFile: lsp.ResourceOperation
@@ -2235,7 +2261,7 @@ error('Cannot require a meta file')
 ---@field uri lsp.DocumentUri
 ---
 ---The text document's language identifier.
----@field languageId string
+---@field languageId lsp.LanguageKind
 ---
 ---The version number of this document (it will increase after each
 ---change, including undo/redo).
@@ -2244,6 +2270,28 @@ error('Cannot require a meta file')
 ---The content of the opened text document.
 ---@field text string
 
+---Options specific to a notebook plus its cells
+---to be synced to the server.
+---
+---If a selector provides a notebook document
+---filter but no cell selector all cells of a
+---matching notebook document will be synced.
+---
+---If a selector provides no notebook document
+---filter but only a cell selector all notebook
+---document that contain at least one matching
+---cell will be synced.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncOptions
+---
+---The notebooks to be synced
+---@field notebookSelector (lsp.NotebookDocumentFilterWithNotebook|lsp.NotebookDocumentFilterWithCells)[]
+---
+---Whether save notification should be forwarded to
+---the server. Will only be honored if mode === `notebook`.
+---@field save? boolean
+
 ---A versioned notebook document identifier.
 ---
 ---@since 3.17.0
@@ -2266,7 +2314,7 @@ error('Cannot require a meta file')
 ---@field metadata? lsp.LSPObject
 ---
 ---Changes to cells
----@field cells? lsp._anonym8.cells
+---@field cells? lsp.NotebookDocumentCellChanges
 
 ---A literal to identify a notebook document in the client.
 ---
@@ -2348,7 +2396,7 @@ error('Cannot require a meta file')
 ---Information about the client
 ---
 ---@since 3.15.0
----@field clientInfo? lsp._anonym11.clientInfo
+---@field clientInfo? lsp.ClientInfo
 ---
 ---The locale the client is currently showing the user interface
 ---in. This must not necessarily be the locale of the operating
@@ -2380,7 +2428,7 @@ error('Cannot require a meta file')
 ---@field initializationOptions? lsp.LSPAny
 ---
 ---The initial trace setting. If omitted trace is disabled ('off').
----@field trace? lsp.TraceValues
+---@field trace? lsp.TraceValue
 
 ---@class lsp.WorkspaceFoldersInitializeParams
 ---
@@ -2534,18 +2582,24 @@ error('Cannot require a meta file')
 ---@proposed
 ---@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
 ---
----Text document specific server capabilities.
----
----@since 3.18.0
----@proposed
----@field textDocument? lsp._anonym12.textDocument
----
 ---Workspace specific server capabilities.
----@field workspace? lsp._anonym14.workspace
+---@field workspace? lsp.WorkspaceOptions
 ---
 ---Experimental server capabilities.
 ---@field experimental? lsp.LSPAny
 
+---Information about the server
+---
+---@since 3.15.0
+---@since 3.18.0 ServerInfo type name added.
+---@class lsp.ServerInfo
+---
+---The name of the server as defined by the server.
+---@field name string
+---
+---The server's version as defined by the server.
+---@field version? string
+
 ---A text document identifier to denote a specific version of a text document.
 ---@class lsp.VersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
 ---
@@ -2586,8 +2640,9 @@ error('Cannot require a meta file')
 ---The range at which the message applies
 ---@field range lsp.Range
 ---
----The diagnostic's severity. Can be omitted. If omitted it is up to the
----client to interpret diagnostics as error, warning, info or hint.
+---The diagnostic's severity. To avoid interpretation mismatches when a
+---server is used with different clients it is highly recommended that servers
+---always provide a severity value.
 ---@field severity? lsp.DiagnosticSeverity
 ---
 ---The diagnostic's code, which usually appear in the user interface.
@@ -2604,10 +2659,8 @@ error('Cannot require a meta file')
 ---appears in the user interface.
 ---@field source? string
 ---
----The diagnostic's message. It usually appears in the user interface.
----
----@since 3.18.0 - support for `MarkupContent`. This is guarded by the client capability `textDocument.diagnostic.markupMessageSupport`.
----@field message string|lsp.MarkupContent
+---The diagnostic's message. It usually appears in the user interface
+---@field message string
 ---
 ---Additional metadata about the diagnostic.
 ---
@@ -2661,6 +2714,46 @@ error('Cannot require a meta file')
 ---The range if the replace is requested.
 ---@field replace lsp.Range
 
+---In many cases the items of an actual completion result share the same
+---value for properties like `commitCharacters` or the range of a text
+---edit. A completion list can therefore define item defaults which will
+---be used if a completion item itself doesn't specify the value.
+---
+---If a completion list specifies a default value and a completion item
+---also specifies a corresponding value the one from the item is used.
+---
+---Servers are only allowed to return default values if the client
+---signals support for this via the `completionList.itemDefaults`
+---capability.
+---
+---@since 3.17.0
+---@class lsp.CompletionItemDefaults
+---
+---A default commit character set.
+---
+---@since 3.17.0
+---@field commitCharacters? string[]
+---
+---A default edit range.
+---
+---@since 3.17.0
+---@field editRange? lsp.Range|lsp.EditRangeWithInsertReplace
+---
+---A default insert text format.
+---
+---@since 3.17.0
+---@field insertTextFormat? lsp.InsertTextFormat
+---
+---A default insert text mode.
+---
+---@since 3.17.0
+---@field insertTextMode? lsp.InsertTextMode
+---
+---A default data value.
+---
+---@since 3.17.0
+---@field data? lsp.LSPAny
+
 ---Completion options.
 ---@class lsp.CompletionOptions: lsp.WorkDoneProgressOptions
 ---
@@ -2692,7 +2785,7 @@ error('Cannot require a meta file')
 ---capabilities.
 ---
 ---@since 3.17.0
----@field completionItem? lsp._anonym15.completionItem
+---@field completionItem? lsp.ServerCompletionItemOptions
 
 ---Hover options.
 ---@class lsp.HoverOptions: lsp.WorkDoneProgressOptions
@@ -2742,7 +2835,7 @@ error('Cannot require a meta file')
 ---
 ---If `null`, no parameter of the signature is active (for example a named
 ---argument that does not match any declared parameters). This is only valid
----since 3.18.0 and if the client specifies the client capability
+---if the client specifies the client capability
 ---`textDocument.signatureHelp.noActiveParameterSupport === true`
 ---
 ---If provided (or `null`), this is used in place of
@@ -2819,8 +2912,6 @@ error('Cannot require a meta file')
 ---errors are currently presented to the user for the given range. There is no guarantee
 ---that these accurately reflect the error state of the resource. The primary parameter
 ---to compute code actions is the provided range.
----
----Note that the client should check the `textDocument.diagnostic.markupMessageSupport` server capability before sending diagnostics with markup messages to a server.
 ---@field diagnostics lsp.Diagnostic[]
 ---
 ---Requested kind of actions to return.
@@ -2834,6 +2925,16 @@ error('Cannot require a meta file')
 ---@since 3.17.0
 ---@field triggerKind? lsp.CodeActionTriggerKind
 
+---Captures why the code action is currently disabled.
+---
+---@since 3.18.0
+---@class lsp.CodeActionDisabled
+---
+---Human readable description of why the code action is currently disabled.
+---
+---This is displayed in the code actions UI.
+---@field reason string
+
 ---Provider options for a {@link CodeActionRequest}.
 ---@class lsp.CodeActionOptions: lsp.WorkDoneProgressOptions
 ---
@@ -2843,12 +2944,36 @@ error('Cannot require a meta file')
 ---may list out every specific kind they provide.
 ---@field codeActionKinds? lsp.CodeActionKind[]
 ---
+---Static documentation for a class of code actions.
+---
+---Documentation from the provider should be shown in the code actions menu if either:
+---
+---- Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that
+---  most closely matches the requested code action kind. For example, if a provider has documentation for
+---  both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`,
+---  the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`.
+---
+---- Any code actions of `kind` are returned by the provider.
+---
+---At most one documentation entry should be shown per provider.
+---
+---@since 3.18.0
+---@proposed
+---@field documentation? lsp.CodeActionKindDocumentation[]
+---
 ---The server provides support to resolve additional
 ---information for a code action.
 ---
 ---@since 3.16.0
 ---@field resolveProvider? boolean
 
+---Location with only uri and does not include range.
+---
+---@since 3.18.0
+---@class lsp.LocationUriOnly
+---
+---@field uri lsp.DocumentUri
+
 ---Server capabilities for a {@link WorkspaceSymbolRequest}.
 ---@class lsp.WorkspaceSymbolOptions: lsp.WorkDoneProgressOptions
 ---
@@ -2923,12 +3048,33 @@ error('Cannot require a meta file')
 ---@since version 3.12.0
 ---@field prepareProvider? boolean
 
+---@since 3.18.0
+---@class lsp.PrepareRenamePlaceholder
+---
+---@field range lsp.Range
+---
+---@field placeholder string
+
+---@since 3.18.0
+---@class lsp.PrepareRenameDefaultBehavior
+---
+---@field defaultBehavior boolean
+
 ---The server capabilities of a {@link ExecuteCommandRequest}.
 ---@class lsp.ExecuteCommandOptions: lsp.WorkDoneProgressOptions
 ---
 ---The commands to be executed on the server
 ---@field commands string[]
 
+---Additional data about a workspace edit.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.WorkspaceEditMetadata
+---
+---Signal to the editor that this edit is a refactoring.
+---@field isRefactoring? boolean
+
 ---@since 3.16.0
 ---@class lsp.SemanticTokensLegend
 ---
@@ -2938,6 +3084,14 @@ error('Cannot require a meta file')
 ---The token modifiers a server uses.
 ---@field tokenModifiers string[]
 
+---Semantic tokens options to support deltas for full documents
+---
+---@since 3.18.0
+---@class lsp.SemanticTokensFullDelta
+---
+---The server supports deltas for full documents.
+---@field delta? boolean
+
 ---A text document identifier to optionally denote a specific version of a text document.
 ---@class lsp.OptionalVersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
 ---
@@ -2956,6 +3110,21 @@ error('Cannot require a meta file')
 ---The actual identifier of the change annotation
 ---@field annotationId lsp.ChangeAnnotationIdentifier
 
+---An interactive text edit.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.SnippetTextEdit
+---
+---The range of the text document to be manipulated.
+---@field range lsp.Range
+---
+---The snippet to be inserted.
+---@field snippet lsp.StringValue
+---
+---The actual identifier of the snippet edit.
+---@field annotationId? lsp.ChangeAnnotationIdentifier
+
 ---A generic resource operation.
 ---@class lsp.ResourceOperation
 ---
@@ -3066,20 +3235,43 @@ error('Cannot require a meta file')
 ---if supported by the client.
 ---@field executionSummary? lsp.ExecutionSummary
 
----A change describing how to move a `NotebookCell`
----array from state S to S'.
+---@since 3.18.0
+---@class lsp.NotebookDocumentFilterWithNotebook
 ---
----@since 3.17.0
----@class lsp.NotebookCellArrayChange
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook string|lsp.NotebookDocumentFilter
 ---
----The start oftest of the cell that changed.
----@field start uinteger
+---The cells of the matching notebook to be synced.
+---@field cells? lsp.NotebookCellLanguage[]
+
+---@since 3.18.0
+---@class lsp.NotebookDocumentFilterWithCells
 ---
----The deleted cells
----@field deleteCount uinteger
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook? string|lsp.NotebookDocumentFilter
 ---
----The new cells, if any
----@field cells? lsp.NotebookCell[]
+---The cells of the matching notebook to be synced.
+---@field cells lsp.NotebookCellLanguage[]
+
+---Cell changes to a notebook document.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentCellChanges
+---
+---Changes to the cell structure to add or
+---remove cells.
+---@field structure? lsp.NotebookDocumentCellChangeStructure
+---
+---Changes to notebook cells properties like its
+---kind, execution summary or metadata.
+---@field data? lsp.NotebookCell[]
+---
+---Changes to the text content of notebook cells.
+---@field textContent? lsp.NotebookDocumentCellContentChanges[]
 
 ---Describes the currently selected completion item.
 ---
@@ -3093,6 +3285,18 @@ error('Cannot require a meta file')
 ---The text the range will be replaced with if this completion is accepted.
 ---@field text string
 
+---Information about the client
+---
+---@since 3.15.0
+---@since 3.18.0 ClientInfo type name added.
+---@class lsp.ClientInfo
+---
+---The name of the client as defined by the client.
+---@field name string
+---
+---The client's version as defined by the client.
+---@field version? string
+
 ---Defines the capabilities provided by the client.
 ---@class lsp.ClientCapabilities
 ---
@@ -3140,69 +3344,40 @@ error('Cannot require a meta file')
 ---sent.
 ---@field save? boolean|lsp.SaveOptions
 
----Options specific to a notebook plus its cells
----to be synced to the server.
+---Defines workspace specific capabilities of the server.
 ---
----If a selector provides a notebook document
----filter but no cell selector all cells of a
----matching notebook document will be synced.
+---@since 3.18.0
+---@class lsp.WorkspaceOptions
 ---
----If a selector provides no notebook document
----filter but only a cell selector all notebook
----document that contain at least one matching
----cell will be synced.
+---The server supports workspace folder.
 ---
----@since 3.17.0
----@class lsp.NotebookDocumentSyncOptions
+---@since 3.6.0
+---@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
 ---
----The notebooks to be synced
----@field notebookSelector (lsp._anonym16.notebookSelector|lsp._anonym18.notebookSelector)[]
+---The server is interested in notifications/requests for operations on files.
 ---
----Whether save notification should be forwarded to
----the server. Will only be honored if mode === `notebook`.
----@field save? boolean
+---@since 3.16.0
+---@field fileOperations? lsp.FileOperationOptions
 
----Registration options specific to a notebook.
+---@since 3.18.0
+---@class lsp.TextDocumentContentChangePartial
 ---
----@since 3.17.0
----@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
-
----@class lsp.WorkspaceFoldersServerCapabilities
+---The range of the document that changed.
+---@field range lsp.Range
 ---
----The server has support for workspace folders
----@field supported? boolean
+---The optional length of the range that got replaced.
 ---
----Whether the server wants to receive workspace folder
----change notifications.
+---@deprecated use range instead.
+---@field rangeLength? uinteger
 ---
----If a string is provided the string is treated as an ID
----under which the notification is registered on the client
----side. The ID can be used to unregister for these events
----using the `client/unregisterCapability` request.
----@field changeNotifications? string|boolean
+---The new text for the provided range.
+---@field text string
 
----Options for notifications/requests for user operations on files.
----
----@since 3.16.0
----@class lsp.FileOperationOptions
----
----The server is interested in receiving didCreateFiles notifications.
----@field didCreate? lsp.FileOperationRegistrationOptions
----
----The server is interested in receiving willCreateFiles requests.
----@field willCreate? lsp.FileOperationRegistrationOptions
----
----The server is interested in receiving didRenameFiles notifications.
----@field didRename? lsp.FileOperationRegistrationOptions
----
----The server is interested in receiving willRenameFiles requests.
----@field willRename? lsp.FileOperationRegistrationOptions
----
----The server is interested in receiving didDeleteFiles file notifications.
----@field didDelete? lsp.FileOperationRegistrationOptions
+---@since 3.18.0
+---@class lsp.TextDocumentContentChangeWholeDocument
 ---
----The server is interested in receiving willDeleteFiles file requests.
----@field willDelete? lsp.FileOperationRegistrationOptions
+---The new text of the whole document.
+---@field text string
 
 ---Structure to capture a description for an error code.
 ---
@@ -3223,6 +3398,33 @@ error('Cannot require a meta file')
 ---The message of this related diagnostic information.
 ---@field message string
 
+---Edit range variant that includes ranges for insert and replace operations.
+---
+---@since 3.18.0
+---@class lsp.EditRangeWithInsertReplace
+---
+---@field insert lsp.Range
+---
+---@field replace lsp.Range
+
+---@since 3.18.0
+---@class lsp.ServerCompletionItemOptions
+---
+---The server has support for completion item label
+---details (see also `CompletionItemLabelDetails`) when
+---receiving a completion item in a resolve call.
+---
+---@since 3.17.0
+---@field labelDetailsSupport? boolean
+
+---@since 3.18.0
+---@deprecated use MarkupContent instead.
+---@class lsp.MarkedStringWithLanguage
+---
+---@field language string
+---
+---@field value string
+
 ---Represents a parameter of a callable-signature. A parameter can
 ---have a label and a doc-comment.
 ---@class lsp.ParameterInformation
@@ -3233,6 +3435,10 @@ error('Cannot require a meta file')
 ---signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
 ---string representation as `Position` and `Range` does.
 ---
+---To avoid ambiguities a server should use the [start, end] offset value instead of using
+---a substring. Whether a client support this is controlled via `labelOffsetSupport` client
+---capability.
+---
 ---*Note*: a label of type string should be a substring of its containing signature label.
 ---Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
 ---@field label string|[uinteger, uinteger]
@@ -3241,6 +3447,24 @@ error('Cannot require a meta file')
 ---in the UI but can be omitted.
 ---@field documentation? string|lsp.MarkupContent
 
+---Documentation for a class of code actions.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.CodeActionKindDocumentation
+---
+---The kind of the code action being documented.
+---
+---If the kind is generic, such as `CodeActionKind.Refactor`, the documentation will be shown whenever any
+---refactorings are returned. If the kind if more specific, such as `CodeActionKind.RefactorExtract`, the
+---documentation will only be shown when extract refactoring code actions are returned.
+---@field kind lsp.CodeActionKind
+---
+---Command that is ued to display the documentation to the user.
+---
+---The title of this documentation code action is taken from {@linkcode Command.title}
+---@field command lsp.Command
+
 ---A notebook cell text document filter denotes a cell text
 ---document by different properties.
 ---
@@ -3278,6 +3502,34 @@ error('Cannot require a meta file')
 ---not if known by the client.
 ---@field success? boolean
 
+---@since 3.18.0
+---@class lsp.NotebookCellLanguage
+---
+---@field language string
+
+---Structural changes to cells in a notebook document.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentCellChangeStructure
+---
+---The change to the cell array.
+---@field array lsp.NotebookCellArrayChange
+---
+---Additional opened cell text documents.
+---@field didOpen? lsp.TextDocumentItem[]
+---
+---Additional closed cell text documents.
+---@field didClose? lsp.TextDocumentIdentifier[]
+
+---Content changes to a cell in a notebook document.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentCellContentChanges
+---
+---@field document lsp.VersionedTextDocumentIdentifier
+---
+---@field changes lsp.TextDocumentContentChangeEvent[]
+
 ---Workspace specific client capabilities.
 ---@class lsp.WorkspaceClientCapabilities
 ---
@@ -3524,7 +3776,7 @@ error('Cannot require a meta file')
 ---anymore since the information is outdated).
 ---
 ---@since 3.17.0
----@field staleRequestSupport? lsp._anonym20.staleRequestSupport
+---@field staleRequestSupport? lsp.StaleRequestSupportOptions
 ---
 ---Client capabilities specific to regular expressions.
 ---
@@ -3556,6 +3808,43 @@ error('Cannot require a meta file')
 ---@since 3.17.0
 ---@field positionEncodings? lsp.PositionEncodingKind[]
 
+---@class lsp.WorkspaceFoldersServerCapabilities
+---
+---The server has support for workspace folders
+---@field supported? boolean
+---
+---Whether the server wants to receive workspace folder
+---change notifications.
+---
+---If a string is provided the string is treated as an ID
+---under which the notification is registered on the client
+---side. The ID can be used to unregister for these events
+---using the `client/unregisterCapability` request.
+---@field changeNotifications? string|boolean
+
+---Options for notifications/requests for user operations on files.
+---
+---@since 3.16.0
+---@class lsp.FileOperationOptions
+---
+---The server is interested in receiving didCreateFiles notifications.
+---@field didCreate? lsp.FileOperationRegistrationOptions
+---
+---The server is interested in receiving willCreateFiles requests.
+---@field willCreate? lsp.FileOperationRegistrationOptions
+---
+---The server is interested in receiving didRenameFiles notifications.
+---@field didRename? lsp.FileOperationRegistrationOptions
+---
+---The server is interested in receiving willRenameFiles requests.
+---@field willRename? lsp.FileOperationRegistrationOptions
+---
+---The server is interested in receiving didDeleteFiles file notifications.
+---@field didDelete? lsp.FileOperationRegistrationOptions
+---
+---The server is interested in receiving willDeleteFiles file requests.
+---@field willDelete? lsp.FileOperationRegistrationOptions
+
 ---A relative pattern is a helper to construct glob patterns that are matched
 ---relatively to a base URI. The common value for a `baseUri` is a workspace
 ---folder root, but it can be another absolute URI as well.
@@ -3570,6 +3859,111 @@ error('Cannot require a meta file')
 ---The actual glob pattern;
 ---@field pattern lsp.Pattern
 
+---A document filter where `language` is required field.
+---
+---@since 3.18.0
+---@class lsp.TextDocumentFilterLanguage
+---
+---A language id, like `typescript`.
+---@field language string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---@since 3.18.0 - support for relative patterns.
+---@field pattern? lsp.GlobPattern
+
+---A document filter where `scheme` is required field.
+---
+---@since 3.18.0
+---@class lsp.TextDocumentFilterScheme
+---
+---A language id, like `typescript`.
+---@field language? string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---@since 3.18.0 - support for relative patterns.
+---@field pattern? lsp.GlobPattern
+
+---A document filter where `pattern` is required field.
+---
+---@since 3.18.0
+---@class lsp.TextDocumentFilterPattern
+---
+---A language id, like `typescript`.
+---@field language? string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---@since 3.18.0 - support for relative patterns.
+---@field pattern lsp.GlobPattern
+
+---A notebook document filter where `notebookType` is required field.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentFilterNotebookType
+---
+---The type of the enclosing notebook.
+---@field notebookType string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---
+---A glob pattern.
+---@field pattern? lsp.GlobPattern
+
+---A notebook document filter where `scheme` is required field.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentFilterScheme
+---
+---The type of the enclosing notebook.
+---@field notebookType? string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---
+---A glob pattern.
+---@field pattern? lsp.GlobPattern
+
+---A notebook document filter where `pattern` is required field.
+---
+---@since 3.18.0
+---@class lsp.NotebookDocumentFilterPattern
+---
+---The type of the enclosing notebook.
+---@field notebookType? string
+---
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---
+---A glob pattern.
+---@field pattern lsp.GlobPattern
+
+---A change describing how to move a `NotebookCell`
+---array from state S to S'.
+---
+---@since 3.17.0
+---@class lsp.NotebookCellArrayChange
+---
+---The start oftest of the cell that changed.
+---@field start uinteger
+---
+---The deleted cells
+---@field deleteCount uinteger
+---
+---The new cells, if any
+---@field cells? lsp.NotebookCell[]
+
 ---@class lsp.WorkspaceEditClientCapabilities
 ---
 ---The client supports versioned document changes in `WorkspaceEdit`s
@@ -3600,7 +3994,19 @@ error('Cannot require a meta file')
 ---create file, rename file and delete file changes.
 ---
 ---@since 3.16.0
----@field changeAnnotationSupport? lsp._anonym21.changeAnnotationSupport
+---@field changeAnnotationSupport? lsp.ChangeAnnotationsSupportOptions
+---
+---Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s.
+---
+---@since 3.18.0
+---@proposed
+---@field metadataSupport? boolean
+---
+---Whether the client supports snippets as text edits.
+---
+---@since 3.18.0
+---@proposed
+---@field snippetEditSupport? boolean
 
 ---@class lsp.DidChangeConfigurationClientCapabilities
 ---
@@ -3627,20 +4033,20 @@ error('Cannot require a meta file')
 ---@field dynamicRegistration? boolean
 ---
 ---Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
----@field symbolKind? lsp._anonym22.symbolKind
+---@field symbolKind? lsp.ClientSymbolKindOptions
 ---
 ---The client supports tags on `SymbolInformation`.
 ---Clients supporting tags have to handle unknown tags gracefully.
 ---
 ---@since 3.16.0
----@field tagSupport? lsp._anonym23.tagSupport
+---@field tagSupport? lsp.ClientSymbolTagOptions
 ---
 ---The client support partial workspace symbols. The client will send the
 ---request `workspaceSymbol/resolve` to the server to resolve additional
 ---properties.
 ---
 ---@since 3.17.0
----@field resolveSupport? lsp._anonym24.resolveSupport
+---@field resolveSupport? lsp.ClientSymbolResolveOptions
 
 ---The client capabilities of a {@link ExecuteCommandRequest}.
 ---@class lsp.ExecuteCommandClientCapabilities
@@ -3785,9 +4191,9 @@ error('Cannot require a meta file')
 ---
 ---The client supports the following `CompletionItem` specific
 ---capabilities.
----@field completionItem? lsp._anonym25.completionItem
+---@field completionItem? lsp.ClientCompletionItemOptions
 ---
----@field completionItemKind? lsp._anonym29.completionItemKind
+---@field completionItemKind? lsp.ClientCompletionItemOptionsKind
 ---
 ---Defines how the client handles whitespace and indentation
 ---when accepting a completion item that uses multi line
@@ -3804,7 +4210,7 @@ error('Cannot require a meta file')
 ---capabilities.
 ---
 ---@since 3.17.0
----@field completionList? lsp._anonym30.completionList
+---@field completionList? lsp.CompletionListCapabilities
 
 ---@class lsp.HoverClientCapabilities
 ---
@@ -3823,7 +4229,7 @@ error('Cannot require a meta file')
 ---
 ---The client supports the following `SignatureInformation`
 ---specific properties.
----@field signatureInformation? lsp._anonym31.signatureInformation
+---@field signatureInformation? lsp.ClientSignatureInformationOptions
 ---
 ---The client supports to send additional context information for a
 ---`textDocument/signatureHelp` request. A client that opts into
@@ -3901,7 +4307,7 @@ error('Cannot require a meta file')
 ---
 ---Specific capabilities for the `SymbolKind` in the
 ---`textDocument/documentSymbol` request.
----@field symbolKind? lsp._anonym33.symbolKind
+---@field symbolKind? lsp.ClientSymbolKindOptions
 ---
 ---The client supports hierarchical document symbols.
 ---@field hierarchicalDocumentSymbolSupport? boolean
@@ -3911,7 +4317,7 @@ error('Cannot require a meta file')
 ---Clients supporting tags have to handle unknown tags gracefully.
 ---
 ---@since 3.16.0
----@field tagSupport? lsp._anonym34.tagSupport
+---@field tagSupport? lsp.ClientSymbolTagOptions
 ---
 ---The client supports an additional label presented in the UI when
 ---registering a document symbol provider.
@@ -3930,7 +4336,7 @@ error('Cannot require a meta file')
 ---set the request can only return `Command` literals.
 ---
 ---@since 3.8.0
----@field codeActionLiteralSupport? lsp._anonym35.codeActionLiteralSupport
+---@field codeActionLiteralSupport? lsp.ClientCodeActionLiteralOptions
 ---
 ---Whether code action supports the `isPreferred` property.
 ---
@@ -3953,7 +4359,7 @@ error('Cannot require a meta file')
 ---properties via a separate `codeAction/resolve` request.
 ---
 ---@since 3.16.0
----@field resolveSupport? lsp._anonym37.resolveSupport
+---@field resolveSupport? lsp.ClientCodeActionResolveOptions
 ---
 ---Whether the client honors the change annotations in
 ---text edits and resource operations returned via the
@@ -3963,12 +4369,25 @@ error('Cannot require a meta file')
 ---
 ---@since 3.16.0
 ---@field honorsChangeAnnotations? boolean
+---
+---Whether the client supports documentation for a class of
+---code actions.
+---
+---@since 3.18.0
+---@proposed
+---@field documentationSupport? boolean
 
 ---The client capabilities  of a {@link CodeLensRequest}.
 ---@class lsp.CodeLensClientCapabilities
 ---
 ---Whether code lens supports dynamic registration.
 ---@field dynamicRegistration? boolean
+---
+---Whether the client supports resolving additional code lens
+---properties via a separate `codeLens/resolve` request.
+---
+---@since 3.18.0
+---@field resolveSupport? lsp.ClientCodeLensResolveOptions
 
 ---The client capabilities of a {@link DocumentLinkRequest}.
 ---@class lsp.DocumentLinkClientCapabilities
@@ -4061,12 +4480,12 @@ error('Cannot require a meta file')
 ---Specific options for the folding range kind.
 ---
 ---@since 3.17.0
----@field foldingRangeKind? lsp._anonym38.foldingRangeKind
+---@field foldingRangeKind? lsp.ClientFoldingRangeKindOptions
 ---
 ---Specific options for the folding range.
 ---
 ---@since 3.17.0
----@field foldingRange? lsp._anonym39.foldingRange
+---@field foldingRange? lsp.ClientFoldingRangeOptions
 
 ---@class lsp.SelectionRangeClientCapabilities
 ---
@@ -4076,34 +4495,13 @@ error('Cannot require a meta file')
 ---@field dynamicRegistration? boolean
 
 ---The publish diagnostic client capabilities.
----@class lsp.PublishDiagnosticsClientCapabilities
----
----Whether the clients accepts diagnostics with related information.
----@field relatedInformation? boolean
----
----Client supports the tag property to provide meta data about a diagnostic.
----Clients supporting tags have to handle unknown tags gracefully.
----
----@since 3.15.0
----@field tagSupport? lsp._anonym40.tagSupport
+---@class lsp.PublishDiagnosticsClientCapabilities: lsp.DiagnosticsCapabilities
 ---
 ---Whether the client interprets the version property of the
 ---`textDocument/publishDiagnostics` notification's parameter.
 ---
 ---@since 3.15.0
 ---@field versionSupport? boolean
----
----Client supports a codeDescription property
----
----@since 3.16.0
----@field codeDescriptionSupport? boolean
----
----Whether code action supports the `data` property which is
----preserved between a `textDocument/publishDiagnostics` and
----`textDocument/codeAction` request.
----
----@since 3.16.0
----@field dataSupport? boolean
 
 ---@since 3.16.0
 ---@class lsp.CallHierarchyClientCapabilities
@@ -4129,7 +4527,7 @@ error('Cannot require a meta file')
 ---`request.range` are both set to true but the server only provides a
 ---range provider the client might not render a minimap correctly or might
 ---even decide to not show any semantic tokens at all.
----@field requests lsp._anonym41.requests
+---@field requests lsp.ClientSemanticTokensRequestOptions
 ---
 ---The token types that the client supports.
 ---@field tokenTypes string[]
@@ -4212,12 +4610,12 @@ error('Cannot require a meta file')
 ---
 ---Indicates which properties a client can resolve lazily on an inlay
 ---hint.
----@field resolveSupport? lsp._anonym44.resolveSupport
+---@field resolveSupport? lsp.ClientInlayHintResolveOptions
 
 ---Client capabilities specific to diagnostic pull requests.
 ---
 ---@since 3.17.0
----@class lsp.DiagnosticClientCapabilities
+---@class lsp.DiagnosticClientCapabilities: lsp.DiagnosticsCapabilities
 ---
 ---Whether implementation supports dynamic registration. If this is set to `true`
 ---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
@@ -4226,9 +4624,6 @@ error('Cannot require a meta file')
 ---
 ---Whether the clients supports related documents for document diagnostic pulls.
 ---@field relatedDocumentSupport? boolean
----
----Whether the client supports `MarkupContent` in diagnostic messages.
----@field markupMessageSupport? boolean
 
 ---Client capabilities specific to inline completions.
 ---
@@ -4257,7 +4652,7 @@ error('Cannot require a meta file')
 ---@class lsp.ShowMessageRequestClientCapabilities
 ---
 ---Capabilities specific to the `MessageActionItem` type.
----@field messageActionItem? lsp._anonym45.messageActionItem
+---@field messageActionItem? lsp.ClientShowMessageActionItemOptions
 
 ---Client capabilities for the showDocument request.
 ---
@@ -4268,13 +4663,24 @@ error('Cannot require a meta file')
 ---request.
 ---@field support boolean
 
+---@since 3.18.0
+---@class lsp.StaleRequestSupportOptions
+---
+---The client will actively cancel the request.
+---@field cancel boolean
+---
+---The list of requests for which the client
+---will retry the request if it receives a
+---response with error code `ContentModified`
+---@field retryOnContentModified string[]
+
 ---Client capabilities specific to regular expressions.
 ---
 ---@since 3.16.0
 ---@class lsp.RegularExpressionsClientCapabilities
 ---
 ---The engine's name.
----@field engine string
+---@field engine lsp.RegularExpressionEngineKind
 ---
 ---The engine's version.
 ---@field version? string
@@ -4296,988 +4702,832 @@ error('Cannot require a meta file')
 ---@since 3.17.0
 ---@field allowedTags? string[]
 
----A set of predefined token types. This set is not fixed
----an clients can specify additional token types via the
----corresponding client capabilities.
+---@since 3.18.0
+---@class lsp.ChangeAnnotationsSupportOptions
 ---
----@since 3.16.0
----@alias lsp.SemanticTokenTypes
----| "namespace" # namespace
----| "type" # type
----| "class" # class
----| "enum" # enum
----| "interface" # interface
----| "struct" # struct
----| "typeParameter" # typeParameter
----| "parameter" # parameter
----| "variable" # variable
----| "property" # property
----| "enumMember" # enumMember
----| "event" # event
----| "function" # function
----| "method" # method
----| "macro" # macro
----| "keyword" # keyword
----| "modifier" # modifier
----| "comment" # comment
----| "string" # string
----| "number" # number
----| "regexp" # regexp
----| "operator" # operator
----| "decorator" # decorator
+---Whether the client groups edits with equal labels into tree nodes,
+---for instance all edits labelled with "Changes in Strings" would
+---be a tree node.
+---@field groupsOnLabel? boolean
 
----A set of predefined token modifiers. This set is not fixed
----an clients can specify additional token types via the
----corresponding client capabilities.
----
----@since 3.16.0
----@alias lsp.SemanticTokenModifiers
----| "declaration" # declaration
----| "definition" # definition
----| "readonly" # readonly
----| "static" # static
----| "deprecated" # deprecated
----| "abstract" # abstract
----| "async" # async
----| "modification" # modification
----| "documentation" # documentation
----| "defaultLibrary" # defaultLibrary
-
----The document diagnostic report kinds.
+---@since 3.18.0
+---@class lsp.ClientSymbolKindOptions
 ---
----@since 3.17.0
----@alias lsp.DocumentDiagnosticReportKind
----| "full" # Full
----| "unchanged" # Unchanged
-
----Predefined error codes.
----@alias lsp.ErrorCodes
----| -32700 # ParseError
----| -32600 # InvalidRequest
----| -32601 # MethodNotFound
----| -32602 # InvalidParams
----| -32603 # InternalError
----| -32002 # ServerNotInitialized
----| -32001 # UnknownErrorCode
-
----@alias lsp.LSPErrorCodes
----| -32803 # RequestFailed
----| -32802 # ServerCancelled
----| -32801 # ContentModified
----| -32800 # RequestCancelled
-
----A set of predefined range kinds.
----@alias lsp.FoldingRangeKind
----| "comment" # Comment
----| "imports" # Imports
----| "region" # Region
-
----A symbol kind.
----@alias lsp.SymbolKind
----| 1 # File
----| 2 # Module
----| 3 # Namespace
----| 4 # Package
----| 5 # Class
----| 6 # Method
----| 7 # Property
----| 8 # Field
----| 9 # Constructor
----| 10 # Enum
----| 11 # Interface
----| 12 # Function
----| 13 # Variable
----| 14 # Constant
----| 15 # String
----| 16 # Number
----| 17 # Boolean
----| 18 # Array
----| 19 # Object
----| 20 # Key
----| 21 # Null
----| 22 # EnumMember
----| 23 # Struct
----| 24 # Event
----| 25 # Operator
----| 26 # TypeParameter
-
----Symbol tags are extra annotations that tweak the rendering of a symbol.
+---The symbol kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
 ---
----@since 3.16
----@alias lsp.SymbolTag
----| 1 # Deprecated
+---If this property is not present the client only supports
+---the symbol kinds from `File` to `Array` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.SymbolKind[]
 
----Moniker uniqueness level to define scope of the moniker.
+---@since 3.18.0
+---@class lsp.ClientSymbolTagOptions
 ---
----@since 3.16.0
----@alias lsp.UniquenessLevel
----| "document" # document
----| "project" # project
----| "group" # group
----| "scheme" # scheme
----| "global" # global
+---The tags supported by the client.
+---@field valueSet lsp.SymbolTag[]
 
----The moniker kind.
+---@since 3.18.0
+---@class lsp.ClientSymbolResolveOptions
 ---
----@since 3.16.0
----@alias lsp.MonikerKind
----| "import" # import
----| "export" # export
----| "local" # local
+---The properties that a client can resolve lazily. Usually
+---`location.range`
+---@field properties string[]
 
----Inlay hint kinds.
+---@since 3.18.0
+---@class lsp.ClientCompletionItemOptions
 ---
----@since 3.17.0
----@alias lsp.InlayHintKind
----| 1 # Type
----| 2 # Parameter
-
----The message type
----@alias lsp.MessageType
----| 1 # Error
----| 2 # Warning
----| 3 # Info
----| 4 # Log
----| 5 # Debug
-
----Defines how the host (editor) should sync
----document changes to the language server.
----@alias lsp.TextDocumentSyncKind
----| 0 # None
----| 1 # Full
----| 2 # Incremental
-
----Represents reasons why a text document is saved.
----@alias lsp.TextDocumentSaveReason
----| 1 # Manual
----| 2 # AfterDelay
----| 3 # FocusOut
-
----The kind of a completion entry.
----@alias lsp.CompletionItemKind
----| 1 # Text
----| 2 # Method
----| 3 # Function
----| 4 # Constructor
----| 5 # Field
----| 6 # Variable
----| 7 # Class
----| 8 # Interface
----| 9 # Module
----| 10 # Property
----| 11 # Unit
----| 12 # Value
----| 13 # Enum
----| 14 # Keyword
----| 15 # Snippet
----| 16 # Color
----| 17 # File
----| 18 # Reference
----| 19 # Folder
----| 20 # EnumMember
----| 21 # Constant
----| 22 # Struct
----| 23 # Event
----| 24 # Operator
----| 25 # TypeParameter
-
----Completion item tags are extra annotations that tweak the rendering of a completion
----item.
+---Client supports snippets as insert text.
 ---
----@since 3.15.0
----@alias lsp.CompletionItemTag
----| 1 # Deprecated
-
----Defines whether the insert text in a completion item should be interpreted as
----plain text or a snippet.
----@alias lsp.InsertTextFormat
----| 1 # PlainText
----| 2 # Snippet
-
----How whitespace and indentation is handled during completion
----item insertion.
+---A snippet can define tab stops and placeholders with `$1`, `$2`
+---and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+---the end of the snippet. Placeholders with equal identifiers are linked,
+---that is typing in one will update others too.
+---@field snippetSupport? boolean
 ---
----@since 3.16.0
----@alias lsp.InsertTextMode
----| 1 # asIs
----| 2 # adjustIndentation
-
----A document highlight kind.
----@alias lsp.DocumentHighlightKind
----| 1 # Text
----| 2 # Read
----| 3 # Write
-
----A set of predefined code action kinds
----@alias lsp.CodeActionKind
----| "" # Empty
----| "quickfix" # QuickFix
----| "refactor" # Refactor
----| "refactor.extract" # RefactorExtract
----| "refactor.inline" # RefactorInline
----| "refactor.rewrite" # RefactorRewrite
----| "source" # Source
----| "source.organizeImports" # SourceOrganizeImports
----| "source.fixAll" # SourceFixAll
-
----@alias lsp.TraceValues
----| "off" # Off
----| "messages" # Messages
----| "verbose" # Verbose
-
----Describes the content type that a client supports in various
----result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+---Client supports commit characters on a completion item.
+---@field commitCharactersSupport? boolean
 ---
----Please note that `MarkupKinds` must not start with a `$`. This kinds
----are reserved for internal usage.
----@alias lsp.MarkupKind
----| "plaintext" # PlainText
----| "markdown" # Markdown
-
----Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
 ---
----@since 3.18.0
----@proposed
----@alias lsp.InlineCompletionTriggerKind
----| 0 # Invoked
----| 1 # Automatic
-
----A set of predefined position encoding kinds.
+---Client supports the deprecated property on a completion item.
+---@field deprecatedSupport? boolean
 ---
----@since 3.17.0
----@alias lsp.PositionEncodingKind
----| "utf-8" # UTF8
----| "utf-16" # UTF16
----| "utf-32" # UTF32
-
----The file event type
----@alias lsp.FileChangeType
----| 1 # Created
----| 2 # Changed
----| 3 # Deleted
-
----@alias lsp.WatchKind
----| 1 # Create
----| 2 # Change
----| 4 # Delete
-
----The diagnostic's severity.
----@alias lsp.DiagnosticSeverity
----| 1 # Error
----| 2 # Warning
----| 3 # Information
----| 4 # Hint
-
----The diagnostic tags.
+---Client supports the preselect property on a completion item.
+---@field preselectSupport? boolean
 ---
----@since 3.15.0
----@alias lsp.DiagnosticTag
----| 1 # Unnecessary
----| 2 # Deprecated
-
----How a completion was triggered
----@alias lsp.CompletionTriggerKind
----| 1 # Invoked
----| 2 # TriggerCharacter
----| 3 # TriggerForIncompleteCompletions
-
----How a signature help was triggered.
+---Client supports the tag property on a completion item. Clients supporting
+---tags have to handle unknown tags gracefully. Clients especially need to
+---preserve unknown tags when sending a completion item back to the server in
+---a resolve call.
 ---
 ---@since 3.15.0
----@alias lsp.SignatureHelpTriggerKind
----| 1 # Invoked
----| 2 # TriggerCharacter
----| 3 # ContentChange
-
----The reason why code actions were requested.
+---@field tagSupport? lsp.CompletionItemTagOptions
 ---
----@since 3.17.0
----@alias lsp.CodeActionTriggerKind
----| 1 # Invoked
----| 2 # Automatic
-
----A pattern kind describing if a glob pattern matches a file a folder or
----both.
+---Client support insert replace edit to control different behavior if a
+---completion item is inserted in the text or should replace text.
 ---
 ---@since 3.16.0
----@alias lsp.FileOperationPatternKind
----| "file" # file
----| "folder" # folder
-
----A notebook cell kind.
----
----@since 3.17.0
----@alias lsp.NotebookCellKind
----| 1 # Markup
----| 2 # Code
-
----@alias lsp.ResourceOperationKind
----| "create" # Create
----| "rename" # Rename
----| "delete" # Delete
-
----@alias lsp.FailureHandlingKind
----| "abort" # Abort
----| "transactional" # Transactional
----| "textOnlyTransactional" # TextOnlyTransactional
----| "undo" # Undo
-
----@alias lsp.PrepareSupportDefaultBehavior
----| 1 # Identifier
-
----@alias lsp.TokenFormat
----| "relative" # Relative
-
----The definition of a symbol represented as one or many {@link Location locations}.
----For most programming languages there is only one location at which a symbol is
----defined.
+---@field insertReplaceSupport? boolean
 ---
----Servers should prefer returning `DefinitionLink` over `Definition` if supported
----by the client.
----@alias lsp.Definition lsp.Location|lsp.Location[]
-
----Information about where a symbol is defined.
+---Indicates which properties a client can resolve lazily on a completion
+---item. Before version 3.16.0 only the predefined properties `documentation`
+---and `details` could be resolved lazily.
 ---
----Provides additional metadata over normal {@link Location location} definitions, including the range of
----the defining symbol
----@alias lsp.DefinitionLink lsp.LocationLink
-
----LSP arrays.
----@since 3.17.0
----@alias lsp.LSPArray lsp.LSPAny[]
-
----The LSP any type.
----Please note that strictly speaking a property with the value `undefined`
----can't be converted into JSON preserving the property name. However for
----convenience it is allowed and assumed that all these properties are
----optional as well.
----@since 3.17.0
----@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|integer|uinteger|decimal|boolean|lsp.null
-
----The declaration of a symbol representation as one or many {@link Location locations}.
----@alias lsp.Declaration lsp.Location|lsp.Location[]
-
----Information about where a symbol is declared.
+---@since 3.16.0
+---@field resolveSupport? lsp.ClientCompletionItemResolveOptions
 ---
----Provides additional metadata over normal {@link Location location} declarations, including the range of
----the declaring symbol.
+---The client supports the `insertTextMode` property on
+---a completion item to override the whitespace handling mode
+---as defined by the client (see `insertTextMode`).
 ---
----Servers should prefer returning `DeclarationLink` over `Declaration` if supported
----by the client.
----@alias lsp.DeclarationLink lsp.LocationLink
-
----Inline value information can be provided by different means:
----- directly as a text value (class InlineValueText).
----- as a name to use for a variable lookup (class InlineValueVariableLookup)
----- as an evaluatable expression (class InlineValueEvaluatableExpression)
----The InlineValue types combines all inline value types into one type.
+---@since 3.16.0
+---@field insertTextModeSupport? lsp.ClientCompletionItemInsertTextModeOptions
 ---
----@since 3.17.0
----@alias lsp.InlineValue lsp.InlineValueText|lsp.InlineValueVariableLookup|lsp.InlineValueEvaluatableExpression
-
----The result of a document diagnostic pull request. A report can
----either be a full report containing all diagnostics for the
----requested document or an unchanged report indicating that nothing
----has changed in terms of diagnostics in comparison to the last
----pull request.
+---The client has support for completion item label
+---details (see also `CompletionItemLabelDetails`).
 ---
 ---@since 3.17.0
----@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
-
----@alias lsp.PrepareRenameResult lsp.Range|lsp._anonym46.PrepareRenameResult|lsp._anonym47.PrepareRenameResult
+---@field labelDetailsSupport? boolean
 
----A document selector is the combination of one or many document filters.
+---@since 3.18.0
+---@class lsp.ClientCompletionItemOptionsKind
 ---
----\@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
+---The completion item kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
 ---
----The use of a string as a document filter is deprecated @since 3.16.0.
----@alias lsp.DocumentSelector lsp.DocumentFilter[]
-
----@alias lsp.ProgressToken integer|string
-
----An identifier to refer to a change annotation stored with a workspace edit.
----@alias lsp.ChangeAnnotationIdentifier string
+---If this property is not present the client only supports
+---the completion items kinds from `Text` to `Reference` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.CompletionItemKind[]
 
----A workspace diagnostic document report.
+---The client supports the following `CompletionList` specific
+---capabilities.
 ---
 ---@since 3.17.0
----@alias lsp.WorkspaceDocumentDiagnosticReport lsp.WorkspaceFullDocumentDiagnosticReport|lsp.WorkspaceUnchangedDocumentDiagnosticReport
-
----An event describing a change to a text document. If only a text is provided
----it is considered to be the full content of the document.
----@alias lsp.TextDocumentContentChangeEvent lsp._anonym48.TextDocumentContentChangeEvent|lsp._anonym49.TextDocumentContentChangeEvent
-
----MarkedString can be used to render human readable text. It is either a markdown string
----or a code-block that provides a language and a code snippet. The language identifier
----is semantically equal to the optional language identifier in fenced code blocks in GitHub
----issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+---@class lsp.CompletionListCapabilities
 ---
----The pair of a language and a value is an equivalent to markdown:
----```${language}
----${value}
----```
+---The client supports the following itemDefaults on
+---a completion list.
 ---
----Note that markdown strings will be sanitized - that means html will be escaped.
----@deprecated use MarkupContent instead.
----@alias lsp.MarkedString string|lsp._anonym50.MarkedString
-
----A document filter describes a top level text document or
----a notebook cell document.
+---The value lists the supported property names of the
+---`CompletionList.itemDefaults` object. If omitted
+---no properties are supported.
 ---
----@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
----@alias lsp.DocumentFilter lsp.TextDocumentFilter|lsp.NotebookCellTextDocumentFilter
-
----LSP object definition.
 ---@since 3.17.0
----@alias lsp.LSPObject table<string, lsp.LSPAny>
+---@field itemDefaults? string[]
 
----The glob pattern. Either a string pattern or a relative pattern.
+---@since 3.18.0
+---@class lsp.ClientSignatureInformationOptions
 ---
----@since 3.17.0
----@alias lsp.GlobPattern lsp.Pattern|lsp.RelativePattern
-
----A document filter denotes a document by different properties like
----the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
----its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
 ---
----Glob patterns can have the following syntax:
----- `*` to match one or more characters in a path segment
----- `?` to match on one character in a path segment
----- `**` to match any number of path segments, including none
----- `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
----- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
----- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---Client capabilities specific to parameter information.
+---@field parameterInformation? lsp.ClientSignatureParameterInformationOptions
 ---
----\@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
----\@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+---The client supports the `activeParameter` property on `SignatureInformation`
+---literal.
 ---
----@since 3.17.0
----@alias lsp.TextDocumentFilter lsp._anonym51.TextDocumentFilter|lsp._anonym52.TextDocumentFilter|lsp._anonym53.TextDocumentFilter
-
----A notebook document filter denotes a notebook document by
----different properties. The properties will be match
----against the notebook's URI (same as with documents)
+---@since 3.16.0
+---@field activeParameterSupport? boolean
 ---
----@since 3.17.0
----@alias lsp.NotebookDocumentFilter lsp._anonym54.NotebookDocumentFilter|lsp._anonym55.NotebookDocumentFilter|lsp._anonym56.NotebookDocumentFilter
+---The client supports the `activeParameter` property on
+---`SignatureHelp`/`SignatureInformation` being set to `null` to
+---indicate that no parameter should be active.
+---
+---@since 3.18.0
+---@proposed
+---@field noActiveParameterSupport? boolean
 
----The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
----- `*` to match one or more characters in a path segment
----- `?` to match on one character in a path segment
----- `**` to match any number of path segments, including none
----- `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
----- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
----- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---@since 3.18.0
+---@class lsp.ClientCodeActionLiteralOptions
 ---
----@since 3.17.0
----@alias lsp.Pattern string
+---The code action kind is support with the following value
+---set.
+---@field codeActionKind lsp.ClientCodeActionKindOptions
 
----@class lsp._anonym1.serverInfo
+---@since 3.18.0
+---@class lsp.ClientCodeActionResolveOptions
 ---
----The name of the server as defined by the server.
----@field name string
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@since 3.18.0
+---@class lsp.ClientCodeLensResolveOptions
 ---
----The server's version as defined by the server.
----@field version? string
+---The properties that a client can resolve lazily.
+---@field properties string[]
 
----@class lsp._anonym3.itemDefaults.editRange
----
----@field insert lsp.Range
+---@since 3.18.0
+---@class lsp.ClientFoldingRangeKindOptions
 ---
----@field replace lsp.Range
+---The folding range kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet? lsp.FoldingRangeKind[]
 
----@class lsp._anonym2.itemDefaults
+---@since 3.18.0
+---@class lsp.ClientFoldingRangeOptions
 ---
----A default commit character set.
+---If set, the client signals that it supports setting collapsedText on
+---folding ranges to display custom labels instead of the default text.
 ---
 ---@since 3.17.0
----@field commitCharacters? string[]
----
----A default edit range.
+---@field collapsedText? boolean
+
+---General diagnostics capabilities for pull and push model.
+---@class lsp.DiagnosticsCapabilities
 ---
----@since 3.17.0
----@field editRange? lsp.Range|lsp._anonym3.itemDefaults.editRange
+---Whether the clients accepts diagnostics with related information.
+---@field relatedInformation? boolean
 ---
----A default insert text format.
+---Client supports the tag property to provide meta data about a diagnostic.
+---Clients supporting tags have to handle unknown tags gracefully.
 ---
----@since 3.17.0
----@field insertTextFormat? lsp.InsertTextFormat
+---@since 3.15.0
+---@field tagSupport? lsp.ClientDiagnosticsTagOptions
 ---
----A default insert text mode.
+---Client supports a codeDescription property
 ---
----@since 3.17.0
----@field insertTextMode? lsp.InsertTextMode
+---@since 3.16.0
+---@field codeDescriptionSupport? boolean
 ---
----A default data value.
+---Whether code action supports the `data` property which is
+---preserved between a `textDocument/publishDiagnostics` and
+---`textDocument/codeAction` request.
 ---
----@since 3.17.0
----@field data? lsp.LSPAny
+---@since 3.16.0
+---@field dataSupport? boolean
 
----@class lsp._anonym4.disabled
+---@since 3.18.0
+---@class lsp.ClientSemanticTokensRequestOptions
 ---
----Human readable description of why the code action is currently disabled.
+---The client will send the `textDocument/semanticTokens/range` request if
+---the server provides a corresponding handler.
+---@field range? boolean|lsp._anonym2.range
 ---
----This is displayed in the code actions UI.
----@field reason string
+---The client will send the `textDocument/semanticTokens/full` request if
+---the server provides a corresponding handler.
+---@field full? boolean|lsp.ClientSemanticTokensRequestFullDelta
 
----@class lsp._anonym5.location
+---@since 3.18.0
+---@class lsp.ClientInlayHintResolveOptions
 ---
----@field uri lsp.DocumentUri
-
----@class lsp._anonym6.range
+---The properties that a client can resolve lazily.
+---@field properties string[]
 
----@class lsp._anonym7.full
+---@since 3.18.0
+---@class lsp.ClientShowMessageActionItemOptions
 ---
----The server supports deltas for full documents.
----@field delta? boolean
+---Whether the client supports additional attributes which
+---are preserved and send back to the server in the
+---request's response.
+---@field additionalPropertiesSupport? boolean
 
----@class lsp._anonym9.cells.structure
----
----The change to the cell array.
----@field array lsp.NotebookCellArrayChange
----
----Additional opened cell text documents.
----@field didOpen? lsp.TextDocumentItem[]
+---@since 3.18.0
+---@class lsp.CompletionItemTagOptions
 ---
----Additional closed cell text documents.
----@field didClose? lsp.TextDocumentIdentifier[]
+---The tags supported by the client.
+---@field valueSet lsp.CompletionItemTag[]
 
----@class lsp._anonym10.cells.textContent
----
----@field document lsp.VersionedTextDocumentIdentifier
+---@since 3.18.0
+---@class lsp.ClientCompletionItemResolveOptions
 ---
----@field changes lsp.TextDocumentContentChangeEvent[]
+---The properties that a client can resolve lazily.
+---@field properties string[]
 
----@class lsp._anonym8.cells
----
----Changes to the cell structure to add or
----remove cells.
----@field structure? lsp._anonym9.cells.structure
----
----Changes to notebook cells properties like its
----kind, execution summary or metadata.
----@field data? lsp.NotebookCell[]
+---@since 3.18.0
+---@class lsp.ClientCompletionItemInsertTextModeOptions
 ---
----Changes to the text content of notebook cells.
----@field textContent? lsp._anonym10.cells.textContent[]
+---@field valueSet lsp.InsertTextMode[]
 
----@class lsp._anonym11.clientInfo
+---@since 3.18.0
+---@class lsp.ClientSignatureParameterInformationOptions
 ---
----The name of the client as defined by the client.
----@field name string
+---The client supports processing label offsets instead of a
+---simple label string.
 ---
----The client's version as defined by the client.
----@field version? string
+---@since 3.14.0
+---@field labelOffsetSupport? boolean
 
----@class lsp._anonym13.textDocument.diagnostic
+---@since 3.18.0
+---@class lsp.ClientCodeActionKindOptions
 ---
----Whether the server supports `MarkupContent` in diagnostic messages.
----@field markupMessageSupport? boolean
+---The code action kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet lsp.CodeActionKind[]
 
----@class lsp._anonym12.textDocument
----
----Capabilities specific to the diagnostic pull model.
----
 ---@since 3.18.0
----@field diagnostic? lsp._anonym13.textDocument.diagnostic
-
----@class lsp._anonym14.workspace
----
----The server supports workspace folder.
----
----@since 3.6.0
----@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
----
----The server is interested in notifications/requests for operations on files.
+---@class lsp.ClientDiagnosticsTagOptions
 ---
----@since 3.16.0
----@field fileOperations? lsp.FileOperationOptions
+---The tags supported by the client.
+---@field valueSet lsp.DiagnosticTag[]
 
----@class lsp._anonym15.completionItem
----
----The server has support for completion item label
----details (see also `CompletionItemLabelDetails`) when
----receiving a completion item in a resolve call.
+---@since 3.18.0
+---@class lsp.ClientSemanticTokensRequestFullDelta
 ---
----@since 3.17.0
----@field labelDetailsSupport? boolean
+---The client will send the `textDocument/semanticTokens/full/delta` request if
+---the server provides a corresponding handler.
+---@field delta? boolean
 
----@class lsp._anonym17.notebookSelector.cells
+---A set of predefined token types. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
 ---
----@field language string
+---@since 3.16.0
+---@alias lsp.SemanticTokenTypes
+---| "namespace" # namespace
+---| "type" # type
+---| "class" # class
+---| "enum" # enum
+---| "interface" # interface
+---| "struct" # struct
+---| "typeParameter" # typeParameter
+---| "parameter" # parameter
+---| "variable" # variable
+---| "property" # property
+---| "enumMember" # enumMember
+---| "event" # event
+---| "function" # function
+---| "method" # method
+---| "macro" # macro
+---| "keyword" # keyword
+---| "modifier" # modifier
+---| "comment" # comment
+---| "string" # string
+---| "number" # number
+---| "regexp" # regexp
+---| "operator" # operator
+---| "decorator" # decorator
+---| "label" # label
 
----@class lsp._anonym16.notebookSelector
----
----The notebook to be synced If a string
----value is provided it matches against the
----notebook type. '*' matches every notebook.
----@field notebook string|lsp.NotebookDocumentFilter
+---A set of predefined token modifiers. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
 ---
----The cells of the matching notebook to be synced.
----@field cells? lsp._anonym17.notebookSelector.cells[]
+---@since 3.16.0
+---@alias lsp.SemanticTokenModifiers
+---| "declaration" # declaration
+---| "definition" # definition
+---| "readonly" # readonly
+---| "static" # static
+---| "deprecated" # deprecated
+---| "abstract" # abstract
+---| "async" # async
+---| "modification" # modification
+---| "documentation" # documentation
+---| "defaultLibrary" # defaultLibrary
 
----@class lsp._anonym19.notebookSelector.cells
+---The document diagnostic report kinds.
 ---
----@field language string
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReportKind
+---| "full" # Full
+---| "unchanged" # Unchanged
 
----@class lsp._anonym18.notebookSelector
----
----The notebook to be synced If a string
----value is provided it matches against the
----notebook type. '*' matches every notebook.
----@field notebook? string|lsp.NotebookDocumentFilter
----
----The cells of the matching notebook to be synced.
----@field cells lsp._anonym19.notebookSelector.cells[]
+---Predefined error codes.
+---@alias lsp.ErrorCodes
+---| -32700 # ParseError
+---| -32600 # InvalidRequest
+---| -32601 # MethodNotFound
+---| -32602 # InvalidParams
+---| -32603 # InternalError
+---| -32002 # ServerNotInitialized
+---| -32001 # UnknownErrorCode
 
----@class lsp._anonym20.staleRequestSupport
----
----The client will actively cancel the request.
----@field cancel boolean
----
----The list of requests for which the client
----will retry the request if it receives a
----response with error code `ContentModified`
----@field retryOnContentModified string[]
+---@alias lsp.LSPErrorCodes
+---| -32803 # RequestFailed
+---| -32802 # ServerCancelled
+---| -32801 # ContentModified
+---| -32800 # RequestCancelled
 
----@class lsp._anonym21.changeAnnotationSupport
----
----Whether the client groups edits with equal labels into tree nodes,
----for instance all edits labelled with "Changes in Strings" would
----be a tree node.
----@field groupsOnLabel? boolean
+---A set of predefined range kinds.
+---@alias lsp.FoldingRangeKind
+---| "comment" # Comment
+---| "imports" # Imports
+---| "region" # Region
 
----@class lsp._anonym22.symbolKind
----
----The symbol kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----
----If this property is not present the client only supports
----the symbol kinds from `File` to `Array` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.SymbolKind[]
+---A symbol kind.
+---@alias lsp.SymbolKind
+---| 1 # File
+---| 2 # Module
+---| 3 # Namespace
+---| 4 # Package
+---| 5 # Class
+---| 6 # Method
+---| 7 # Property
+---| 8 # Field
+---| 9 # Constructor
+---| 10 # Enum
+---| 11 # Interface
+---| 12 # Function
+---| 13 # Variable
+---| 14 # Constant
+---| 15 # String
+---| 16 # Number
+---| 17 # Boolean
+---| 18 # Array
+---| 19 # Object
+---| 20 # Key
+---| 21 # Null
+---| 22 # EnumMember
+---| 23 # Struct
+---| 24 # Event
+---| 25 # Operator
+---| 26 # TypeParameter
 
----@class lsp._anonym23.tagSupport
+---Symbol tags are extra annotations that tweak the rendering of a symbol.
 ---
----The tags supported by the client.
----@field valueSet lsp.SymbolTag[]
+---@since 3.16
+---@alias lsp.SymbolTag
+---| 1 # Deprecated
 
----@class lsp._anonym24.resolveSupport
+---Moniker uniqueness level to define scope of the moniker.
 ---
----The properties that a client can resolve lazily. Usually
----`location.range`
----@field properties string[]
+---@since 3.16.0
+---@alias lsp.UniquenessLevel
+---| "document" # document
+---| "project" # project
+---| "group" # group
+---| "scheme" # scheme
+---| "global" # global
 
----@class lsp._anonym26.completionItem.tagSupport
+---The moniker kind.
 ---
----The tags supported by the client.
----@field valueSet lsp.CompletionItemTag[]
+---@since 3.16.0
+---@alias lsp.MonikerKind
+---| "import" # import
+---| "export" # export
+---| "local" # local
 
----@class lsp._anonym27.completionItem.resolveSupport
+---Inlay hint kinds.
 ---
----The properties that a client can resolve lazily.
----@field properties string[]
+---@since 3.17.0
+---@alias lsp.InlayHintKind
+---| 1 # Type
+---| 2 # Parameter
 
----@class lsp._anonym28.completionItem.insertTextModeSupport
----
----@field valueSet lsp.InsertTextMode[]
+---The message type
+---@alias lsp.MessageType
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Info
+---| 4 # Log
+---| 5 # Debug
 
----@class lsp._anonym25.completionItem
----
----Client supports snippets as insert text.
----
----A snippet can define tab stops and placeholders with `$1`, `$2`
----and `${3:foo}`. `$0` defines the final tab stop, it defaults to
----the end of the snippet. Placeholders with equal identifiers are linked,
----that is typing in one will update others too.
----@field snippetSupport? boolean
----
----Client supports commit characters on a completion item.
----@field commitCharactersSupport? boolean
----
----Client supports the following content formats for the documentation
----property. The order describes the preferred format of the client.
----@field documentationFormat? lsp.MarkupKind[]
----
----Client supports the deprecated property on a completion item.
----@field deprecatedSupport? boolean
----
----Client supports the preselect property on a completion item.
----@field preselectSupport? boolean
----
----Client supports the tag property on a completion item. Clients supporting
----tags have to handle unknown tags gracefully. Clients especially need to
----preserve unknown tags when sending a completion item back to the server in
----a resolve call.
+---Defines how the host (editor) should sync
+---document changes to the language server.
+---@alias lsp.TextDocumentSyncKind
+---| 0 # None
+---| 1 # Full
+---| 2 # Incremental
+
+---Represents reasons why a text document is saved.
+---@alias lsp.TextDocumentSaveReason
+---| 1 # Manual
+---| 2 # AfterDelay
+---| 3 # FocusOut
+
+---The kind of a completion entry.
+---@alias lsp.CompletionItemKind
+---| 1 # Text
+---| 2 # Method
+---| 3 # Function
+---| 4 # Constructor
+---| 5 # Field
+---| 6 # Variable
+---| 7 # Class
+---| 8 # Interface
+---| 9 # Module
+---| 10 # Property
+---| 11 # Unit
+---| 12 # Value
+---| 13 # Enum
+---| 14 # Keyword
+---| 15 # Snippet
+---| 16 # Color
+---| 17 # File
+---| 18 # Reference
+---| 19 # Folder
+---| 20 # EnumMember
+---| 21 # Constant
+---| 22 # Struct
+---| 23 # Event
+---| 24 # Operator
+---| 25 # TypeParameter
+
+---Completion item tags are extra annotations that tweak the rendering of a completion
+---item.
 ---
 ---@since 3.15.0
----@field tagSupport? lsp._anonym26.completionItem.tagSupport
----
----Client support insert replace edit to control different behavior if a
----completion item is inserted in the text or should replace text.
----
----@since 3.16.0
----@field insertReplaceSupport? boolean
----
----Indicates which properties a client can resolve lazily on a completion
----item. Before version 3.16.0 only the predefined properties `documentation`
----and `details` could be resolved lazily.
----
----@since 3.16.0
----@field resolveSupport? lsp._anonym27.completionItem.resolveSupport
----
----The client supports the `insertTextMode` property on
----a completion item to override the whitespace handling mode
----as defined by the client (see `insertTextMode`).
+---@alias lsp.CompletionItemTag
+---| 1 # Deprecated
+
+---Defines whether the insert text in a completion item should be interpreted as
+---plain text or a snippet.
+---@alias lsp.InsertTextFormat
+---| 1 # PlainText
+---| 2 # Snippet
+
+---How whitespace and indentation is handled during completion
+---item insertion.
 ---
 ---@since 3.16.0
----@field insertTextModeSupport? lsp._anonym28.completionItem.insertTextModeSupport
----
----The client has support for completion item label
----details (see also `CompletionItemLabelDetails`).
----
----@since 3.17.0
----@field labelDetailsSupport? boolean
+---@alias lsp.InsertTextMode
+---| 1 # asIs
+---| 2 # adjustIndentation
 
----@class lsp._anonym29.completionItemKind
----
----The completion item kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----
----If this property is not present the client only supports
----the completion items kinds from `Text` to `Reference` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.CompletionItemKind[]
+---A document highlight kind.
+---@alias lsp.DocumentHighlightKind
+---| 1 # Text
+---| 2 # Read
+---| 3 # Write
 
----@class lsp._anonym30.completionList
----
----The client supports the following itemDefaults on
----a completion list.
----
----The value lists the supported property names of the
----`CompletionList.itemDefaults` object. If omitted
----no properties are supported.
----
----@since 3.17.0
----@field itemDefaults? string[]
+---A set of predefined code action kinds
+---@alias lsp.CodeActionKind
+---| "" # Empty
+---| "quickfix" # QuickFix
+---| "refactor" # Refactor
+---| "refactor.extract" # RefactorExtract
+---| "refactor.inline" # RefactorInline
+---| "refactor.move" # RefactorMove
+---| "refactor.rewrite" # RefactorRewrite
+---| "source" # Source
+---| "source.organizeImports" # SourceOrganizeImports
+---| "source.fixAll" # SourceFixAll
+---| "notebook" # Notebook
 
----@class lsp._anonym32.signatureInformation.parameterInformation
----
----The client supports processing label offsets instead of a
----simple label string.
----
----@since 3.14.0
----@field labelOffsetSupport? boolean
+---@alias lsp.TraceValue
+---| "off" # Off
+---| "messages" # Messages
+---| "verbose" # Verbose
 
----@class lsp._anonym31.signatureInformation
----
----Client supports the following content formats for the documentation
----property. The order describes the preferred format of the client.
----@field documentationFormat? lsp.MarkupKind[]
----
----Client capabilities specific to parameter information.
----@field parameterInformation? lsp._anonym32.signatureInformation.parameterInformation
----
----The client supports the `activeParameter` property on `SignatureInformation`
----literal.
----
----@since 3.16.0
----@field activeParameterSupport? boolean
----
----The client supports the `activeParameter` property on
----`SignatureInformation` being set to `null` to indicate that no
----parameter should be active.
+---Describes the content type that a client supports in various
+---result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
 ---
+---Please note that `MarkupKinds` must not start with a `$`. This kinds
+---are reserved for internal usage.
+---@alias lsp.MarkupKind
+---| "plaintext" # PlainText
+---| "markdown" # Markdown
+
+---Predefined Language kinds
 ---@since 3.18.0
----@field noActiveParameterSupport? boolean
+---@proposed
+---@alias lsp.LanguageKind
+---| "abap" # ABAP
+---| "bat" # WindowsBat
+---| "bibtex" # BibTeX
+---| "clojure" # Clojure
+---| "coffeescript" # Coffeescript
+---| "c" # C
+---| "cpp" # CPP
+---| "csharp" # CSharp
+---| "css" # CSS
+---| "d" # D
+---| "pascal" # Delphi
+---| "diff" # Diff
+---| "dart" # Dart
+---| "dockerfile" # Dockerfile
+---| "elixir" # Elixir
+---| "erlang" # Erlang
+---| "fsharp" # FSharp
+---| "git-commit" # GitCommit
+---| "rebase" # GitRebase
+---| "go" # Go
+---| "groovy" # Groovy
+---| "handlebars" # Handlebars
+---| "haskell" # Haskell
+---| "html" # HTML
+---| "ini" # Ini
+---| "java" # Java
+---| "javascript" # JavaScript
+---| "javascriptreact" # JavaScriptReact
+---| "json" # JSON
+---| "latex" # LaTeX
+---| "less" # Less
+---| "lua" # Lua
+---| "makefile" # Makefile
+---| "markdown" # Markdown
+---| "objective-c" # ObjectiveC
+---| "objective-cpp" # ObjectiveCPP
+---| "pascal" # Pascal
+---| "perl" # Perl
+---| "perl6" # Perl6
+---| "php" # PHP
+---| "powershell" # Powershell
+---| "jade" # Pug
+---| "python" # Python
+---| "r" # R
+---| "razor" # Razor
+---| "ruby" # Ruby
+---| "rust" # Rust
+---| "scss" # SCSS
+---| "sass" # SASS
+---| "scala" # Scala
+---| "shaderlab" # ShaderLab
+---| "shellscript" # ShellScript
+---| "sql" # SQL
+---| "swift" # Swift
+---| "typescript" # TypeScript
+---| "typescriptreact" # TypeScriptReact
+---| "tex" # TeX
+---| "vb" # VisualBasic
+---| "xml" # XML
+---| "xsl" # XSL
+---| "yaml" # YAML
 
----@class lsp._anonym33.symbolKind
+---Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
 ---
----The symbol kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
+---@since 3.18.0
+---@proposed
+---@alias lsp.InlineCompletionTriggerKind
+---| 1 # Invoked
+---| 2 # Automatic
+
+---A set of predefined position encoding kinds.
 ---
----If this property is not present the client only supports
----the symbol kinds from `File` to `Array` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.SymbolKind[]
+---@since 3.17.0
+---@alias lsp.PositionEncodingKind
+---| "utf-8" # UTF8
+---| "utf-16" # UTF16
+---| "utf-32" # UTF32
+
+---The file event type
+---@alias lsp.FileChangeType
+---| 1 # Created
+---| 2 # Changed
+---| 3 # Deleted
+
+---@alias lsp.WatchKind
+---| 1 # Create
+---| 2 # Change
+---| 4 # Delete
+
+---The diagnostic's severity.
+---@alias lsp.DiagnosticSeverity
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Information
+---| 4 # Hint
 
----@class lsp._anonym34.tagSupport
+---The diagnostic tags.
 ---
----The tags supported by the client.
----@field valueSet lsp.SymbolTag[]
+---@since 3.15.0
+---@alias lsp.DiagnosticTag
+---| 1 # Unnecessary
+---| 2 # Deprecated
 
----@class lsp._anonym36.codeActionLiteralSupport.codeActionKind
----
----The code action kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----@field valueSet lsp.CodeActionKind[]
+---How a completion was triggered
+---@alias lsp.CompletionTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # TriggerForIncompleteCompletions
 
----@class lsp._anonym35.codeActionLiteralSupport
+---How a signature help was triggered.
 ---
----The code action kind is support with the following value
----set.
----@field codeActionKind lsp._anonym36.codeActionLiteralSupport.codeActionKind
+---@since 3.15.0
+---@alias lsp.SignatureHelpTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # ContentChange
 
----@class lsp._anonym37.resolveSupport
+---The reason why code actions were requested.
 ---
----The properties that a client can resolve lazily.
----@field properties string[]
+---@since 3.17.0
+---@alias lsp.CodeActionTriggerKind
+---| 1 # Invoked
+---| 2 # Automatic
 
----@class lsp._anonym38.foldingRangeKind
+---A pattern kind describing if a glob pattern matches a file a folder or
+---both.
 ---
----The folding range kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----@field valueSet? lsp.FoldingRangeKind[]
+---@since 3.16.0
+---@alias lsp.FileOperationPatternKind
+---| "file" # file
+---| "folder" # folder
 
----@class lsp._anonym39.foldingRange
----
----If set, the client signals that it supports setting collapsedText on
----folding ranges to display custom labels instead of the default text.
+---A notebook cell kind.
 ---
 ---@since 3.17.0
----@field collapsedText? boolean
+---@alias lsp.NotebookCellKind
+---| 1 # Markup
+---| 2 # Code
 
----@class lsp._anonym40.tagSupport
----
----The tags supported by the client.
----@field valueSet lsp.DiagnosticTag[]
+---@alias lsp.ResourceOperationKind
+---| "create" # Create
+---| "rename" # Rename
+---| "delete" # Delete
 
----@class lsp._anonym42.requests.range
+---@alias lsp.FailureHandlingKind
+---| "abort" # Abort
+---| "transactional" # Transactional
+---| "textOnlyTransactional" # TextOnlyTransactional
+---| "undo" # Undo
 
----@class lsp._anonym43.requests.full
----
----The client will send the `textDocument/semanticTokens/full/delta` request if
----the server provides a corresponding handler.
----@field delta? boolean
+---@alias lsp.PrepareSupportDefaultBehavior
+---| 1 # Identifier
 
----@class lsp._anonym41.requests
----
----The client will send the `textDocument/semanticTokens/range` request if
----the server provides a corresponding handler.
----@field range? boolean|lsp._anonym42.requests.range
----
----The client will send the `textDocument/semanticTokens/full` request if
----the server provides a corresponding handler.
----@field full? boolean|lsp._anonym43.requests.full
+---@alias lsp.TokenFormat
+---| "relative" # Relative
 
----@class lsp._anonym44.resolveSupport
+---The definition of a symbol represented as one or many {@link Location locations}.
+---For most programming languages there is only one location at which a symbol is
+---defined.
 ---
----The properties that a client can resolve lazily.
----@field properties string[]
+---Servers should prefer returning `DefinitionLink` over `Definition` if supported
+---by the client.
+---@alias lsp.Definition lsp.Location|lsp.Location[]
 
----@class lsp._anonym45.messageActionItem
+---Information about where a symbol is defined.
 ---
----Whether the client supports additional attributes which
----are preserved and send back to the server in the
----request's response.
----@field additionalPropertiesSupport? boolean
+---Provides additional metadata over normal {@link Location location} definitions, including the range of
+---the defining symbol
+---@alias lsp.DefinitionLink lsp.LocationLink
 
----@class lsp._anonym46.PrepareRenameResult
----
----@field range lsp.Range
----
----@field placeholder string
+---LSP arrays.
+---@since 3.17.0
+---@alias lsp.LSPArray lsp.LSPAny[]
 
----@class lsp._anonym47.PrepareRenameResult
----
----@field defaultBehavior boolean
+---The LSP any type.
+---Please note that strictly speaking a property with the value `undefined`
+---can't be converted into JSON preserving the property name. However for
+---convenience it is allowed and assumed that all these properties are
+---optional as well.
+---@since 3.17.0
+---@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|integer|uinteger|decimal|boolean|lsp.null
 
----@class lsp._anonym48.TextDocumentContentChangeEvent
----
----The range of the document that changed.
----@field range lsp.Range
----
----The optional length of the range that got replaced.
+---The declaration of a symbol representation as one or many {@link Location locations}.
+---@alias lsp.Declaration lsp.Location|lsp.Location[]
+
+---Information about where a symbol is declared.
 ---
----@deprecated use range instead.
----@field rangeLength? uinteger
+---Provides additional metadata over normal {@link Location location} declarations, including the range of
+---the declaring symbol.
 ---
----The new text for the provided range.
----@field text string
+---Servers should prefer returning `DeclarationLink` over `Declaration` if supported
+---by the client.
+---@alias lsp.DeclarationLink lsp.LocationLink
 
----@class lsp._anonym49.TextDocumentContentChangeEvent
+---Inline value information can be provided by different means:
+---- directly as a text value (class InlineValueText).
+---- as a name to use for a variable lookup (class InlineValueVariableLookup)
+---- as an evaluatable expression (class InlineValueEvaluatableExpression)
+---The InlineValue types combines all inline value types into one type.
 ---
----The new text of the whole document.
----@field text string
+---@since 3.17.0
+---@alias lsp.InlineValue lsp.InlineValueText|lsp.InlineValueVariableLookup|lsp.InlineValueEvaluatableExpression
 
----@class lsp._anonym50.MarkedString
----
----@field language string
+---The result of a document diagnostic pull request. A report can
+---either be a full report containing all diagnostics for the
+---requested document or an unchanged report indicating that nothing
+---has changed in terms of diagnostics in comparison to the last
+---pull request.
 ---
----@field value string
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
 
----@class lsp._anonym51.TextDocumentFilter
----
----A language id, like `typescript`.
----@field language string
----
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
----
----A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
----@field pattern? string
+---@alias lsp.PrepareRenameResult lsp.Range|lsp.PrepareRenamePlaceholder|lsp.PrepareRenameDefaultBehavior
 
----@class lsp._anonym52.TextDocumentFilter
----
----A language id, like `typescript`.
----@field language? string
+---A document selector is the combination of one or many document filters.
 ---
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme string
+---\@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
 ---
----A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
----@field pattern? string
+---The use of a string as a document filter is deprecated @since 3.16.0.
+---@alias lsp.DocumentSelector lsp.DocumentFilter[]
+
+---@alias lsp.ProgressToken integer|string
 
----@class lsp._anonym53.TextDocumentFilter
+---An identifier to refer to a change annotation stored with a workspace edit.
+---@alias lsp.ChangeAnnotationIdentifier string
+
+---A workspace diagnostic document report.
 ---
----A language id, like `typescript`.
----@field language? string
+---@since 3.17.0
+---@alias lsp.WorkspaceDocumentDiagnosticReport lsp.WorkspaceFullDocumentDiagnosticReport|lsp.WorkspaceUnchangedDocumentDiagnosticReport
+
+---An event describing a change to a text document. If only a text is provided
+---it is considered to be the full content of the document.
+---@alias lsp.TextDocumentContentChangeEvent lsp.TextDocumentContentChangePartial|lsp.TextDocumentContentChangeWholeDocument
+
+---MarkedString can be used to render human readable text. It is either a markdown string
+---or a code-block that provides a language and a code snippet. The language identifier
+---is semantically equal to the optional language identifier in fenced code blocks in GitHub
+---issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
 ---
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
+---The pair of a language and a value is an equivalent to markdown:
+---```${language}
+---${value}
+---```
 ---
----A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
----@field pattern string
+---Note that markdown strings will be sanitized - that means html will be escaped.
+---@deprecated use MarkupContent instead.
+---@alias lsp.MarkedString string|lsp.MarkedStringWithLanguage
 
----@class lsp._anonym54.NotebookDocumentFilter
----
----The type of the enclosing notebook.
----@field notebookType string
+---A document filter describes a top level text document or
+---a notebook cell document.
 ---
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
+---@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+---@alias lsp.DocumentFilter lsp.TextDocumentFilter|lsp.NotebookCellTextDocumentFilter
+
+---LSP object definition.
+---@since 3.17.0
+---@alias lsp.LSPObject table<string, lsp.LSPAny>
+
+---The glob pattern. Either a string pattern or a relative pattern.
 ---
----A glob pattern.
----@field pattern? string
+---@since 3.17.0
+---@alias lsp.GlobPattern lsp.Pattern|lsp.RelativePattern
 
----@class lsp._anonym55.NotebookDocumentFilter
+---A document filter denotes a document by different properties like
+---the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
+---its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
 ---
----The type of the enclosing notebook.
----@field notebookType? string
+---Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
 ---
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme string
+---\@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+---\@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
 ---
----A glob pattern.
----@field pattern? string
+---@since 3.17.0
+---@alias lsp.TextDocumentFilter lsp.TextDocumentFilterLanguage|lsp.TextDocumentFilterScheme|lsp.TextDocumentFilterPattern
 
----@class lsp._anonym56.NotebookDocumentFilter
----
----The type of the enclosing notebook.
----@field notebookType? string
+---A notebook document filter denotes a notebook document by
+---different properties. The properties will be match
+---against the notebook's URI (same as with documents)
 ---
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
+---@since 3.17.0
+---@alias lsp.NotebookDocumentFilter lsp.NotebookDocumentFilterNotebookType|lsp.NotebookDocumentFilterScheme|lsp.NotebookDocumentFilterPattern
+
+---The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
 ---
----A glob pattern.
----@field pattern string
+---@since 3.17.0
+---@alias lsp.Pattern string
+
+---@alias lsp.RegularExpressionEngineKind string
+
+---@class lsp._anonym1.range
+
+---@class lsp._anonym2.range
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 2514a62f89..0eb10af1ea 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -615,9 +615,10 @@ function protocol.resolve_capabilities(server_capabilities)
 end
 
 -- Generated by gen_lsp.lua, keep at end of file.
---- LSP method names.
 ---
+---@enum vim.lsp.protocol.Methods
 ---@see https://microsoft.github.io/language-server-protocol/specification/#metaModel
+--- LSP method names.
 protocol.Methods = {
   --- A request to resolve the incoming calls for a given `CallHierarchyItem`.
   --- @since 3.16.0
@@ -880,14 +881,14 @@ protocol.Methods = {
   --- symbol's location.
   --- @since 3.17.0
   workspaceSymbol_resolve = 'workspaceSymbol/resolve',
-  --- A request sent from the server to the client to modify certain resources.
+  --- A request sent from the server to the client to modified certain resources.
   workspace_applyEdit = 'workspace/applyEdit',
   --- A request to refresh all code actions
   --- @since 3.16.0
   workspace_codeLens_refresh = 'workspace/codeLens/refresh',
   --- The 'workspace/configuration' request is sent from the server to the client to fetch a certain
   --- configuration setting.
-  --- This pull model replaces the old push model where the client signaled configuration change via an
+  --- This pull model replaces the old push model were the client signaled configuration change via an
   --- event. If the server still needs to react to configuration changes (since the server caches the
   --- result of `workspace/configuration` requests) the server should register for an empty configuration
   --- change event and empty the cache if such an event is received.
@@ -920,7 +921,7 @@ protocol.Methods = {
   --- files were renamed from within the client.
   --- @since 3.16.0
   workspace_didRenameFiles = 'workspace/didRenameFiles',
-  --- A request sent from the client to the server to execute a command. The request might return
+  --- A request send from the client to the server to execute a command. The request might return
   --- a workspace edit which the client will apply to the workspace.
   workspace_executeCommand = 'workspace/executeCommand',
   --- @since 3.18.0
-- 
cgit 


From e48179f31e6503bfa86bf08538e64456e96446a8 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Thu, 22 Aug 2024 15:51:44 +0800
Subject: fix(lsp): suppress completion request if completion is active
 (#30028)

Problem: the autotrigger mechanism could fire completion requests despite
completion already being active from another completion mechanism or manual
trigger

Solution: add a condition to avoid an additional request.
---
 runtime/lua/vim/lsp/completion.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 6a6659fd25..022edf5fab 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -403,6 +403,10 @@ local function trigger(bufnr, clients)
   reset_timer()
   Context:cancel_pending()
 
+  if tonumber(vim.fn.pumvisible()) == 1 and Context.isIncomplete then
+    return
+  end
+
   local win = api.nvim_get_current_win()
   local cursor_row, cursor_col = unpack(api.nvim_win_get_cursor(win)) --- @type integer, integer
   local line = api.nvim_get_current_line()
-- 
cgit 


From 1f5bcc7c4ed7a68ae4e23933aee04c50b4df8bb5 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Fri, 23 Aug 2024 03:42:27 +0800
Subject: feat(lsp): completion opts support custom item conversion (#30060)

Problem: Some items of completion results include function signatures that can
cause the pum to be very long when a function has many params, because pum
scales with the longest word/abbr.

Solution: add custom covert function that can customise abbr to remove params.
---
 runtime/lua/vim/lsp/completion.lua | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 022edf5fab..89d9a0e9b1 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -23,6 +23,7 @@ local ns_to_ms = 0.000001
 --- @class vim.lsp.completion.BufHandle
 --- @field clients table<integer, vim.lsp.Client>
 --- @field triggers table<string, vim.lsp.Client[]>
+--- @field convert? fun(item: lsp.CompletionItem): table
 
 --- @type table<integer, vim.lsp.completion.BufHandle>
 local buf_handles = {}
@@ -250,6 +251,8 @@ function M._lsp_to_complete_items(result, prefix, client_id)
   end
 
   local candidates = {}
+  local bufnr = api.nvim_get_current_buf()
+  local user_convert = vim.tbl_get(buf_handles, bufnr, 'convert')
   for _, item in ipairs(items) do
     if matches(item) then
       local word = get_completion_word(item)
@@ -260,7 +263,7 @@ function M._lsp_to_complete_items(result, prefix, client_id)
       then
         hl_group = 'DiagnosticDeprecated'
       end
-      table.insert(candidates, {
+      local completion_item = {
         word = word,
         abbr = item.label,
         kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
@@ -278,7 +281,11 @@ function M._lsp_to_complete_items(result, prefix, client_id)
             },
           },
         },
-      })
+      }
+      if user_convert then
+        completion_item = vim.tbl_extend('keep', user_convert(item), completion_item)
+      end
+      table.insert(candidates, completion_item)
     end
   end
   ---@diagnostic disable-next-line: no-unknown
@@ -590,14 +597,15 @@ end
 
 --- @class vim.lsp.completion.BufferOpts
 --- @field autotrigger? boolean Whether to trigger completion automatically. Default: false
+--- @field convert? fun(item: lsp.CompletionItem): table An optional function used to customize the transformation of an LSP CompletionItem to |complete-items|.
 
---- @param client_id integer
+---@param client_id integer
 ---@param bufnr integer
 ---@param opts vim.lsp.completion.BufferOpts
 local function enable_completions(client_id, bufnr, opts)
   local buf_handle = buf_handles[bufnr]
   if not buf_handle then
-    buf_handle = { clients = {}, triggers = {} }
+    buf_handle = { clients = {}, triggers = {}, convert = opts.convert }
     buf_handles[bufnr] = buf_handle
 
     -- Attach to buffer events.
-- 
cgit 


From 983953858e5610b104d35725c7da1e9025f60421 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Mon, 26 Aug 2024 17:34:54 +0200
Subject: fix(lsp): fix isIncomplete condition in completion trigger (#30130)

Follow up to https://github.com/neovim/neovim/pull/30028#discussion_r1726539370
---
 runtime/lua/vim/lsp/completion.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 89d9a0e9b1..e28fec5e25 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -410,7 +410,7 @@ local function trigger(bufnr, clients)
   reset_timer()
   Context:cancel_pending()
 
-  if tonumber(vim.fn.pumvisible()) == 1 and Context.isIncomplete then
+  if tonumber(vim.fn.pumvisible()) == 1 and not Context.isIncomplete then
     return
   end
 
-- 
cgit 


From 0e394f136fcb030358dbc1e94a0a38a03b4b7dbf Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 26 Aug 2024 08:35:43 -0700
Subject: fix(lsp): log when receiving markup messages (#30065)

---
 runtime/lua/vim/lsp/diagnostic.lua | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 5ed42700e3..ff52b40d60 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -110,6 +110,14 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
   return vim.tbl_map(function(diagnostic)
     local start = diagnostic.range.start
     local _end = diagnostic.range['end']
+    local message = diagnostic.message
+    if type(message) ~= 'string' then
+      vim.notify_once(
+        string.format('Unsupported Markup message from LSP client %d', client_id),
+        vim.lsp.log_levels.ERROR
+      )
+      message = diagnostic.message.value
+    end
     --- @type vim.Diagnostic
     return {
       lnum = start.line,
@@ -117,7 +125,7 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
       end_lnum = _end.line,
       end_col = line_byte_from_position(buf_lines, _end.line, _end.character, offset_encoding),
       severity = severity_lsp_to_vim(diagnostic.severity),
-      message = diagnostic.message,
+      message = message,
       source = diagnostic.source,
       code = diagnostic.code,
       _tags = tags_lsp_to_vim(diagnostic, client_id),
-- 
cgit 


From d9ccd828b0d46754b9bcb9b17f47c2a51968db05 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 26 Aug 2024 08:37:36 -0700
Subject: fix(lsp): return call hierarchy item, not the index (#30145)

---
 runtime/lua/vim/lsp/buf.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index d7463d74f8..e51727ef13 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -464,7 +464,7 @@ local function pick_call_hierarchy_item(call_hierarchy_items)
   if choice < 1 or choice > #items then
     return
   end
-  return choice
+  return call_hierarchy_items[choice]
 end
 
 --- @param method string
-- 
cgit 


From dad55f5e763f3f2f436a2ae4f4bb1f6c6442bb45 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Tue, 27 Aug 2024 11:16:33 -0700
Subject: feat(lsp): export diagnostic conversion functions (#30064)

---
 runtime/lua/vim/lsp/diagnostic.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index ff52b40d60..c10312484b 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -153,9 +153,10 @@ local function tags_vim_to_lsp(diagnostic)
   return tags
 end
 
+--- Converts the input `vim.Diagnostic`s to LSP diagnostics.
 --- @param diagnostics vim.Diagnostic[]
 --- @return lsp.Diagnostic[]
-local function diagnostic_vim_to_lsp(diagnostics)
+function M.from(diagnostics)
   ---@param diagnostic vim.Diagnostic
   ---@return lsp.Diagnostic
   return vim.tbl_map(function(diagnostic)
@@ -385,7 +386,7 @@ function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
 
   diag_opts.lnum = line_nr or (api.nvim_win_get_cursor(0)[1] - 1)
 
-  return diagnostic_vim_to_lsp(vim.diagnostic.get(bufnr, diag_opts))
+  return M.from(vim.diagnostic.get(bufnr, diag_opts))
 end
 
 --- Clear diagnostics from pull based clients
-- 
cgit 


From 42ed0ffad9851f3794a9dff080a2789c87c6d7c8 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Sat, 31 Aug 2024 02:23:49 +0800
Subject: fix(lsp): when prefix is non word add all result into matches
 (#30044)

Problem: prefix can be a symbol like period, the fuzzy matching can't
handle it correctly.

Solution: when prefix is empty or a symbol add all lsp completion
result into matches.
---
 runtime/lua/vim/lsp/completion.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index e28fec5e25..89d6d0e8b9 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -238,7 +238,7 @@ function M._lsp_to_complete_items(result, prefix, client_id)
 
   ---@type fun(item: lsp.CompletionItem):boolean
   local matches
-  if prefix == '' then
+  if not prefix:find('%w') then
     matches = function(_)
       return true
     end
-- 
cgit 


From 61e9137394fc5229e582a64316c2ffef55d8d7af Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sun, 1 Sep 2024 13:01:24 -0700
Subject: docs: misc #28970

---
 runtime/lua/vim/lsp/completion.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
index 89d6d0e8b9..71ea2df100 100644
--- a/runtime/lua/vim/lsp/completion.lua
+++ b/runtime/lua/vim/lsp/completion.lua
@@ -597,7 +597,7 @@ end
 
 --- @class vim.lsp.completion.BufferOpts
 --- @field autotrigger? boolean Whether to trigger completion automatically. Default: false
---- @field convert? fun(item: lsp.CompletionItem): table An optional function used to customize the transformation of an LSP CompletionItem to |complete-items|.
+--- @field convert? fun(item: lsp.CompletionItem): table Transforms an LSP CompletionItem to |complete-items|.
 
 ---@param client_id integer
 ---@param bufnr integer
-- 
cgit 


From bcae8be91f9fd4967f0c6f6ffabf59702253949b Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Sun, 1 Sep 2024 23:46:01 +0100
Subject: docs: vim.lsp.rpc.connect() TCP requires IP address #30219

"localhost" would work if we used
[tcp_connect](https://github.com/luvit/luv/blob/ae0387742b460bc89ebddce33214ad65fffddba2/examples/echo-server-client.lua#L42),
but that will require changes to
[vim.lsp.rpc.connect](https://github.com/neovim/neovim/blob/318c0415d5b10b44fee4afa06994734f1beb7e71/runtime/lua/vim/lsp/rpc.lua#L638).
---
 runtime/lua/vim/lsp/rpc.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 7acb67b25e..a9c6723094 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -627,12 +627,12 @@ end
 ---
 ---  - a named pipe (windows)
 ---  - a domain socket (unix)
----  - a host and port via TCP
+---  - a host and port via TCP (host must be IP address)
 ---
 --- Return a function that can be passed to the `cmd` field for
 --- |vim.lsp.start_client()| or |vim.lsp.start()|.
 ---
----@param host_or_path string host to connect to or path to a pipe/domain socket
+---@param host_or_path string host (IP address) to connect to or path to a pipe/domain socket
 ---@param port integer? TCP port to connect to. If absent the first argument must be a pipe
 ---@return fun(dispatchers: vim.lsp.rpc.Dispatchers): vim.lsp.rpc.PublicClient
 function M.connect(host_or_path, port)
-- 
cgit 


From 45e76acaa053a077cab49b6606536d3f2646f033 Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Tue, 3 Sep 2024 16:10:39 +0100
Subject: feat(lsp): support hostname in rpc.connect #30238

Updated the `rpc.connect` function to support connecting to LSP servers
using hostnames, not just IP addresses. This change includes updates to
the documentation and additional test cases to verify the new
functionality.

- Modified `connect` function to resolve hostnames.
- Updated documentation to reflect the change.
- Added test case for connecting using hostname.

Added a TCP echo server utility function to the LSP test suite. This
server echoes the first message it receives and is used in tests to
verify LSP server connections via both IP address and hostname.
Refactored existing tests to use the new utility function.
---
 runtime/lua/vim/lsp/rpc.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index a9c6723094..d81eae20d1 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -627,12 +627,12 @@ end
 ---
 ---  - a named pipe (windows)
 ---  - a domain socket (unix)
----  - a host and port via TCP (host must be IP address)
+---  - a host and port via TCP
 ---
 --- Return a function that can be passed to the `cmd` field for
 --- |vim.lsp.start_client()| or |vim.lsp.start()|.
 ---
----@param host_or_path string host (IP address) to connect to or path to a pipe/domain socket
+---@param host_or_path string host to connect to or path to a pipe/domain socket
 ---@param port integer? TCP port to connect to. If absent the first argument must be a pipe
 ---@return fun(dispatchers: vim.lsp.rpc.Dispatchers): vim.lsp.rpc.PublicClient
 function M.connect(host_or_path, port)
@@ -703,7 +703,9 @@ function M.connect(host_or_path, port)
     if port == nil then
       handle:connect(host_or_path, on_connect)
     else
-      handle:connect(host_or_path, port, on_connect)
+      local info = uv.getaddrinfo(host_or_path, nil)
+      local resolved_host = info and info[1] and info[1].addr or host_or_path
+      handle:connect(resolved_host, port, on_connect)
     end
 
     return public_client(client)
-- 
cgit 


From 882a450a2982caa05fcbbe90e94246a8c2b45b8b Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Thu, 5 Sep 2024 08:23:11 +0100
Subject: fix(lsp): handle locations exceeding line length #30253

Problem:
LSP spec [states](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position)
that "if the character value is greater than the line length it defaults
back to the line length", but `locations_to_items` fails in that case.

Solution:
Adjust locations_to_items to follow the spec.

closes #28281
---
 runtime/lua/vim/lsp/util.lua | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index cbbe3a66b7..ec66449b54 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1795,8 +1795,18 @@ function M.locations_to_items(locations, offset_encoding)
       local row = pos.line
       local end_row = end_pos.line
       local line = lines[row] or ''
-      local col = M._str_byteindex_enc(line, pos.character, offset_encoding)
-      local end_col = M._str_byteindex_enc(lines[end_row] or '', end_pos.character, offset_encoding)
+      local line_len = vim.fn.strcharlen(line)
+      local end_line = lines[end_row] or ''
+      local end_line_len = vim.fn.strcharlen(end_line)
+      -- LSP spec: if character > line length, default to the line length.
+      -- https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
+      local col = pos.character <= line_len
+          and M._str_byteindex_enc(line, pos.character, offset_encoding)
+        or line_len
+      local end_col = end_pos.character <= end_line_len
+          and M._str_byteindex_enc(end_line, end_pos.character, offset_encoding)
+        or end_line_len
+
       table.insert(items, {
         filename = filename,
         lnum = row + 1,
-- 
cgit 


From 003b8a251dc1184e36c222f675bf79a50a40ab3a Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Sun, 8 Sep 2024 11:44:46 +0100
Subject: fix(lsp): handle out-of-bounds character positions #30288

Problem:
str_byteindex_enc could return an error if the index was longer than the
lline length. This was handled in each of the calls to it individually

Solution:
* Fix the call at the source level so that if the index is higher than
  the line length, line length is returned as per LSP specification
* Remove pcalls on str_byteindex_enc calls. No longer needed now that
  str_byteindex_enc has a bounds check.
---
 runtime/lua/vim/lsp/inlay_hint.lua      |  7 +------
 runtime/lua/vim/lsp/semantic_tokens.lua |  7 +------
 runtime/lua/vim/lsp/util.lua            | 31 ++++++++++++-------------------
 3 files changed, 14 insertions(+), 31 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 1e224d1bef..4483b083de 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -77,12 +77,7 @@ function M.on_inlayhint(err, result, ctx, _)
     local col = position.character
     if col > 0 then
       local line = lines[position.line + 1] or ''
-      local ok, convert_result
-      ok, convert_result = pcall(util._str_byteindex_enc, line, col, client.offset_encoding)
-      if ok then
-        return convert_result
-      end
-      return math.min(#line, col)
+      return util._str_byteindex_enc(line, col, client.offset_encoding)
     end
     return col
   end
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 2ae86851d1..8182457dd0 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -140,12 +140,7 @@ local function tokens_to_ranges(data, bufnr, client, request)
     local function _get_byte_pos(col)
       if col > 0 then
         local buf_line = lines[line + 1] or ''
-        local ok, result
-        ok, result = pcall(util._str_byteindex_enc, buf_line, col, client.offset_encoding)
-        if ok then
-          return result
-        end
-        return math.min(#buf_line, col)
+        return util._str_byteindex_enc(buf_line, col, client.offset_encoding)
       end
       return col
     end
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index ec66449b54..5046459645 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -147,6 +147,12 @@ end
 ---@param encoding string utf-8|utf-16|utf-32| defaults to utf-16
 ---@return integer byte (utf-8) index of `encoding` index `index` in `line`
 function M._str_byteindex_enc(line, index, encoding)
+  local len = vim.fn.strlen(line)
+  if index > len then
+    -- LSP spec: if character > line length, default to the line length.
+    -- https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
+    return len
+  end
   if not encoding then
     encoding = 'utf-16'
   end
@@ -166,7 +172,6 @@ function M._str_byteindex_enc(line, index, encoding)
 end
 
 local _str_utfindex_enc = M._str_utfindex_enc
-local _str_byteindex_enc = M._str_byteindex_enc
 
 --- Replaces text in a range with new text.
 ---
@@ -334,12 +339,7 @@ local function get_line_byte_from_position(bufnr, position, offset_encoding)
   -- character
   if col > 0 then
     local line = get_line(bufnr, position.line) or ''
-    local ok, result
-    ok, result = pcall(_str_byteindex_enc, line, col, offset_encoding)
-    if ok then
-      return result
-    end
-    return math.min(#line, col)
+    return M._str_byteindex_enc(line, col, offset_encoding or 'utf-16')
   end
   return col
 end
@@ -436,14 +436,15 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
         e.end_col = last_line_len
         has_eol_text_edit = true
       else
-        -- If the replacement is over the end of a line (i.e. e.end_col is out of bounds and the
+        -- If the replacement is over the end of a line (i.e. e.end_col is equal to the line length and the
         -- replacement text ends with a newline We can likely assume that the replacement is assumed
         -- to be meant to replace the newline with another newline and we need to make sure this
         -- doesn't add an extra empty line. E.g. when the last line to be replaced contains a '\r'
         -- in the file some servers (clangd on windows) will include that character in the line
         -- while nvim_buf_set_text doesn't count it as part of the line.
         if
-          e.end_col > last_line_len
+          e.end_col >= last_line_len
+          and text_edit.range['end'].character > e.end_col
           and #text_edit.newText > 0
           and string.sub(text_edit.newText, -1) == '\n'
         then
@@ -1795,17 +1796,9 @@ function M.locations_to_items(locations, offset_encoding)
       local row = pos.line
       local end_row = end_pos.line
       local line = lines[row] or ''
-      local line_len = vim.fn.strcharlen(line)
       local end_line = lines[end_row] or ''
-      local end_line_len = vim.fn.strcharlen(end_line)
-      -- LSP spec: if character > line length, default to the line length.
-      -- https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
-      local col = pos.character <= line_len
-          and M._str_byteindex_enc(line, pos.character, offset_encoding)
-        or line_len
-      local end_col = end_pos.character <= end_line_len
-          and M._str_byteindex_enc(end_line, end_pos.character, offset_encoding)
-        or end_line_len
+      local col = M._str_byteindex_enc(line, pos.character, offset_encoding)
+      local end_col = M._str_byteindex_enc(end_line, end_pos.character, offset_encoding)
 
       table.insert(items, {
         filename = filename,
-- 
cgit 


From f279d1ae33ee5650bccf7b52f9f29fd192ccea1d Mon Sep 17 00:00:00 2001
From: tris203 <admin@snappeh.com>
Date: Mon, 9 Sep 2024 22:39:02 +0100
Subject: fix(lsp): handle encoding bounds in str_utfindex_enc

Problem:
str_utfindex_enc could return an error if the index was longer than the
line length. This was handled in each of the calls to it individually

Solution:
* Fix the call at the source level so that if the index is higher than
  the line length, utf length is returned
---
 runtime/lua/vim/lsp/util.lua | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 5046459645..09b97ac861 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -119,6 +119,7 @@ end
 ---@param encoding string|nil utf-8|utf-16|utf-32|nil defaults to utf-16
 ---@return integer `encoding` index of `index` in `line`
 function M._str_utfindex_enc(line, index, encoding)
+  local len32, len16 = vim.str_utfindex(line)
   if not encoding then
     encoding = 'utf-16'
   end
@@ -129,9 +130,15 @@ function M._str_utfindex_enc(line, index, encoding)
       return #line
     end
   elseif encoding == 'utf-16' then
+    if not index or index > len16 then
+      return len16
+    end
     local _, col16 = vim.str_utfindex(line, index)
     return col16
   elseif encoding == 'utf-32' then
+    if not index or index > len32 then
+      return len32
+    end
     local col32, _ = vim.str_utfindex(line, index)
     return col32
   else
@@ -171,8 +178,6 @@ function M._str_byteindex_enc(line, index, encoding)
   end
 end
 
-local _str_utfindex_enc = M._str_utfindex_enc
-
 --- Replaces text in a range with new text.
 ---
 --- CAUTION: Changes in-place!
@@ -1928,7 +1933,7 @@ local function make_position_param(window, offset_encoding)
     return { line = 0, character = 0 }
   end
 
-  col = _str_utfindex_enc(line, col, offset_encoding)
+  col = M._str_utfindex_enc(line, col, offset_encoding)
 
   return { line = row, character = col }
 end
@@ -2110,11 +2115,7 @@ function M.character_offset(buf, row, col, offset_encoding)
     )
     offset_encoding = vim.lsp.get_clients({ bufnr = buf })[1].offset_encoding
   end
-  -- If the col is past the EOL, use the line length.
-  if col > #line then
-    return _str_utfindex_enc(line, nil, offset_encoding)
-  end
-  return _str_utfindex_enc(line, col, offset_encoding)
+  return M._str_utfindex_enc(line, col, offset_encoding)
 end
 
 --- Helper function to return nested values in language server settings
-- 
cgit 


From f9bf64d74641f33961fe1d6c1592b65d2744298f Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Wed, 11 Sep 2024 23:11:09 +0800
Subject: fix(lsp): check buffer is loaded and valid #30330

Problem: buffer mabye not valid when callback handler invoke.

Soliton: check buffer is valid and loaded in handler.
---
 runtime/lua/vim/lsp/inlay_hint.lua | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 4483b083de..61059180fe 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -43,17 +43,16 @@ function M.on_inlayhint(err, result, ctx, _)
     return
   end
   local bufnr = assert(ctx.bufnr)
-  if util.buf_versions[bufnr] ~= ctx.version then
+  if
+    util.buf_versions[bufnr] ~= ctx.version
+    or not result
+    or not api.nvim_buf_is_loaded(bufnr)
+    or not bufstates[bufnr].enabled
+  then
     return
   end
   local client_id = ctx.client_id
-  if not result then
-    return
-  end
   local bufstate = bufstates[bufnr]
-  if not bufstate.enabled then
-    return
-  end
   if not (bufstate.client_hints and bufstate.version) then
     bufstate.client_hints = vim.defaulttable()
     bufstate.version = ctx.version
-- 
cgit 


From 8654a9700690a715e35baa600bb982f4ea608ead Mon Sep 17 00:00:00 2001
From: James Trew <66286082+jamestrew@users.noreply.github.com>
Date: Fri, 13 Sep 2024 11:59:49 +0000
Subject: fix(lsp): handle empty call hierarchy items #30349

Ensure that the function `pick_call_hierarchy_item` correctly handles
the case where `call_hierarchy_items` is nil or an empty table. This
prevents potential errors when the function is called with no items.
---
 runtime/lua/vim/lsp/buf.lua | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index e51727ef13..a43ad8a690 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -447,11 +447,9 @@ function M.document_symbol(opts)
   request_with_opts(ms.textDocument_documentSymbol, params, opts)
 end
 
---- @param call_hierarchy_items lsp.CallHierarchyItem[]?
+--- @param call_hierarchy_items lsp.CallHierarchyItem[]
+--- @return lsp.CallHierarchyItem?
 local function pick_call_hierarchy_item(call_hierarchy_items)
-  if not call_hierarchy_items then
-    return
-  end
   if #call_hierarchy_items == 1 then
     return call_hierarchy_items[1]
   end
@@ -476,7 +474,7 @@ local function call_hierarchy(method)
       vim.notify(err.message, vim.log.levels.WARN)
       return
     end
-    if not result then
+    if not result or vim.tbl_isempty(result) then
       vim.notify('No item resolved', vim.log.levels.WARN)
       return
     end
-- 
cgit 


From 8512f669f0e095df99e0456db11a0e0b5a2b0485 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Fri, 13 Sep 2024 19:57:04 +0200
Subject: fix(lsp): handle nil bytes in strings

Problem:

The LSP omnifunc can insert nil bytes, which when read in other places
(like semantic token) could cause an error:

    semantic_tokens.lua:304: Vim:E976: Using a Blob as a String

Solution:

Use `#line` instead of `vim.fn.strlen(line)`. Both return UTF-8 bytes
but the latter can't handle nil bytes.

Completion candidates can currently insert nil bytes, if other parts of
Alternative fix to https://github.com/neovim/neovim/pull/30359

Note that https://github.com/neovim/neovim/pull/30315 will avoid the
insertion of nil bytes from the LSP omnifunc, but the change of this PR
can more easily be backported.
---
 runtime/lua/vim/lsp/util.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 09b97ac861..65f84e8f87 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -154,7 +154,7 @@ end
 ---@param encoding string utf-8|utf-16|utf-32| defaults to utf-16
 ---@return integer byte (utf-8) index of `encoding` index `index` in `line`
 function M._str_byteindex_enc(line, index, encoding)
-  local len = vim.fn.strlen(line)
+  local len = #line
   if index > len then
     -- LSP spec: if character > line length, default to the line length.
     -- https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
@@ -167,7 +167,7 @@ function M._str_byteindex_enc(line, index, encoding)
     if index then
       return index
     else
-      return #line
+      return len
     end
   elseif encoding == 'utf-16' then
     return vim.str_byteindex(line, index, true)
-- 
cgit 


From adbaaa522550a098e3b8e4efe0909cb3aa6e1d83 Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Thu, 19 Sep 2024 16:00:08 +0100
Subject: docs(lsp): hover window controls #30347

---
 runtime/lua/vim/lsp/buf.lua | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index a43ad8a690..301c1f0cb6 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -29,7 +29,12 @@ local function request(method, params, handler)
 end
 
 --- Displays hover information about the symbol under the cursor in a floating
---- window. Calling the function twice will jump into the floating window.
+--- window. The window will be dismissed on cursor move.
+--- Calling the function twice will jump into the floating window
+--- (thus by default, "KK" will open the hover window and focus it).
+--- In the floating window, all commands and mappings are available as usual,
+--- except that "q" dismisses the window.
+--- You can scroll the contents the same as you would any other buffer.
 function M.hover()
   local params = util.make_position_params()
   request(ms.textDocument_hover, params)
-- 
cgit 


From 511b991e66892b4bb8176ce64c0e8fefb300f638 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 21 Sep 2024 16:23:00 +0100
Subject: feat(fs.lua): add vim.fs.rm()

Analogous to the shell `rm` command.
---
 runtime/lua/vim/lsp/util.lua | 19 ++++++-------------
 1 file changed, 6 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 65f84e8f87..9ee7dc8df7 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -652,6 +652,7 @@ function M.rename(old_fname, new_fname, opts)
   end
 end
 
+--- @param change lsp.CreateFile
 local function create_file(change)
   local opts = change.options or {}
   -- from spec: Overwrite wins over `ignoreIfExists`
@@ -666,23 +667,15 @@ local function create_file(change)
   vim.fn.bufadd(fname)
 end
 
+--- @param change lsp.DeleteFile
 local function delete_file(change)
   local opts = change.options or {}
   local fname = vim.uri_to_fname(change.uri)
-  local stat = uv.fs_stat(fname)
-  if opts.ignoreIfNotExists and not stat then
-    return
-  end
-  assert(stat, 'Cannot delete not existing file or folder ' .. fname)
-  local flags
-  if stat and stat.type == 'directory' then
-    flags = opts.recursive and 'rf' or 'd'
-  else
-    flags = ''
-  end
   local bufnr = vim.fn.bufadd(fname)
-  local result = tonumber(vim.fn.delete(fname, flags))
-  assert(result == 0, 'Could not delete file: ' .. fname .. ', stat: ' .. vim.inspect(stat))
+  vim.fs.rm(fname, {
+    force = opts.ignoreIfNotExists,
+    recursive = opts.recursive,
+  })
   api.nvim_buf_delete(bufnr, { force = true })
 end
 
-- 
cgit 


From 737f58e23230ea14f1648ac1fc7f442ea0f8563c Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 20 Sep 2024 07:34:50 +0200
Subject: refactor(api)!: rename Dictionary => Dict

In the api_info() output:

    :new|put =map(filter(api_info().functions, '!has_key(v:val,''deprecated_since'')'), 'v:val')
    ...

    {'return_type': 'ArrayOf(Integer, 2)', 'name': 'nvim_win_get_position', 'method': v:true, 'parameters': [['Window', 'window']], 'since': 1}

The `ArrayOf(Integer, 2)` return type didn't break clients when we added
it, which is evidence that clients don't use the `return_type` field,
thus renaming Dictionary => Dict in api_info() is not (in practice)
a breaking change.
---
 runtime/lua/vim/lsp/client.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua
index 8cdfdd4b90..e3c82f4169 100644
--- a/runtime/lua/vim/lsp/client.lua
+++ b/runtime/lua/vim/lsp/client.lua
@@ -233,11 +233,11 @@ local validate = vim.validate
 ---
 --- Sends a request to the server and synchronously waits for the response.
 --- This is a wrapper around {client.request}
---- Returns: { err=err, result=result }, a dictionary, where `err` and `result`
+--- Returns: { err=err, result=result }, a dict, where `err` and `result`
 --- come from the |lsp-handler|. On timeout, cancel or error, returns `(nil,
 --- err)` where `err` is a string describing the failure reason. If the request
 --- was unsuccessful returns `nil`.
---- @field request_sync fun(method: string, params: table?, timeout_ms: integer?, bufnr: integer): {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dictionary, where
+--- @field request_sync fun(method: string, params: table?, timeout_ms: integer?, bufnr: integer): {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dict
 ---
 --- Sends a notification to an LSP server.
 --- Returns: a boolean to indicate if the notification was successful. If
@@ -738,7 +738,7 @@ end
 --- @param timeout_ms (integer|nil) Maximum time in milliseconds to wait for
 ---                                a result. Defaults to 1000
 --- @param bufnr (integer) Buffer handle (0 for current).
---- @return {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dictionary, where
+--- @return {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dict, where
 --- `err` and `result` come from the |lsp-handler|.
 --- On timeout, cancel or error, returns `(nil, err)` where `err` is a
 --- string describing the failure reason. If the request was unsuccessful
-- 
cgit 


From 47e6b2233feffc6e9d94f6086fb904eb5688fa25 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 23 Sep 2024 06:05:58 -0700
Subject: fix(vim.fs): dirname() returns "." on mingw/msys2 #30480

Problem:
`vim.fs.dirname([[C:\User\XXX\AppData\Local]])` returns "." on
mingw/msys2.

Solution:
- Check for "mingw" when deciding `iswin`.
- Use `has("win32")` where possible, it works in "fast" contexts since
  b02eeb6a7281df0561a021d7ae595c84be9a01be.
---
 runtime/lua/vim/lsp/rpc.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index d81eae20d1..bc24501eae 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -3,7 +3,7 @@ local log = require('vim.lsp.log')
 local protocol = require('vim.lsp.protocol')
 local validate, schedule, schedule_wrap = vim.validate, vim.schedule, vim.schedule_wrap
 
-local is_win = uv.os_uname().version:find('Windows')
+local is_win = vim.fn.has('win32') == 1
 
 --- Checks whether a given path exists and is a directory.
 ---@param filename string path to check
-- 
cgit 


From 385fbfb3e739b457027b469782678f86eefdf7fc Mon Sep 17 00:00:00 2001
From: James Trew <66286082+jamestrew@users.noreply.github.com>
Date: Thu, 3 Oct 2024 10:45:51 +0000
Subject: docs: improve luacats support #30580

Some composite/compound types even as basic as `(string|number)[]` are
not currently supported by the luacats LPEG grammar used by gen_vimdoc.
It would be parsed & rendered as just `string|number`.

Changeset adds better support for these types.
---
 runtime/lua/vim/lsp/rpc.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index bc24501eae..e79dbd2db3 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -550,7 +550,7 @@ local function new_client(dispatchers, transport)
 end
 
 ---@class vim.lsp.rpc.PublicClient
----@field request fun(method: string, params: table?, callback: fun(err: lsp.ResponseError|nil, result: any), notify_reply_callback: fun(integer)|nil):boolean,integer? see |vim.lsp.rpc.request()|
+---@field request fun(method: string, params: table?, callback: fun(err: lsp.ResponseError|nil, result: any), notify_reply_callback: fun(message_id: integer)|nil):boolean,integer? see |vim.lsp.rpc.request()|
 ---@field notify fun(method: string, params: any):boolean see |vim.lsp.rpc.notify()|
 ---@field is_closing fun(): boolean
 ---@field terminate fun()
-- 
cgit 


From 305012ea073267492e1d626a304c6993b0dfa145 Mon Sep 17 00:00:00 2001
From: Yi Ming <ofseed@foxmail.com>
Date: Fri, 4 Oct 2024 14:26:11 +0800
Subject: fix(lsp): enable `additionalPropertiesSupport`

---
 runtime/lua/vim/lsp/protocol.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 0eb10af1ea..1699fff0c1 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -562,7 +562,7 @@ function protocol.make_client_capabilities()
       workDoneProgress = true,
       showMessage = {
         messageActionItem = {
-          additionalPropertiesSupport = false,
+          additionalPropertiesSupport = true,
         },
       },
       showDocument = {
-- 
cgit 


From 27f3750817b188c9ababe94eade22c30d8819585 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sun, 6 Oct 2024 12:20:40 -0700
Subject: feat(lsp): improve LSP doc hover rendering #30695

Problem:
- Some servers like LuaLS add unwanted blank lines after multiline
  `@param` description.
- List items do not wrap nicely.

Solution:
- When rendering the LSP doc hover, remove blank lines in each `@param`
  or `@return`.
  - But ensure exactly one empty line before each.
- Set 'breakindent'.
---
 runtime/lua/vim/lsp/util.lua | 36 ++++++++++++++++++++++++++----------
 1 file changed, 26 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 9ee7dc8df7..a08825b735 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -99,9 +99,26 @@ local function get_border_size(opts)
   return { height = height, width = width }
 end
 
-local function split_lines(value)
-  value = string.gsub(value, '\r\n?', '\n')
-  return split(value, '\n', { plain = true, trimempty = true })
+--- Splits string at newlines, optionally removing unwanted blank lines.
+---
+--- @param s string Multiline string
+--- @param no_blank boolean? Drop blank lines for each @param/@return (except one empty line
+--- separating each). Workaround for https://github.com/LuaLS/lua-language-server/issues/2333
+local function split_lines(s, no_blank)
+  s = string.gsub(s, '\r\n?', '\n')
+  local lines = {}
+  local in_desc = true -- Main description block, before seeing any @foo.
+  for line in vim.gsplit(s, '\n', { plain = true, trimempty = true }) do
+    local start_annotation = not not line:find('^ ?%@.?[pr]')
+    in_desc = (not start_annotation) and in_desc or false
+    if start_annotation and no_blank and not (lines[#lines] or ''):find('^%s*$') then
+      table.insert(lines, '') -- Separate each @foo with a blank line.
+    end
+    if in_desc or not no_blank or not line:find('^%s*$') then
+      table.insert(lines, line)
+    end
+  end
+  return lines
 end
 
 local function create_window_without_focus()
@@ -116,7 +133,7 @@ end
 --- Convenience wrapper around vim.str_utfindex
 ---@param line string line to be indexed
 ---@param index integer|nil byte index (utf-8), or `nil` for length
----@param encoding string|nil utf-8|utf-16|utf-32|nil defaults to utf-16
+---@param encoding 'utf-8'|'utf-16'|'utf-32'|nil defaults to utf-16
 ---@return integer `encoding` index of `index` in `line`
 function M._str_utfindex_enc(line, index, encoding)
   local len32, len16 = vim.str_utfindex(line)
@@ -735,13 +752,13 @@ function M.convert_input_to_markdown_lines(input, contents)
   contents = contents or {}
   -- MarkedString variation 1
   if type(input) == 'string' then
-    list_extend(contents, split_lines(input))
+    list_extend(contents, split_lines(input, true))
   else
     assert(type(input) == 'table', 'Expected a table for LSP input')
     -- MarkupContent
     if input.kind then
       local value = input.value or ''
-      list_extend(contents, split_lines(value))
+      list_extend(contents, split_lines(value, true))
       -- MarkupString variation 2
     elseif input.language then
       table.insert(contents, '```' .. input.language)
@@ -1633,10 +1650,9 @@ function M.open_floating_preview(contents, syntax, opts)
   if do_stylize then
     vim.wo[floating_winnr].conceallevel = 2
   end
-  -- disable folding
-  vim.wo[floating_winnr].foldenable = false
-  -- soft wrapping
-  vim.wo[floating_winnr].wrap = opts.wrap
+  vim.wo[floating_winnr].foldenable = false -- Disable folding.
+  vim.wo[floating_winnr].wrap = opts.wrap -- Soft wrapping.
+  vim.wo[floating_winnr].breakindent = true -- Slightly better list presentation.
 
   vim.bo[floating_bufnr].modifiable = false
   vim.bo[floating_bufnr].bufhidden = 'wipe'
-- 
cgit 


From 50f006b61774311e67e6948cd863bd503e4bcdfb Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 7 Oct 2024 08:25:13 -0700
Subject: fix(lsp): tagfunc fails in unusual buffer #30700
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:
tagfunc failed in a weird buffer (either a directory or some other
non-file buffer, I don't remember):

    E987: Invalid return value from tagfunc
    E5108: Error executing lua …/runtime/lua/vim/lsp/util.lua:311: EISDIR: illegal operation on a directory
    stack traceback:

at this line:

    local data = assert(uv.fs_read(fd, stat.size, 0))

Solution:
Check for directory.
---
 runtime/lua/vim/lsp/util.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim/lsp')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index a08825b735..882ec22ca6 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -296,6 +296,9 @@ local function get_lines(bufnr, rows)
   end
 
   local filename = api.nvim_buf_get_name(bufnr)
+  if vim.fn.isdirectory(filename) ~= 0 then
+    return {}
+  end
 
   -- get the data from the file
   local fd = uv.fs_open(filename, 'r', 438)
-- 
cgit