kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat(lsp): allow subset of CodeActionContext as arg to code_action methods (#15793)

Browse Source 
This makes it easier to filter the code actions. For example:

    vim.lsp.buf.code_action { only = 'refactor' }
This commit is contained in:
Mathias Fußenegger 2021-09-26 23:40:28 +02:00 committed by GitHub
parent c217766f7c
commit 73280a7987
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 42 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
runtime/doc/lsp.txt
View File

@ -869,12 +869,17 @@ clear_references() *vim.lsp.buf.clear_references()*
Removes document highlights from current buffer.
code_action({context}) *vim.lsp.buf.code_action()*
Selects a code action from the input list that is available at
the current cursor position.
Selects a code action available at the current cursor
position.
Parameters: ~
{context} (table, optional) Valid `CodeActionContext`
object
{context} table|nil `CodeActionContext` of the LSP specification:
• diagnostics: (table|nil) LSP`Diagnostic[]` . Inferred from the current position if not
provided.
• only: (string|nil) LSP `CodeActionKind` used
to filter the code actions. Most language
servers support values like `refactor` or
`quickfix` .
See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction
@ -1015,8 +1020,13 @@ range_code_action({context}, {start_pos}, {end_pos})
Performs |vim.lsp.buf.code_action()| for a given range.
Parameters: ~
{context} (table, optional) Valid `CodeActionContext`
object
{context} table|nil `CodeActionContext` of the LSP specification:
• diagnostics: (table|nil) LSP`Diagnostic[]` . Inferred from the current position if not
provided.
• only: (string|nil) LSP `CodeActionKind`
used to filter the code actions. Most
language servers support values like
`refactor` or `quickfix` .
{start_pos} ({number, number}, optional) mark-indexed
position. Defaults to the start of the last
visual selection.

31
runtime/lua/vim/lsp/buf.lua
View File

@ -466,14 +466,24 @@ local function code_action_request(params)
end)
end
--- Selects a code action from the input list that is available at the current
--- Selects a code action available at the current
--- cursor position.
---
---@param context: (table, optional) Valid `CodeActionContext` object
---@param context table|nil `CodeActionContext` of the LSP specification:
--- - diagnostics: (table|nil)
--- LSP `Diagnostic[]`. Inferred from the current
--- position if not provided.
--- - only: (string|nil)
--- LSP `CodeActionKind` used to filter the code actions.
--- Most language servers support values like `refactor`
--- or `quickfix`.
---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction
function M.code_action(context)
validate { context = { context, 't', true } }
context = context or { diagnostics = vim.lsp.diagnostic.get_line_diagnostics() }
context = context or {}
if not context.diagnostics then
context.diagnostics = vim.lsp.diagnostic.get_line_diagnostics()
end
local params = util.make_range_params()
params.context = context
code_action_request(params)
@ -481,14 +491,25 @@ end
--- Performs |vim.lsp.buf.code_action()| for a given range.
---
---@param context: (table, optional) Valid `CodeActionContext` object
---
---@param context table|nil `CodeActionContext` of the LSP specification:
--- - diagnostics: (table|nil)
--- LSP `Diagnostic[]`. Inferred from the current
--- position if not provided.
--- - only: (string|nil)
--- LSP `CodeActionKind` used to filter the code actions.
--- Most language servers support values like `refactor`
--- or `quickfix`.
---@param start_pos ({number, number}, optional) mark-indexed position.
---Defaults to the start of the last visual selection.
---@param end_pos ({number, number}, optional) mark-indexed position.
---Defaults to the end of the last visual selection.
function M.range_code_action(context, start_pos, end_pos)
validate { context = { context, 't', true } }
context = context or { diagnostics = vim.lsp.diagnostic.get_line_diagnostics() }
context = context or {}
if not context.diagnostics then
context.diagnostics = vim.lsp.diagnostic.get_line_diagnostics()
end
local params = util.make_given_range_params(start_pos, end_pos)
params.context = context
code_action_request(params)