diff options
| -rw-r--r-- | runtime/doc/lsp.txt | 36 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/buf.lua | 28 |
2 files changed, 52 insertions, 12 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 9f878ad8c7..b934d2dfa0 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -758,13 +758,14 @@ code_action({context}) *vim.lsp.buf.code_action()* TODO: Documentation completion({context}) *vim.lsp.buf.completion()* - TODO: Documentation + Retrieves the completion items at the current cursor position. + Can only be called in Insert mode. declaration() *vim.lsp.buf.declaration()* - TODO: Documentation + Jumps to the declaration of the symbol under the cursor. definition() *vim.lsp.buf.definition()* - TODO: Documentation + Jumps to the definition of the symbol under the cursor. document_highlight() *vim.lsp.buf.document_highlight()* Send request to server to resolve document highlights for the @@ -777,13 +778,18 @@ document_highlight() *vim.lsp.buf.document_highlight()* < document_symbol() *vim.lsp.buf.document_symbol()* - TODO: Documentation + Lists all symbols in the current buffer in the quickfix + window. execute_command({command}) *vim.lsp.buf.execute_command()* TODO: Documentation formatting({options}) *vim.lsp.buf.formatting()* - TODO: Documentation + Formats the current buffer. + + The optional {options} table can be used to specify + FormattingOptions, a list of which is available at https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting . Some unspecified options will be automatically derived from + the current Neovim options. *vim.lsp.buf.formatting_sync()* formatting_sync({options}, {timeout_ms}) @@ -794,10 +800,13 @@ formatting_sync({options}, {timeout_ms}) |vim.lsp.buf_request_sync()|. hover() *vim.lsp.buf.hover()* - TODO: Documentation + Displays hover information about the symbol under the cursor + in a floating window. Calling the function twice will jump + into the floating window. implementation() *vim.lsp.buf.implementation()* - TODO: Documentation + Lists all the implementations for the symbol under the cursor + in the quickfix window. npcall({fn}, {...}) *vim.lsp.buf.npcall()* TODO: Documentation @@ -810,10 +819,13 @@ range_formatting({options}, {start_pos}, {end_pos}) TODO: Documentation references({context}) *vim.lsp.buf.references()* - TODO: Documentation + Lists all the references to the symbol under the cursor in the + quickfix window. rename({new_name}) *vim.lsp.buf.rename()* - TODO: Documentation + Renames all references to the symbol under the cursor. If + {new_name} is not provided, the user will be prompted for a + new name using |input()|. request({method}, {params}, {callback}) *vim.lsp.buf.request()* TODO: Documentation @@ -823,10 +835,12 @@ server_ready() *vim.lsp.buf.server_ready()* `true` if server responds. signature_help() *vim.lsp.buf.signature_help()* - TODO: Documentation + Displays signature information about the symbol under the + cursor in a floating window. type_definition() *vim.lsp.buf.type_definition()* - TODO: Documentation + Jumps to the definition of the type of the symbol under the + cursor. workspace_symbol({query}) *vim.lsp.buf.workspace_symbol()* Lists all symbols in the current workspace in the quickfix diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua index 476bb3ba6f..2e27617997 100644 --- a/runtime/lua/vim/lsp/buf.lua +++ b/runtime/lua/vim/lsp/buf.lua @@ -30,43 +30,63 @@ function M.server_ready() return not not vim.lsp.buf_notify(0, "window/progress", {}) end +--- Displays hover information about the symbol under the cursor in a floating +--- window. Calling the function twice will jump into the floating window. function M.hover() local params = util.make_position_params() request('textDocument/hover', params) end +--- Jumps to the declaration of the symbol under the cursor. +--- function M.declaration() local params = util.make_position_params() request('textDocument/declaration', params) end +--- Jumps to the definition of the symbol under the cursor. +--- function M.definition() local params = util.make_position_params() request('textDocument/definition', params) end +--- Jumps to the definition of the type of the symbol under the cursor. +--- function M.type_definition() local params = util.make_position_params() request('textDocument/typeDefinition', params) end +--- Lists all the implementations for the symbol under the cursor in the +--- quickfix window. function M.implementation() local params = util.make_position_params() request('textDocument/implementation', params) end +--- Displays signature information about the symbol under the cursor in a +--- floating window. function M.signature_help() local params = util.make_position_params() request('textDocument/signatureHelp', params) end --- TODO(ashkan) ? +--- Retrieves the completion items at the current cursor position. Can only be +--- called in Insert mode. function M.completion(context) local params = util.make_position_params() params.context = context return request('textDocument/completion', params) end +--- Formats the current buffer. +--- +--- The optional {options} table can be used to specify FormattingOptions, a +--- list of which is available at +--- https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting. +--- Some unspecified options will be automatically derived from the current +--- Neovim options. function M.formatting(options) local params = util.make_formatting_params(options) return request('textDocument/formatting', params) @@ -118,6 +138,8 @@ function M.range_formatting(options, start_pos, end_pos) return request('textDocument/rangeFormatting', params) end +--- Renames all references to the symbol under the cursor. If {new_name} is not +--- provided, the user will be prompted for a new name using |input()|. function M.rename(new_name) -- TODO(ashkan) use prepareRename -- * result: [`Range`](#range) \| `{ range: Range, placeholder: string }` \| `null` describing the range of the string to rename and optionally a placeholder text of the string content to be renamed. If `null` is returned then it is deemed that a 'textDocument/rename' request is not valid at the given position. @@ -128,6 +150,8 @@ function M.rename(new_name) request('textDocument/rename', params) end +--- Lists all the references to the symbol under the cursor in the quickfix window. +--- function M.references(context) validate { context = { context, 't', true } } local params = util.make_position_params() @@ -138,6 +162,8 @@ function M.references(context) request('textDocument/references', params) end +--- Lists all symbols in the current buffer in the quickfix window. +--- function M.document_symbol() local params = { textDocument = util.make_text_document_params() } request('textDocument/documentSymbol', params) |