Merge neovim#33972 feat(lsp): textDocument/inlineCompletion

Author: justinmk

runtime/colors/vim.lua

@@ -62,6 +62,8 @@ hi('PmenuMatchSel',  { link = 'PmenuSel' })
 hi('PmenuExtra',     { link = 'Pmenu' })
 hi('PmenuExtraSel',  { link = 'PmenuSel' })
 hi('ComplMatchIns',  {})
+hi('ComplHint',      { link = 'NonText' })
+hi('ComplHintMore',  { link = 'MoreMsg' })
 hi('Substitute',     { link = 'Search' })
 hi('Whitespace',     { link = 'NonText' })
 hi('MsgSeparator',   { link = 'StatusLine' })

runtime/doc/lsp.txt

@@ -332,6 +332,7 @@ They are also listed below.
 - `'textDocument/formatting'`
 - `'textDocument/hover'`
 - `'textDocument/inlayHint'`
+- `'textDocument/inlineCompletion'`
 - `'textDocument/publishDiagnostics'`
 - `'textDocument/rangeFormatting'`
 - `'textDocument/rename'`
@@ -2219,6 +2220,73 @@ is_enabled({filter})                         *vim.lsp.inlay_hint.is_enabled()*
         (`boolean`)
 
 
+==============================================================================
+Lua module: vim.lsp.inline_completion                  *lsp-inline_completion*
+
+enable({enable}, {filter})                *vim.lsp.inline_completion.enable()*
+    Enables or disables inline completion for the {filter}ed scope, inline
+    completion will automatically be refreshed when you are in insert mode.
+
+    To "toggle", pass the inverse of `is_enabled()`: >lua
+        vim.lsp.inline_completion.enable(not vim.lsp.inline_completion.is_enabled())
+<
+
+    Parameters: ~
+      • {enable}  (`boolean?`) true/nil to enable, false to disable
+      • {filter}  (`table?`) Optional filters |kwargs|,
+                  • {bufnr}? (`integer`, default: all) Buffer number, or 0 for
+                    current buffer, or nil for all.
+                  • {client_id}? (`integer`, default: all) Client ID, or nil
+                    for all.
+
+get({opts})                                  *vim.lsp.inline_completion.get()*
+    Apply the currently displayed completion candidate to the buffer.
+
+    It returns false when no candidate can be applied, so you can use the
+    return value to implement a fallback: >lua
+         vim.keymap.set('i', '<Tab>', function()
+          if not vim.lsp.inline_completion.get() then
+            return '<Tab>'
+          end
+        end, {
+          expr = true,
+          replace_keycodes = true,
+          desc = 'Get the current inline completion',
+        })
+<
+
+    Parameters: ~
+      • {opts}  (`table?`) A table with the following fields:
+                • {bufnr}? (`integer`, default: 0) Buffer handle, or 0 for
+                  current.
+
+    Return: ~
+        (`boolean`) `true` if a completion was applied, else `false`.
+
+is_enabled({filter})                  *vim.lsp.inline_completion.is_enabled()*
+    Query whether inline completion is enabled in the {filter}ed scope
+
+    Parameters: ~
+      • {filter}  (`table?`) Optional filters |kwargs|,
+                  • {bufnr}? (`integer`, default: all) Buffer number, or 0 for
+                    current buffer, or nil for all.
+                  • {client_id}? (`integer`, default: all) Client ID, or nil
+                    for all.
+
+select({opts})                            *vim.lsp.inline_completion.select()*
+    Switch between available inline completion candidates.
+
+    Parameters: ~
+      • {opts}  (`table?`) A table with the following fields:
+                • {bufnr}? (`integer`) (default: current buffer)
+                • {count}? (`integer`, default: v:count1) The number of
+                  candidates to move by. A positive integer moves forward by
+                  {count} candidates, while a negative integer moves backward
+                  by {count} candidates.
+                • {wrap}? (`boolean`, default: `true`) Whether to loop around
+                  file or not. Similar to 'wrapscan'.
+
+
 ==============================================================================
 Lua module: vim.lsp.linked_editing_range            *lsp-linked_editing_range*
 

runtime/doc/lua.txt

@@ -3984,19 +3984,37 @@ by |vim.Pos| objects.
     as format conversions.
 
     Fields: ~
-      • {row}     (`integer`) 0-based byte index.
-      • {col}     (`integer`) 0-based byte index.
-      • {buf}?    (`integer`) Optional buffer handle.
+      • {row}         (`integer`) 0-based byte index.
+      • {col}         (`integer`) 0-based byte index.
+      • {buf}?        (`integer`) Optional buffer handle.
 
-                  When specified, it indicates that this position belongs to a
-                  specific buffer. This field is required when performing
-                  position conversions.
-      • {to_lsp}  (`fun(pos: vim.Pos, position_encoding: lsp.PositionEncodingKind)`)
-                  See |Pos:to_lsp()|.
-      • {lsp}     (`fun(buf: integer, pos: lsp.Position, position_encoding: lsp.PositionEncodingKind)`)
-                  See |Pos:lsp()|.
+                      When specified, it indicates that this position belongs
+                      to a specific buffer. This field is required when
+                      performing position conversions.
+      • {to_lsp}      (`fun(pos: vim.Pos, position_encoding: lsp.PositionEncodingKind)`)
+                      See |Pos:to_lsp()|.
+      • {lsp}         (`fun(buf: integer, pos: lsp.Position, position_encoding: lsp.PositionEncodingKind)`)
+                      See |Pos:lsp()|.
+      • {to_cursor}   (`fun(pos: vim.Pos): [integer, integer]`) See
+                      |Pos:to_cursor()|.
+      • {cursor}      (`fun(pos: [integer, integer])`) See |Pos:cursor()|.
+      • {to_extmark}  (`fun(pos: vim.Pos): [integer, integer]`) See
+                      |Pos:to_extmark()|.
+      • {extmark}     (`fun(pos: [integer, integer])`) See |Pos:extmark()|.
 
 
+Pos:cursor({pos})                                               *Pos:cursor()*
+    Creates a new |vim.Pos| from cursor position.
+
+    Parameters: ~
+      • {pos}  (`[integer, integer]`)
+
+Pos:extmark({pos})                                             *Pos:extmark()*
+    Creates a new |vim.Pos| from extmark position.
+
+    Parameters: ~
+      • {pos}  (`[integer, integer]`)
+
 Pos:lsp({buf}, {pos}, {position_encoding})                         *Pos:lsp()*
     Creates a new |vim.Pos| from `lsp.Position`.
 
@@ -4016,6 +4034,24 @@ Pos:lsp({buf}, {pos}, {position_encoding})                         *Pos:lsp()*
       • {pos}                (`lsp.Position`)
       • {position_encoding}  (`lsp.PositionEncodingKind`)
 
+Pos:to_cursor({pos})                                         *Pos:to_cursor()*
+    Converts |vim.Pos| to cursor position.
+
+    Parameters: ~
+      • {pos}  (`vim.Pos`) See |vim.Pos|.
+
+    Return: ~
+        (`[integer, integer]`)
+
+Pos:to_extmark({pos})                                       *Pos:to_extmark()*
+    Converts |vim.Pos| to extmark position.
+
+    Parameters: ~
+      • {pos}  (`vim.Pos`) See |vim.Pos|.
+
+    Return: ~
+        (`[integer, integer]`)
+
 Pos:to_lsp({pos}, {position_encoding})                          *Pos:to_lsp()*
     Converts |vim.Pos| to `lsp.Position`.
 

runtime/doc/news.txt

@@ -231,6 +231,8 @@ LSP
 • Support for related documents in pull diagnostics:
   https://microsoft.github.io/language-server-protocol/specifications/specification-current/#relatedFullDocumentDiagnosticReport
 • |vim.lsp.buf.signature_help()| supports "noActiveParameterSupport".
+• Support for `textDocument/inlineCompletion` |lsp-inline_completion|
+  https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#textDocument_inlineCompletion
 
 LUA
 

runtime/doc/syntax.txt

@@ -5350,6 +5350,10 @@ PmenuMatchSel	Popup menu: Matched text in selected item. Combined with
 		|hl-PmenuMatch| and |hl-PmenuSel|.
 							*hl-ComplMatchIns*
 ComplMatchIns	Matched text of the currently inserted completion.
+							*hl-ComplHint*
+ComplHint	Virtual text of the currently selected completion.
+							*hl-ComplHintMore*
+ComplHintMore	The additional information of the virtual text.
 							*hl-Question*
 Question	|hit-enter| prompt and yes/no questions.
 							*hl-QuickFixLine*

runtime/lua/vim/lsp.lua

@@ -16,6 +16,7 @@ local lsp = vim._defer_require('vim.lsp', {
   document_color = ..., --- @module 'vim.lsp.document_color'
   handlers = ..., --- @module 'vim.lsp.handlers'
   inlay_hint = ..., --- @module 'vim.lsp.inlay_hint'
+  inline_completion = ..., --- @module 'vim.lsp.inline_completion'
   linked_editing_range = ..., --- @module 'vim.lsp.linked_editing_range'
   log = ..., --- @module 'vim.lsp.log'
   protocol = ..., --- @module 'vim.lsp.protocol'

runtime/lua/vim/lsp/_capability.lua

@@ -4,6 +4,7 @@ local api = vim.api
 ---| 'semantic_tokens'
 ---| 'folding_range'
 ---| 'linked_editing_range'
+---| 'inline_completion'
 
 --- Tracks all supported capabilities, all of which derive from `vim.lsp.Capability`.
 --- Returns capability *prototypes*, not their instances.

runtime/lua/vim/lsp/client.lua

@@ -514,6 +514,7 @@ function Client:initialize()
   -- HACK: Capability modules must be loaded
   require('vim.lsp.semantic_tokens')
   require('vim.lsp._folding_range')
+  require('vim.lsp.inline_completion')
 
   local init_params = {
     -- The process Id of the parent process that started the server. Is null if
@@ -607,6 +608,7 @@ local static_registration_capabilities = {
   [ms.textDocument_foldingRange] = 'foldingRangeProvider',
   [ms.textDocument_implementation] = 'implementationProvider',
   [ms.textDocument_inlayHint] = 'inlayHintProvider',
+  [ms.textDocument_inlineCompletion] = 'inlineCompletionProvider',
   [ms.textDocument_inlineValue] = 'inlineValueProvider',
   [ms.textDocument_linkedEditingRange] = 'linkedEditingRangeProvider',
   [ms.textDocument_moniker] = 'monikerProvider',