diff options
| -rw-r--r-- | runtime/doc/insert.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/lsp.txt | 47 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 2 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/completion.lua | 23 |
4 files changed, 50 insertions, 24 deletions
diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 6cbc6d3b8e..3c8bb0814a 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1015,7 +1015,7 @@ CTRL-X CTRL-U Guess what kind of item is in front of the cursor and previous one. -Omni completion *compl-omni* +Omni completion *omnicompletion* *compl-omni* Completion is done by a function that can be defined by the user with the 'omnifunc' option. This is to be used for filetype-specific completion. diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index de5ab0849c..a943e0de44 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -59,10 +59,12 @@ Follow these steps to get LSP features: Example: >lua vim.lsp.enable('luals') < -4. Check that the buffer is attached to the server: >vim +4. Restart Nvim, or use ":edit" to reload the buffer. + +5. Check that LSP is active ("attached") for the buffer: >vim :checkhealth vim.lsp < -5. (Optional) Configure keymaps and autocommands to use LSP features. +6. (Optional) Configure keymaps and autocommands to use LSP features. |lsp-attach| ============================================================================== @@ -197,7 +199,7 @@ Example: Enable auto-completion and auto-formatting ("linting"): >lua -- Create a keymap for vim.lsp.buf.implementation ... end - -- Enable auto-completion. + -- Enable auto-completion. Note: Use CTRL-Y to select an item. |complete_CTRL-Y| if client:supports_method('textDocument/completion') then vim.lsp.completion.enable(true, client.id, args.buf, {autotrigger = true}) end @@ -1858,10 +1860,12 @@ The `vim.lsp.completion` module enables insert-mode completion driven by an LSP server. Call `enable()` to make it available through Nvim builtin completion (via the |CompleteDone| event). Specify `autotrigger=true` to activate "auto-completion" when you type any of the server-defined -`triggerCharacters`. +`triggerCharacters`. Use CTRL-Y to select an item from the completion menu. +|complete_CTRL-Y| Example: activate LSP-driven auto-completion: >lua -- Works best with completeopt=noselect. + -- Use CTRL-Y to select an item. |complete_CTRL-Y| vim.cmd[[set completeopt+=menuone,noselect,popup]] vim.lsp.start({ name = 'ts_ls', @@ -1878,30 +1882,37 @@ Example: activate LSP-driven auto-completion: >lua < -*vim.lsp.completion.BufferOpts* - - Fields: ~ - • {autotrigger}? (`boolean`) Default: false When true, completion - triggers automatically based on the server's - `triggerCharacters`. - • {convert}? (`fun(item: lsp.CompletionItem): table`) Transforms an - LSP CompletionItem to |complete-items|. - - *vim.lsp.completion.enable()* enable({enable}, {client_id}, {bufnr}, {opts}) Enables or disables completions from the given language client in the - given buffer. + given buffer. Example: |lsp-attach| |lsp-completion| Parameters: ~ • {enable} (`boolean`) True to enable, false to disable • {client_id} (`integer`) Client ID • {bufnr} (`integer`) Buffer handle, or 0 for the current buffer - • {opts} (`vim.lsp.completion.BufferOpts?`) See - |vim.lsp.completion.BufferOpts|. + • {opts} (`table?`) A table with the following fields: + • {autotrigger}? (`boolean`) (default: false) When true, + completion triggers automatically based on the server's + `triggerCharacters`. + • {convert}? (`fun(item: lsp.CompletionItem): table`) + Transforms an LSP CompletionItem to |complete-items|. get({opts}) *vim.lsp.completion.get()* - Triggers LSP completion once in the current buffer. + Triggers LSP completion once in the current buffer, if LSP completion is + enabled (see |lsp-attach| |lsp-completion|). + + Used by the default LSP |omnicompletion| provider |vim.lsp.omnifunc()|, + thus |i_CTRL-X_CTRL-O| invokes this in LSP-enabled buffers. Use CTRL-Y to + select an item from the completion menu. |complete_CTRL-Y| + + To invoke manually with CTRL-space, use this mapping: >lua + -- Use CTRL-space to trigger LSP completion. + -- Use CTRL-Y to select an item. |complete_CTRL-Y| + vim.keymap.set('i', '<c-space>', function() + vim.lsp.completion.get() + end) +< Parameters: ~ • {opts} (`table?`) A table with the following fields: diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index a5305e5903..cb5a7c8a6c 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -246,8 +246,6 @@ DEFAULTS • 'diffopt' default includes "linematch:40". • 'number', 'relativenumber', 'signcolumn', and 'foldcolumn' are disabled in |terminal| buffers. |terminal-config| shows how to change these defaults. - -• Options: • Lua |ftplugin| sets 'omnifunc' to "v:lua.vim.lua_omnifunc". • Lua |ftplugin| sets 'foldexpr' to "v:lua.vim.treesitter.foldexpr()". diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua index 6aedac8fd9..9345cb8d83 100644 --- a/runtime/lua/vim/lsp/completion.lua +++ b/runtime/lua/vim/lsp/completion.lua @@ -2,11 +2,12 @@ --- The `vim.lsp.completion` module enables insert-mode completion driven by an LSP server. Call --- `enable()` to make it available through Nvim builtin completion (via the |CompleteDone| event). --- Specify `autotrigger=true` to activate "auto-completion" when you type any of the server-defined ---- `triggerCharacters`. +--- `triggerCharacters`. Use CTRL-Y to select an item from the completion menu. |complete_CTRL-Y| --- --- Example: activate LSP-driven auto-completion: --- ```lua --- -- Works best with completeopt=noselect. +--- -- Use CTRL-Y to select an item. |complete_CTRL-Y| --- vim.cmd[[set completeopt+=menuone,noselect,popup]] --- vim.lsp.start({ --- name = 'ts_ls', @@ -673,8 +674,9 @@ local function get_augroup(bufnr) return string.format('nvim.lsp.completion_%d', bufnr) end +--- @inlinedoc --- @class vim.lsp.completion.BufferOpts ---- @field autotrigger? boolean Default: false When true, completion triggers automatically based on the server's `triggerCharacters`. +--- @field autotrigger? boolean (default: false) When true, completion triggers automatically based on the server's `triggerCharacters`. --- @field convert? fun(item: lsp.CompletionItem): table Transforms an LSP CompletionItem to |complete-items|. ---@param client_id integer @@ -777,6 +779,7 @@ local function disable_completions(client_id, bufnr) end --- Enables or disables completions from the given language client in the given buffer. +--- Example: |lsp-attach| |lsp-completion| --- --- @param enable boolean True to enable, false to disable --- @param client_id integer Client ID @@ -796,7 +799,21 @@ end --- @class vim.lsp.completion.get.Opts --- @field ctx? lsp.CompletionContext Completion context. Defaults to a trigger kind of `invoked`. ---- Triggers LSP completion once in the current buffer. +--- Triggers LSP completion once in the current buffer, if LSP completion is enabled +--- (see |lsp-attach| |lsp-completion|). +--- +--- Used by the default LSP |omnicompletion| provider |vim.lsp.omnifunc()|, thus |i_CTRL-X_CTRL-O| +--- invokes this in LSP-enabled buffers. Use CTRL-Y to select an item from the completion menu. +--- |complete_CTRL-Y| +--- +--- To invoke manually with CTRL-space, use this mapping: +--- ```lua +--- -- Use CTRL-space to trigger LSP completion. +--- -- Use CTRL-Y to select an item. |complete_CTRL-Y| +--- vim.keymap.set('i', '<c-space>', function() +--- vim.lsp.completion.get() +--- end) +--- ``` --- --- @param opts? vim.lsp.completion.get.Opts function M.get(opts) |