fix(lsp): deprecate vim.lsp.omnifunc

runtime/doc/deprecated.txt

@@ -226,6 +226,8 @@ LSP FUNCTIONS
  {async=false} instead.
 - *vim.lsp.buf.range_formatting()* Use |vim.lsp.formatexpr()|
  or |vim.lsp.buf.format()| instead.
+- *vim.lsp.omnifunc()* Use |vim.lsp.completion.omnifunc()| 
+ instead.
 
 LUA
 - vim.register_keystroke_callback() Use |vim.on_key()| instead.

runtime/doc/lsp.txt

@@ -60,7 +60,7 @@ listed below, if (1) the language server supports the functionality and (2)
 the options are empty or were set by the builtin runtime (ftplugin) files. The
 options are not restored when the LSP client is stopped or detached.
 
-- 'omnifunc' is set to |vim.lsp.omnifunc()|, use |i_CTRL-X_CTRL-O| to trigger
+- 'omnifunc' is set to |vim.lsp.completion.omnifunc()|, use |i_CTRL-X_CTRL-O| to trigger
  completion.
 - 'tagfunc' is set to |vim.lsp.tagfunc()|. This enables features like
  go-to-definition, |:tjump|, and keymaps like |CTRL-]|, |CTRL-W_]|,
@@ -125,7 +125,7 @@ FAQ *lsp-faq*
 
 - Q: Why isn't completion working?
 - A: In the buffer where you want to use LSP, check that 'omnifunc' is set to
- "v:lua.vim.lsp.omnifunc": `:verbose set omnifunc?`
+ "v:lua.vim.lsp.completion.omnifunc": `:verbose set omnifunc?`
  - Some other plugin may be overriding the option. To avoid that you could
  set the option in an |after-directory| ftplugin, e.g.
  "after/ftplugin/python.vim".
@@ -514,10 +514,10 @@ LspAttach *LspAttach*
  callback = function(args)
  local bufnr = args.buf
  local client = vim.lsp.get_client_by_id(args.data.client_id)
- if client.server_capabilities.completionProvider then
- vim.bo[bufnr].omnifunc = "v:lua.vim.lsp.omnifunc"
+ if client.supports_method("textDocument/completion") then
+ vim.bo[bufnr].omnifunc = "v:lua.vim.lsp.completion.omnifunc"
  end
- if client.server_capabilities.definitionProvider then
+ if client.supports_method("textDocument/definition") then
  vim.bo[bufnr].tagfunc = "v:lua.vim.lsp.tagfunc"
  end
  end,
@@ -801,23 +801,6 @@ get_log_path() *vim.lsp.get_log_path()*
  Return: ~
  (`string`) path to log file
 
-omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
- Implements 'omnifunc' compatible LSP completion.
-
- Parameters: ~
- • {findstart} (`integer`) 0 or 1, decides behavior
- • {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()|)
-
- See also: ~
- • |complete-functions|
- • |complete-items|
- • |CompleteDone|
-
 set_log_level({level}) *vim.lsp.set_log_level()*
  Sets the global log level for LSP logging.
 

runtime/lua/vim/lsp.lua

@@ -342,7 +342,7 @@ function lsp._set_defaults(client, bufnr)
  if
  client.supports_method(ms.textDocument_completion) and is_empty_or_default(bufnr, 'omnifunc')
  then
- vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.omnifunc'
+ vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.completion.omnifunc'
  end
  if
  client.supports_method(ms.textDocument_rangeFormatting)
@@ -371,7 +371,7 @@ local function reset_defaults(bufnr)
  if vim.bo[bufnr].tagfunc == 'v:lua.vim.lsp.tagfunc' then
  vim.bo[bufnr].tagfunc = nil
  end
- if vim.bo[bufnr].omnifunc == 'v:lua.vim.lsp.omnifunc' then
+ if vim.bo[bufnr].omnifunc == 'v:lua.vim.lsp.completion.omnifunc' then
  vim.bo[bufnr].omnifunc = nil
  end
  if vim.bo[bufnr].formatexpr == 'v:lua.vim.lsp.formatexpr()' then
@@ -1001,9 +1001,10 @@ end
 ---@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()|)
+---@deprecated
 function lsp.omnifunc(findstart, base)
- log.debug('omnifunc.findstart', { findstart = findstart, base = base })
- return vim.lsp._completion.omnifunc(findstart, base)
+ vim.deprecate('vim.lsp.omnifunc', 'vim.lsp.completion.omnifunc', '0.12')
+ return vim.lsp.completion.omnifunc(findstart, base)
 end
 
 --- @class vim.lsp.formatexpr.Opts

test/functional/plugin/lsp_spec.lua

@@ -364,7 +364,7 @@ describe('LSP', function()
  on_handler = function(_, _, ctx)
  if ctx.method == 'test' then
  eq('v:lua.vim.lsp.tagfunc', get_buf_option('tagfunc'))
- eq('v:lua.vim.lsp.omnifunc', get_buf_option('omnifunc'))
+ eq('v:lua.vim.lsp.completion.omnifunc', get_buf_option('omnifunc'))
  eq('v:lua.vim.lsp.formatexpr()', get_buf_option('formatexpr'))
  eq('', get_buf_option('keywordprg'))
  eq(
@@ -425,7 +425,7 @@ describe('LSP', function()
  on_handler = function(_, _, ctx)
  if ctx.method == 'test' then
  eq('v:lua.vim.lsp.tagfunc', get_buf_option('tagfunc', 'BUFFER_1'))
- eq('v:lua.vim.lsp.omnifunc', get_buf_option('omnifunc', 'BUFFER_2'))
+ eq('v:lua.vim.lsp.completion.omnifunc', get_buf_option('omnifunc', 'BUFFER_2'))
  eq('v:lua.vim.lsp.formatexpr()', get_buf_option('formatexpr', 'BUFFER_2'))
  client.stop()
  end