2019-12-31 03:55:12 -07:00
|
|
|
*lsp.txt* LSP
|
2019-11-13 13:55:26 -07:00
|
|
|
|
|
|
|
|
2019-12-31 03:55:12 -07:00
|
|
|
NVIM REFERENCE MANUAL
|
2019-11-13 13:55:26 -07:00
|
|
|
|
|
|
|
|
2020-08-31 00:51:35 -07:00
|
|
|
LSP client/framework *lsp* *LSP*
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 03:55:12 -07:00
|
|
|
Nvim supports the Language Server Protocol (LSP), which means it acts as
|
|
|
|
a client to LSP servers and includes a Lua framework `vim.lsp` for building
|
|
|
|
enhanced LSP tools.
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2019-11-13 13:55:26 -07:00
|
|
|
https://microsoft.github.io/language-server-protocol/
|
|
|
|
|
2024-05-24 11:35:39 -07:00
|
|
|
LSP facilitates features like go-to-definition, find references, hover,
|
2019-12-31 03:55:12 -07:00
|
|
|
completion, rename, format, refactor, etc., using semantic whole-project
|
|
|
|
analysis (unlike |ctags|).
|
|
|
|
|
2019-11-25 02:08:02 -07:00
|
|
|
Type |gO| to see the table of contents.
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 03:55:12 -07:00
|
|
|
==============================================================================
|
|
|
|
QUICKSTART *lsp-quickstart*
|
2019-11-13 13:55:26 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Nvim provides an LSP client, but the servers are provided by third parties.
|
2019-12-31 03:55:12 -07:00
|
|
|
Follow these steps to get LSP features:
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2023-06-20 00:49:49 -07:00
|
|
|
1. Install language servers using your package manager or by following the
|
2024-05-24 11:35:39 -07:00
|
|
|
upstream installation instructions. You can find language servers here:
|
2023-06-20 00:49:49 -07:00
|
|
|
https://microsoft.github.io/language-server-protocol/implementors/servers/
|
2022-06-03 05:59:19 -07:00
|
|
|
|
2024-05-24 11:35:39 -07:00
|
|
|
2. Use |vim.lsp.start()| to start the LSP server (or attach to an existing
|
|
|
|
one) when a file is opened. Example: >lua
|
|
|
|
-- Create an event handler for the FileType autocommand
|
|
|
|
vim.api.nvim_create_autocmd('FileType', {
|
|
|
|
-- This handler will fire when the buffer's 'filetype' is "python"
|
|
|
|
pattern = 'python',
|
2024-07-06 02:41:55 -07:00
|
|
|
callback = function(args)
|
2024-05-24 11:35:39 -07:00
|
|
|
vim.lsp.start({
|
|
|
|
name = 'my-server-name',
|
|
|
|
cmd = {'name-of-language-server-executable', '--option', 'arg1', 'arg2'},
|
|
|
|
|
|
|
|
-- Set the "root directory" to the parent directory of the file in the
|
2024-07-06 02:41:55 -07:00
|
|
|
-- current buffer (`args.buf`) that contains either a "setup.py" or a
|
2024-05-24 11:35:39 -07:00
|
|
|
-- "pyproject.toml" file. Files that share a root directory will reuse
|
|
|
|
-- the connection to the same LSP server.
|
2024-07-06 02:41:55 -07:00
|
|
|
root_dir = vim.fs.root(args.buf, {'setup.py', 'pyproject.toml'}),
|
2024-05-24 11:35:39 -07:00
|
|
|
})
|
|
|
|
end,
|
2022-06-03 05:59:19 -07:00
|
|
|
})
|
|
|
|
<
|
2024-05-24 11:35:39 -07:00
|
|
|
3. Check that the buffer is attached to the server: >vim
|
|
|
|
:checkhealth lsp
|
2022-06-03 05:59:19 -07:00
|
|
|
|
2024-05-24 11:35:39 -07:00
|
|
|
4. (Optional) Configure keymaps and autocommands to use LSP features. |lsp-config|
|
2022-11-22 10:41:00 -07:00
|
|
|
|
2023-06-19 02:24:44 -07:00
|
|
|
*lsp-defaults*
|
2024-05-24 11:35:39 -07:00
|
|
|
When the Nvim LSP client starts it enables diagnostics |vim.diagnostic| (see
|
2023-06-19 02:24:44 -07:00
|
|
|
|vim.diagnostic.config()| to customize). It also sets various default options,
|
|
|
|
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
|
|
|
|
completion.
|
2022-09-25 16:58:27 -07:00
|
|
|
- 'tagfunc' is set to |vim.lsp.tagfunc()|. This enables features like
|
2022-07-10 08:26:43 -07:00
|
|
|
go-to-definition, |:tjump|, and keymaps like |CTRL-]|, |CTRL-W_]|,
|
|
|
|
|CTRL-W_}| to utilize the language server.
|
2023-06-19 02:24:44 -07:00
|
|
|
- 'formatexpr' is set to |vim.lsp.formatexpr()|, so you can format lines via
|
|
|
|
|gq| if the language server supports it.
|
2024-05-24 11:35:39 -07:00
|
|
|
- To opt out of this use |gw| instead of gq, or clear 'formatexpr' on |LspAttach|.
|
2023-07-14 09:47:18 -07:00
|
|
|
- |K| is mapped to |vim.lsp.buf.hover()| unless |'keywordprg'| is customized or
|
|
|
|
a custom keymap for `K` exists.
|
2022-06-03 05:59:19 -07:00
|
|
|
|
2024-05-24 09:33:49 -07:00
|
|
|
*grr* *gra* *grn* *i_CTRL-S*
|
|
|
|
Some keymaps are created unconditionally when Nvim starts:
|
|
|
|
- "grn" is mapped in Normal mode to |vim.lsp.buf.rename()|
|
|
|
|
- "gra" is mapped in Normal and Visual mode to |vim.lsp.buf.code_action()|
|
|
|
|
- "grr" is mapped in Normal mode to |vim.lsp.buf.references()|
|
|
|
|
- CTRL-S is mapped in Insert mode to |vim.lsp.buf.signature_help()|
|
|
|
|
|
|
|
|
If not wanted, these keymaps can be removed at any time using
|
|
|
|
|vim.keymap.del()| or |:unmap| (see also |gr-default|).
|
|
|
|
|
2023-06-19 02:24:44 -07:00
|
|
|
*lsp-defaults-disable*
|
2024-05-24 11:35:39 -07:00
|
|
|
To override or delete any of the above defaults, set or unset the options on
|
|
|
|
|LspAttach|: >lua
|
2024-04-26 09:12:49 -07:00
|
|
|
|
2023-06-19 02:24:44 -07:00
|
|
|
vim.api.nvim_create_autocmd('LspAttach', {
|
2024-07-06 02:41:55 -07:00
|
|
|
callback = function(args)
|
2024-10-06 11:53:29 -07:00
|
|
|
-- Unset 'formatexpr'
|
2024-07-06 02:41:55 -07:00
|
|
|
vim.bo[args.buf].formatexpr = nil
|
2024-10-06 11:53:29 -07:00
|
|
|
-- Unset 'omnifunc'
|
2024-07-06 02:41:55 -07:00
|
|
|
vim.bo[args.buf].omnifunc = nil
|
2024-10-06 11:53:29 -07:00
|
|
|
-- Unmap K
|
2024-07-06 02:41:55 -07:00
|
|
|
vim.keymap.del('n', 'K', { buffer = args.buf })
|
2023-06-19 02:24:44 -07:00
|
|
|
end,
|
|
|
|
})
|
2024-05-24 11:35:39 -07:00
|
|
|
<
|
|
|
|
*lsp-config*
|
2024-07-06 02:41:55 -07:00
|
|
|
To use other LSP features, set keymaps and other buffer options on
|
|
|
|
|LspAttach|. Not all language servers provide the same capabilities. Use
|
|
|
|
capability checks to ensure you only use features supported by the language
|
|
|
|
server. Example: >lua
|
2022-06-03 05:59:19 -07:00
|
|
|
|
|
|
|
vim.api.nvim_create_autocmd('LspAttach', {
|
|
|
|
callback = function(args)
|
|
|
|
local client = vim.lsp.get_client_by_id(args.data.client_id)
|
2024-04-26 09:12:49 -07:00
|
|
|
if client.supports_method('textDocument/implementation') then
|
2024-05-06 06:13:50 -07:00
|
|
|
-- Create a keymap for vim.lsp.buf.implementation
|
2022-06-03 05:59:19 -07:00
|
|
|
end
|
2024-07-06 02:41:55 -07:00
|
|
|
|
|
|
|
if client.supports_method('textDocument/completion') then
|
|
|
|
-- Enable auto-completion
|
|
|
|
vim.lsp.completion.enable(true, client.id, args.buf, {autotrigger = true})
|
|
|
|
end
|
|
|
|
|
|
|
|
if client.supports_method('textDocument/formatting') then
|
|
|
|
-- Format the current buffer on save
|
|
|
|
vim.api.nvim_create_autocmd('BufWritePre', {
|
|
|
|
buffer = args.buf,
|
|
|
|
callback = function()
|
|
|
|
vim.lsp.buf.format({bufnr = args.buf, id = client.id})
|
|
|
|
end,
|
|
|
|
})
|
2024-10-06 11:53:29 -07:00
|
|
|
end
|
2022-06-03 05:59:19 -07:00
|
|
|
end,
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
})
|
2022-06-03 05:59:19 -07:00
|
|
|
<
|
|
|
|
To learn what capabilities are available you can run the following command in
|
2023-06-20 00:49:49 -07:00
|
|
|
a buffer with a started LSP client: >vim
|
2022-06-03 05:59:19 -07:00
|
|
|
|
2023-07-17 09:27:16 -07:00
|
|
|
:lua =vim.lsp.get_clients()[1].server_capabilities
|
2020-05-05 08:23:45 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Full list of features provided by default can be found in |lsp-buf|.
|
2019-12-10 01:29:39 -07:00
|
|
|
|
2020-01-08 10:46:25 -07:00
|
|
|
================================================================================
|
|
|
|
FAQ *lsp-faq*
|
2019-12-10 01:29:39 -07:00
|
|
|
|
2020-01-08 10:46:25 -07:00
|
|
|
- Q: How to force-reload LSP?
|
2023-06-20 00:49:49 -07:00
|
|
|
- A: Stop all clients, then reload the buffer. >vim
|
2023-07-17 09:27:16 -07:00
|
|
|
:lua vim.lsp.stop_client(vim.lsp.get_clients())
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
:edit
|
2019-12-10 01:29:39 -07:00
|
|
|
|
2020-01-08 10:46:25 -07:00
|
|
|
- Q: Why isn't completion working?
|
2023-06-20 00:49:49 -07:00
|
|
|
- A: In the buffer where you want to use LSP, check that 'omnifunc' is set to
|
|
|
|
"v:lua.vim.lsp.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".
|
2020-01-08 10:46:25 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
- Q: How do I run a request synchronously (e.g. for formatting on file save)?
|
2023-06-20 00:49:49 -07:00
|
|
|
- A: Check if the function has an `async` parameter and set the value to
|
|
|
|
false. E.g. code formatting: >vim
|
2019-12-31 03:55:12 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
" Auto-format *.rs (rust) files prior to saving them
|
2022-08-30 04:14:09 -07:00
|
|
|
" (async = false is the default for format)
|
|
|
|
autocmd BufWritePre *.rs lua vim.lsp.buf.format({ async = false })
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
<
|
|
|
|
*lsp-vs-treesitter*
|
|
|
|
- Q: How do LSP and Treesitter compare?
|
2023-06-20 00:49:49 -07:00
|
|
|
- A: LSP requires a client and language server. The language server uses
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
semantic analysis to understand code at a project level. This provides
|
|
|
|
language servers with the ability to rename across files, find
|
|
|
|
definitions in external libraries and more.
|
|
|
|
|
|
|
|
Treesitter is a language parsing library that provides excellent tools
|
|
|
|
for incrementally parsing text and handling errors. This makes it a great
|
|
|
|
fit for editors to understand the contents of the current file for things
|
|
|
|
like syntax highlighting, simple goto-definitions, scope analysis and
|
|
|
|
more.
|
|
|
|
|
|
|
|
LSP and Treesitter are both great tools for editing and inspecting code.
|
|
|
|
|
|
|
|
================================================================================
|
|
|
|
LSP API *lsp-api*
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
LSP core API is described at |lsp-core|. Those are the core functions for
|
|
|
|
creating and managing clients.
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
The `vim.lsp.buf_…` functions perform operations for all LSP clients attached
|
|
|
|
to the given buffer. |lsp-buf|
|
2019-11-13 13:55:26 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
LSP request/response handlers are implemented as Lua functions (see
|
2023-06-23 03:16:55 -07:00
|
|
|
|lsp-handler|).
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
*lsp-method*
|
|
|
|
|
2023-06-23 03:16:55 -07:00
|
|
|
Requests and notifications defined by the LSP specification are referred to as
|
|
|
|
"LSP methods". The Nvim LSP client provides default handlers in the global
|
|
|
|
|vim.lsp.handlers| table, you can list them with this command: >vim
|
|
|
|
|
|
|
|
:lua vim.print(vim.tbl_keys(vim.lsp.handlers))
|
|
|
|
<
|
|
|
|
They are also listed below. Note that handlers depend on server support: they
|
|
|
|
won't run if your server doesn't support them.
|
2023-06-20 00:49:49 -07:00
|
|
|
|
|
|
|
- callHierarchy/incomingCalls
|
|
|
|
- callHierarchy/outgoingCalls
|
|
|
|
- textDocument/codeAction
|
|
|
|
- textDocument/completion
|
|
|
|
- textDocument/declaration*
|
|
|
|
- textDocument/definition
|
2023-07-20 00:03:48 -07:00
|
|
|
- textDocument/diagnostic
|
2023-06-20 00:49:49 -07:00
|
|
|
- textDocument/documentHighlight
|
|
|
|
- textDocument/documentSymbol
|
|
|
|
- textDocument/formatting
|
|
|
|
- textDocument/hover
|
|
|
|
- textDocument/implementation*
|
|
|
|
- textDocument/inlayHint
|
2024-04-20 06:40:01 -07:00
|
|
|
- textDocument/prepareTypeHierarchy
|
2023-06-20 00:49:49 -07:00
|
|
|
- textDocument/publishDiagnostics
|
|
|
|
- textDocument/rangeFormatting
|
2024-06-24 07:54:56 -07:00
|
|
|
- textDocument/rangesFormatting
|
2023-06-20 00:49:49 -07:00
|
|
|
- textDocument/references
|
|
|
|
- textDocument/rename
|
|
|
|
- textDocument/semanticTokens/full
|
|
|
|
- textDocument/semanticTokens/full/delta
|
|
|
|
- textDocument/signatureHelp
|
|
|
|
- textDocument/typeDefinition*
|
2024-04-20 06:40:01 -07:00
|
|
|
- typeHierarchy/subtypes
|
|
|
|
- typeHierarchy/supertypes
|
2023-06-20 00:49:49 -07:00
|
|
|
- window/logMessage
|
|
|
|
- window/showMessage
|
|
|
|
- window/showDocument
|
|
|
|
- window/showMessageRequest
|
|
|
|
- workspace/applyEdit
|
2023-06-23 03:16:55 -07:00
|
|
|
- workspace/configuration
|
|
|
|
- workspace/executeCommand
|
2023-06-20 00:49:49 -07:00
|
|
|
- workspace/inlayHint/refresh
|
|
|
|
- workspace/symbol
|
2023-06-23 03:16:55 -07:00
|
|
|
- workspace/workspaceFolders
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
*lsp-handler*
|
2023-06-20 00:49:49 -07:00
|
|
|
LSP handlers are functions that handle |lsp-response|s to requests made by Nvim
|
|
|
|
to the server. (Notifications, as opposed to requests, are fire-and-forget:
|
|
|
|
there is no response, so they can't be handled. |lsp-notification|)
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2023-06-20 00:49:49 -07:00
|
|
|
Each response handler has this signature: >
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2023-06-20 00:49:49 -07:00
|
|
|
function(err, result, ctx, config)
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
<
|
|
|
|
Parameters: ~
|
2024-06-17 16:04:40 -07:00
|
|
|
• {err} (`table|nil`) Error info dict, or `nil` if the request
|
|
|
|
completed.
|
|
|
|
• {result} (`Result|Params|nil`) `result` key of the |lsp-response| or
|
|
|
|
`nil` if the request failed.
|
|
|
|
• {ctx} (`table`) Table of calling state associated with the
|
|
|
|
handler, with these keys:
|
|
|
|
• {method} (`string`) |lsp-method| name.
|
|
|
|
• {client_id} (`number`) |vim.lsp.Client| identifier.
|
|
|
|
• {bufnr} (`Buffer`) Buffer handle.
|
|
|
|
• {params} (`table|nil`) Request parameters table.
|
|
|
|
• {version} (`number`) Document version at time of
|
|
|
|
request. Handlers can compare this to the
|
|
|
|
current document version to check if the
|
|
|
|
response is "stale". See also |b:changedtick|.
|
|
|
|
• {config} (`table`) Handler-defined configuration table, which allows
|
|
|
|
users to customize handler behavior.
|
|
|
|
For an example, see:
|
|
|
|
|vim.lsp.diagnostic.on_publish_diagnostics()|
|
|
|
|
To configure a particular |lsp-handler|, see:
|
|
|
|
|lsp-handler-configuration|
|
2022-08-11 05:25:48 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Returns: ~
|
2023-06-20 00:49:49 -07:00
|
|
|
Two values `result, err` where `err` is shaped like an RPC error: >
|
|
|
|
{ code, message, data? }
|
|
|
|
< You can use |vim.lsp.rpc.rpc_response_error()| to create this object.
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
*lsp-handler-configuration*
|
|
|
|
|
2020-12-30 15:39:05 -07:00
|
|
|
To configure the behavior of a builtin |lsp-handler|, the convenient method
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|vim.lsp.with()| is provided for users.
|
|
|
|
|
|
|
|
To configure the behavior of |vim.lsp.diagnostic.on_publish_diagnostics()|,
|
|
|
|
consider the following example, where a new |lsp-handler| is created using
|
2022-11-22 10:41:00 -07:00
|
|
|
|vim.lsp.with()| that no longer generates signs for the diagnostics: >lua
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
vim.lsp.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
|
|
-- Disable signs
|
|
|
|
signs = false,
|
|
|
|
}
|
|
|
|
)
|
|
|
|
<
|
|
|
|
To enable signs, use |vim.lsp.with()| again to create and assign a new
|
2022-11-22 10:41:00 -07:00
|
|
|
|lsp-handler| to |vim.lsp.handlers| for the associated method: >lua
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
vim.lsp.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
|
|
-- Enable signs
|
|
|
|
signs = true,
|
|
|
|
}
|
|
|
|
)
|
|
|
|
<
|
|
|
|
To configure a handler on a per-server basis, you can use the {handlers} key
|
2022-11-22 10:41:00 -07:00
|
|
|
for |vim.lsp.start_client()| >lua
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
vim.lsp.start_client {
|
|
|
|
..., -- Other configuration omitted.
|
|
|
|
handlers = {
|
|
|
|
["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
|
|
-- Disable virtual_text
|
|
|
|
virtual_text = false,
|
|
|
|
}
|
2022-08-11 05:25:48 -07:00
|
|
|
),
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
},
|
|
|
|
}
|
|
|
|
<
|
2022-12-11 19:41:26 -07:00
|
|
|
or if using "nvim-lspconfig", you can use the {handlers} key of `setup()`:
|
2022-11-22 10:41:00 -07:00
|
|
|
>lua
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2020-11-15 23:13:15 -07:00
|
|
|
require('lspconfig').rust_analyzer.setup {
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
handlers = {
|
|
|
|
["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
|
|
-- Disable virtual_text
|
|
|
|
virtual_text = false
|
|
|
|
}
|
|
|
|
),
|
|
|
|
}
|
|
|
|
}
|
2021-07-26 11:39:50 -07:00
|
|
|
<
|
|
|
|
Some handlers do not have an explicitly named handler function (such as
|
2024-10-07 08:27:38 -07:00
|
|
|
|vim.lsp.diagnostic.on_publish_diagnostics()|). To override these, first
|
2022-11-22 10:41:00 -07:00
|
|
|
create a reference to the existing handler: >lua
|
2021-07-26 11:39:50 -07:00
|
|
|
|
|
|
|
local on_references = vim.lsp.handlers["textDocument/references"]
|
|
|
|
vim.lsp.handlers["textDocument/references"] = vim.lsp.with(
|
|
|
|
on_references, {
|
|
|
|
-- Use location list instead of quickfix list
|
|
|
|
loclist = true,
|
|
|
|
}
|
|
|
|
)
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
<
|
|
|
|
*lsp-handler-resolution*
|
|
|
|
Handlers can be set by:
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2022-03-09 23:34:55 -07:00
|
|
|
- Setting a field in vim.lsp.handlers. *vim.lsp.handlers*
|
2023-06-19 08:40:33 -07:00
|
|
|
vim.lsp.handlers is a global table that contains the default mapping of
|
|
|
|
|lsp-method| names to |lsp-handlers|. To override the handler for the
|
|
|
|
`"textDocument/definition"` method: >lua
|
2019-11-20 17:03:32 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
vim.lsp.handlers["textDocument/definition"] = my_custom_default_definition
|
|
|
|
<
|
2023-06-19 08:40:33 -07:00
|
|
|
- The {handlers} parameter of |vim.lsp.start()|. This sets the default
|
|
|
|
|lsp-handler| for the server being started. Example: >lua
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2023-06-19 08:40:33 -07:00
|
|
|
vim.lsp.start {
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
..., -- Other configuration omitted.
|
|
|
|
handlers = {
|
|
|
|
["textDocument/definition"] = my_custom_server_definition
|
|
|
|
},
|
|
|
|
}
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2023-06-19 08:40:33 -07:00
|
|
|
- The {handler} parameter of |vim.lsp.buf_request_all()|. This sets
|
|
|
|
the |lsp-handler| ONLY for the given request(s). Example: >lua
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2023-06-19 08:40:33 -07:00
|
|
|
vim.lsp.buf_request_all(
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
0,
|
|
|
|
"textDocument/definition",
|
2023-06-19 08:40:33 -07:00
|
|
|
my_request_params,
|
|
|
|
my_handler
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
)
|
|
|
|
<
|
|
|
|
In summary, the |lsp-handler| will be chosen based on the current |lsp-method|
|
|
|
|
in the following order:
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2023-06-19 08:40:33 -07:00
|
|
|
1. Handler passed to |vim.lsp.buf_request_all()|, if any.
|
|
|
|
2. Handler defined in |vim.lsp.start()|, if any.
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
3. Handler defined in |vim.lsp.handlers|, if any.
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
*vim.lsp.log_levels*
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Log levels are defined in |vim.log.levels|
|
2021-12-28 10:15:16 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2019-11-25 02:08:02 -07:00
|
|
|
VIM.LSP.PROTOCOL *vim.lsp.protocol*
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 03:55:12 -07:00
|
|
|
Module `vim.lsp.protocol` defines constants dictated by the LSP specification,
|
|
|
|
and helper functions for creating protocol-related objects.
|
|
|
|
https://github.com/microsoft/language-server-protocol/raw/gh-pages/_specifications/specification-3-14.md
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
For example `vim.lsp.protocol.ErrorCodes` allows reverse lookup by number or
|
2022-11-22 10:41:00 -07:00
|
|
|
name: >lua
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
vim.lsp.protocol.TextDocumentSyncKind.Full == 1
|
|
|
|
vim.lsp.protocol.TextDocumentSyncKind[1] == "Full"
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
<
|
|
|
|
|
|
|
|
*lsp-response*
|
2023-06-20 00:49:49 -07:00
|
|
|
LSP response shape:
|
|
|
|
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#responseMessage
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
*lsp-notification*
|
2023-06-20 00:49:49 -07:00
|
|
|
LSP notification shape:
|
|
|
|
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
|
2019-11-13 13:55:26 -07:00
|
|
|
|
2020-02-26 12:10:16 -07:00
|
|
|
================================================================================
|
|
|
|
LSP HIGHLIGHT *lsp-highlight*
|
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Reference Highlights:
|
|
|
|
|
2021-02-24 09:23:47 -07:00
|
|
|
Highlight groups that are meant to be used by |vim.lsp.buf.document_highlight()|.
|
|
|
|
|
|
|
|
You can see more about the differences in types here:
|
|
|
|
https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight
|
|
|
|
|
2020-02-26 12:10:16 -07:00
|
|
|
*hl-LspReferenceText*
|
|
|
|
LspReferenceText used for highlighting "text" references
|
|
|
|
*hl-LspReferenceRead*
|
|
|
|
LspReferenceRead used for highlighting "read" references
|
|
|
|
*hl-LspReferenceWrite*
|
|
|
|
LspReferenceWrite used for highlighting "write" references
|
2023-06-20 03:20:17 -07:00
|
|
|
*hl-LspInlayHint*
|
|
|
|
LspInlayHint used for highlighting inlay hints
|
2020-02-26 12:10:16 -07:00
|
|
|
|
|
|
|
|
2021-06-18 05:23:33 -07:00
|
|
|
*lsp-highlight-codelens*
|
|
|
|
|
|
|
|
Highlight groups related to |lsp-codelens| functionality.
|
|
|
|
|
|
|
|
*hl-LspCodeLens*
|
|
|
|
LspCodeLens
|
|
|
|
Used to color the virtual text of the codelens. See
|
2021-08-03 10:38:41 -07:00
|
|
|
|nvim_buf_set_extmark()|.
|
2021-06-18 05:23:33 -07:00
|
|
|
|
2021-07-10 12:35:38 -07:00
|
|
|
LspCodeLensSeparator *hl-LspCodeLensSeparator*
|
|
|
|
Used to color the separator between two or more code lenses.
|
|
|
|
|
2021-07-07 23:04:35 -07:00
|
|
|
*lsp-highlight-signature*
|
|
|
|
|
|
|
|
Highlight groups related to |vim.lsp.handlers.signature_help()|.
|
|
|
|
|
|
|
|
*hl-LspSignatureActiveParameter*
|
|
|
|
LspSignatureActiveParameter
|
|
|
|
Used to highlight the active parameter in the signature help. See
|
|
|
|
|vim.lsp.handlers.signature_help()|.
|
|
|
|
|
2023-03-06 11:03:13 -07:00
|
|
|
------------------------------------------------------------------------------
|
|
|
|
LSP SEMANTIC HIGHLIGHTS *lsp-semantic-highlight*
|
|
|
|
|
|
|
|
When available, the LSP client highlights code using |lsp-semantic_tokens|,
|
|
|
|
which are another way that LSP servers can provide information about source
|
|
|
|
code. Note that this is in addition to treesitter syntax highlighting;
|
|
|
|
semantic highlighting does not replace syntax highlighting.
|
|
|
|
|
|
|
|
The server will typically provide one token per identifier in the source code.
|
|
|
|
The token will have a `type` such as "function" or "variable", and 0 or more
|
|
|
|
`modifier`s such as "readonly" or "deprecated." The standard types and
|
|
|
|
modifiers are described here:
|
2023-10-16 08:13:37 -07:00
|
|
|
https://microsoft.github.io/language-server-protocol/specification/#textDocument_semanticTokens
|
2023-03-06 11:03:13 -07:00
|
|
|
LSP servers may also use off-spec types and modifiers.
|
|
|
|
|
|
|
|
The LSP client adds one or more highlights for each token. The highlight
|
|
|
|
groups are derived from the token's type and modifiers:
|
|
|
|
• `@lsp.type.<type>.<ft>` for the type
|
|
|
|
• `@lsp.mod.<mod>.<ft>` for each modifier
|
|
|
|
• `@lsp.typemod.<type>.<mod>.<ft>` for each modifier
|
2023-04-04 10:07:33 -07:00
|
|
|
Use |:Inspect| to view the highlights for a specific token. Use |:hi| or
|
2023-03-06 11:03:13 -07:00
|
|
|
|nvim_set_hl()| to change the appearance of semantic highlights: >vim
|
|
|
|
|
|
|
|
hi @lsp.type.function guifg=Yellow " function names are yellow
|
|
|
|
hi @lsp.type.variable.lua guifg=Green " variables in lua are green
|
|
|
|
hi @lsp.mod.deprecated gui=strikethrough " deprecated is crossed out
|
|
|
|
hi @lsp.typemod.function.async guifg=Blue " async functions are blue
|
|
|
|
<
|
|
|
|
The value |vim.highlight.priorities|`.semantic_tokens` is the priority of the
|
|
|
|
`@lsp.type.*` highlights. The `@lsp.mod.*` and `@lsp.typemod.*` highlights
|
|
|
|
have priorities one and two higher, respectively.
|
|
|
|
|
|
|
|
You can disable semantic highlights by clearing the highlight groups: >lua
|
|
|
|
|
|
|
|
-- Hide semantic highlights for functions
|
|
|
|
vim.api.nvim_set_hl(0, '@lsp.type.function', {})
|
|
|
|
|
|
|
|
-- Hide all semantic highlights
|
|
|
|
for _, group in ipairs(vim.fn.getcompletion("@lsp", "highlight")) do
|
|
|
|
vim.api.nvim_set_hl(0, group, {})
|
|
|
|
end
|
|
|
|
<
|
|
|
|
You probably want these inside a |ColorScheme| autocommand.
|
|
|
|
|
|
|
|
Use |LspTokenUpdate| and |vim.lsp.semantic_tokens.highlight_token()| for more
|
|
|
|
complex highlighting.
|
|
|
|
|
2024-03-19 03:11:10 -07:00
|
|
|
The following is a list of standard captures used in queries for Nvim,
|
|
|
|
highlighted according to the current colorscheme (use |:Inspect| on one to see
|
|
|
|
the exact definition):
|
|
|
|
|
|
|
|
@lsp.type.class Identifiers that declare or reference a class type
|
|
|
|
@lsp.type.comment Tokens that represent a comment
|
|
|
|
@lsp.type.decorator Identifiers that declare or reference decorators and annotations
|
|
|
|
@lsp.type.enum Identifiers that declare or reference an enumeration type
|
|
|
|
@lsp.type.enumMember Identifiers that declare or reference an enumeration property, constant, or member
|
|
|
|
@lsp.type.event Identifiers that declare an event property
|
|
|
|
@lsp.type.function Identifiers that declare a function
|
|
|
|
@lsp.type.interface Identifiers that declare or reference an interface type
|
|
|
|
@lsp.type.keyword Tokens that represent a language keyword
|
|
|
|
@lsp.type.macro Identifiers that declare a macro
|
|
|
|
@lsp.type.method Identifiers that declare a member function or method
|
|
|
|
@lsp.type.modifier Tokens that represent a modifier
|
|
|
|
@lsp.type.namespace Identifiers that declare or reference a namespace, module, or package
|
|
|
|
@lsp.type.number Tokens that represent a number literal
|
|
|
|
@lsp.type.operator Tokens that represent an operator
|
|
|
|
@lsp.type.parameter Identifiers that declare or reference a function or method parameters
|
|
|
|
@lsp.type.property Identifiers that declare or reference a member property, member field, or member variable
|
|
|
|
@lsp.type.regexp Tokens that represent a regular expression literal
|
|
|
|
@lsp.type.string Tokens that represent a string literal
|
|
|
|
@lsp.type.struct Identifiers that declare or reference a struct type
|
|
|
|
@lsp.type.type Identifiers that declare or reference a type that is not covered above
|
|
|
|
@lsp.type.typeParameter Identifiers that declare or reference a type parameter
|
|
|
|
@lsp.type.variable Identifiers that declare or reference a local or global variable
|
|
|
|
|
|
|
|
@lsp.mod.abstract Types and member functions that are abstract
|
|
|
|
@lsp.mod.async Functions that are marked async
|
|
|
|
@lsp.mod.declaration Declarations of symbols
|
|
|
|
@lsp.mod.defaultLibrary Symbols that are part of the standard library
|
|
|
|
@lsp.mod.definition Definitions of symbols, for example, in header files
|
|
|
|
@lsp.mod.deprecated Symbols that should no longer be used
|
|
|
|
@lsp.mod.documentation Occurrences of symbols in documentation
|
|
|
|
@lsp.mod.modification Variable references where the variable is assigned to
|
|
|
|
@lsp.mod.readonly Readonly variables and member fields (constants)
|
|
|
|
@lsp.mod.static Class members (static members)
|
2023-12-18 08:49:44 -07:00
|
|
|
|
2021-10-29 05:45:01 -07:00
|
|
|
==============================================================================
|
|
|
|
EVENTS *lsp-events*
|
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
LspAttach *LspAttach*
|
|
|
|
After an LSP client attaches to a buffer. The |autocmd-pattern| is the
|
|
|
|
name of the buffer. When used from Lua, the client ID is passed to the
|
2024-10-06 11:53:29 -07:00
|
|
|
callback in the "data" table. See |lsp-config| for an example.
|
2023-07-21 04:42:47 -07:00
|
|
|
|
|
|
|
LspDetach *LspDetach*
|
|
|
|
Just before an LSP client detaches from a buffer. The |autocmd-pattern|
|
|
|
|
is the name of the buffer. When used from Lua, the client ID is passed
|
|
|
|
to the callback in the "data" table. Example: >lua
|
2022-05-09 11:00:27 -07:00
|
|
|
|
2024-10-06 11:53:29 -07:00
|
|
|
vim.api.nvim_create_autocmd('LspDetach', {
|
2022-05-09 11:00:27 -07:00
|
|
|
callback = function(args)
|
2024-10-06 11:53:29 -07:00
|
|
|
-- Get the detaching client
|
2022-05-09 11:00:27 -07:00
|
|
|
local client = vim.lsp.get_client_by_id(args.data.client_id)
|
2024-10-06 11:53:29 -07:00
|
|
|
|
|
|
|
-- Remove the autocommand to format the buffer on save, if it exists
|
|
|
|
if client.supports_method('textDocument/formatting') then
|
|
|
|
vim.api.nvim_clear_autocmds({
|
|
|
|
event = 'BufWritePre',
|
|
|
|
buffer = args.buf,
|
|
|
|
})
|
|
|
|
end
|
2022-05-09 11:00:27 -07:00
|
|
|
end,
|
|
|
|
})
|
|
|
|
<
|
2023-03-06 11:03:13 -07:00
|
|
|
|
2023-07-20 00:03:48 -07:00
|
|
|
LspNotify *LspNotify*
|
2023-07-21 04:42:47 -07:00
|
|
|
This event is triggered after each successful notification sent to an
|
|
|
|
LSP server.
|
2023-07-20 00:03:48 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
When used from Lua, the client_id, LSP method, and parameters are sent
|
|
|
|
in the "data" table. Example: >lua
|
2023-07-20 00:03:48 -07:00
|
|
|
|
|
|
|
vim.api.nvim_create_autocmd('LspNotify', {
|
|
|
|
callback = function(args)
|
|
|
|
local bufnr = args.buf
|
|
|
|
local client_id = args.data.client_id
|
|
|
|
local method = args.data.method
|
|
|
|
local params = args.data.params
|
|
|
|
|
|
|
|
-- do something with the notification
|
|
|
|
if method == 'textDocument/...' then
|
|
|
|
update_buffer(bufnr)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
})
|
|
|
|
<
|
2023-05-30 11:56:29 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
LspProgress *LspProgress*
|
|
|
|
Upon receipt of a progress notification from the server. Notifications can
|
2024-02-27 08:20:32 -07:00
|
|
|
be polled from a `progress` ring buffer of a |vim.lsp.Client| or use
|
2024-05-07 11:09:27 -07:00
|
|
|
|vim.lsp.status()| to get an aggregate message.
|
2023-07-21 04:42:47 -07:00
|
|
|
|
|
|
|
If the server sends a "work done progress", the `pattern` is set to `kind`
|
|
|
|
(one of `begin`, `report` or `end`).
|
2023-05-30 11:56:29 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
When used from Lua, the event contains a `data` table with `client_id` and
|
2024-05-07 11:09:27 -07:00
|
|
|
`params` properties. `params` will contain the request params sent by the
|
|
|
|
server (see `lsp.ProgressParams`).
|
2023-05-30 11:56:29 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
Example: >vim
|
|
|
|
autocmd LspProgress * redrawstatus
|
|
|
|
<
|
2023-05-30 11:56:29 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
LspRequest *LspRequest*
|
|
|
|
For each request sent to an LSP server, this event is triggered for
|
|
|
|
every change to the request's status. The status can be one of
|
|
|
|
`pending`, `complete`, or `cancel` and is sent as the {type} on the
|
|
|
|
"data" table passed to the callback function.
|
|
|
|
|
|
|
|
It triggers when the initial request is sent ({type} == `pending`) and
|
2023-09-13 21:05:27 -07:00
|
|
|
when the LSP server responds ({type} == `complete`). If a cancellation
|
2023-07-21 04:42:47 -07:00
|
|
|
is requested using `client.cancel_request(request_id)`, then this event
|
|
|
|
will trigger with {type} == `cancel`.
|
|
|
|
|
|
|
|
When used from Lua, the client ID, request ID, and request are sent in
|
2024-02-27 08:20:32 -07:00
|
|
|
the "data" table. See {requests} in |vim.lsp.Client| for details on the
|
2023-07-21 04:42:47 -07:00
|
|
|
{request} value. If the request type is `complete`, the request will be
|
|
|
|
deleted from the client's pending requests table immediately after
|
|
|
|
calling the event's callbacks. Example: >lua
|
2023-05-30 11:56:29 -07:00
|
|
|
|
|
|
|
vim.api.nvim_create_autocmd('LspRequest', {
|
|
|
|
callback = function(args)
|
|
|
|
local bufnr = args.buf
|
|
|
|
local client_id = args.data.client_id
|
|
|
|
local request_id = args.data.request_id
|
|
|
|
local request = args.data.request
|
|
|
|
if request.type == 'pending' then
|
|
|
|
-- do something with pending requests
|
|
|
|
track_pending(client_id, bufnr, request_id, request)
|
|
|
|
elseif request.type == 'cancel' then
|
|
|
|
-- do something with pending cancel requests
|
|
|
|
track_canceling(client_id, bufnr, request_id, request)
|
|
|
|
elseif request.type == 'complete' then
|
|
|
|
-- do something with finished requests. this pending
|
|
|
|
-- request entry is about to be removed since it is complete
|
|
|
|
track_finish(client_id, bufnr, request_id, request)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
})
|
|
|
|
<
|
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
LspTokenUpdate *LspTokenUpdate*
|
|
|
|
When a visible semantic token is sent or updated by the LSP server, or
|
|
|
|
when an existing token becomes visible for the first time. The
|
|
|
|
|autocmd-pattern| is the name of the buffer. When used from Lua, the
|
|
|
|
token and client ID are passed to the callback in the "data" table. The
|
|
|
|
token fields are documented in |vim.lsp.semantic_tokens.get_at_pos()|.
|
|
|
|
Example:
|
|
|
|
>lua
|
2021-10-29 05:45:01 -07:00
|
|
|
|
2023-07-21 04:42:47 -07:00
|
|
|
vim.api.nvim_create_autocmd('LspTokenUpdate', {
|
|
|
|
callback = function(args)
|
|
|
|
local token = args.data.token
|
|
|
|
if token.type == 'variable' and not token.modifiers.readonly then
|
|
|
|
vim.lsp.semantic_tokens.highlight_token(
|
|
|
|
token, args.buf, args.data.client_id, 'MyMutableVariableHighlight'
|
|
|
|
)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
})
|
2021-10-29 05:45:01 -07:00
|
|
|
<
|
2023-07-21 04:42:47 -07:00
|
|
|
Note: doing anything other than calling
|
|
|
|
|vim.lsp.semantic_tokens.highlight_token()| is considered experimental.
|
2021-10-29 05:45:01 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp *lsp-core*
|
|
|
|
|
|
|
|
buf_attach_client({bufnr}, {client_id}) *vim.lsp.buf_attach_client()*
|
|
|
|
Implements the `textDocument/did…` notifications required to track a
|
|
|
|
buffer for any language server.
|
|
|
|
|
|
|
|
Without calling this, the server won't be notified of changes to a buffer.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer handle, or 0 for current
|
|
|
|
• {client_id} (`integer`) Client id
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2023-06-20 12:17:13 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) success `true` if client was attached successfully;
|
|
|
|
`false` otherwise
|
2023-06-20 12:17:13 -07:00
|
|
|
|
2021-12-23 05:55:38 -07:00
|
|
|
buf_detach_client({bufnr}, {client_id}) *vim.lsp.buf_detach_client()*
|
|
|
|
Detaches client from the specified buffer. Note: While the server is
|
|
|
|
notified that the text document (buffer) was closed, it is still able to
|
|
|
|
send notifications should it ignore this notification.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer handle, or 0 for current
|
|
|
|
• {client_id} (`integer`) Client id
|
2021-12-23 05:55:38 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
buf_is_attached({bufnr}, {client_id}) *vim.lsp.buf_is_attached()*
|
|
|
|
Checks if a buffer is attached for a particular client.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer handle, or 0 for current
|
|
|
|
• {client_id} (`integer`) the client id
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
buf_notify({bufnr}, {method}, {params}) *vim.lsp.buf_notify()*
|
2020-07-02 04:09:17 -07:00
|
|
|
Send a notification to a server
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) The number of the buffer
|
|
|
|
• {method} (`string`) Name of the request method
|
|
|
|
• {params} (`any`) Arguments to send to the server
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) success true if any client returns true; false otherwise
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2021-04-24 03:47:52 -07:00
|
|
|
*vim.lsp.buf_request_all()*
|
2023-06-19 08:40:33 -07:00
|
|
|
buf_request_all({bufnr}, {method}, {params}, {handler})
|
|
|
|
Sends an async request for all active clients attached to the buffer and
|
|
|
|
executes the `handler` callback with the combined result.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-04-24 03:47:52 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer handle, or 0 for current.
|
|
|
|
• {method} (`string`) LSP method name
|
|
|
|
• {params} (`table?`) Parameters to send to the server
|
|
|
|
• {handler} (`function`) Handler called after all requests are
|
|
|
|
completed. Server results are passed as a
|
|
|
|
`client_id:result` map.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-04-24 03:47:52 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`function`) cancel Function that cancels all requests.
|
2021-04-24 03:47:52 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
*vim.lsp.buf_request_sync()*
|
|
|
|
buf_request_sync({bufnr}, {method}, {params}, {timeout_ms})
|
2021-04-24 03:47:52 -07:00
|
|
|
Sends a request to all server and waits for the response of all of them.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-04-24 03:47:52 -07:00
|
|
|
Calls |vim.lsp.buf_request_all()| but blocks Nvim while awaiting the
|
2023-06-19 08:40:33 -07:00
|
|
|
result. Parameters are the same as |vim.lsp.buf_request_all()| but the
|
2024-03-05 05:06:15 -07:00
|
|
|
result is different. Waits a maximum of {timeout_ms}.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer handle, or 0 for current.
|
|
|
|
• {method} (`string`) LSP method name
|
|
|
|
• {params} (`table?`) Parameters to send to the server
|
2024-03-05 05:06:15 -07:00
|
|
|
• {timeout_ms} (`integer?`, default: `1000`) Maximum time in
|
|
|
|
milliseconds to wait for a result.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2023-07-06 06:32:39 -07:00
|
|
|
Return (multiple): ~
|
2024-05-14 16:18:33 -07:00
|
|
|
(`table<integer, {error: lsp.ResponseError?, result: any}>?`) result
|
|
|
|
Map of client_id:request_result.
|
2024-01-09 10:36:46 -07:00
|
|
|
(`string?`) err On timeout, cancel, or error, `err` is a string
|
2023-03-11 06:50:53 -07:00
|
|
|
describing the failure reason, and `result` is nil.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
client_is_stopped({client_id}) *vim.lsp.client_is_stopped()*
|
2020-08-19 09:17:08 -07:00
|
|
|
Checks whether a client is stopped.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {client_id} (`integer`)
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) stopped true if client is stopped, false otherwise.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2023-07-18 07:42:30 -07:00
|
|
|
commands *vim.lsp.commands*
|
|
|
|
Registry for client side commands. This is an extension point for plugins
|
|
|
|
to handle custom commands which are not part of the core language server
|
|
|
|
protocol specification.
|
|
|
|
|
|
|
|
The registry is a table where the key is a unique command name, and the
|
|
|
|
value is a function which is called if any LSP action (code action, code
|
|
|
|
lenses, ...) triggers the command.
|
|
|
|
|
|
|
|
If a LSP response contains a command for which no matching entry is
|
|
|
|
available in this registry, the command will be executed via the LSP
|
|
|
|
server using `workspace/executeCommand`.
|
|
|
|
|
|
|
|
The first argument to the function will be the `Command`: Command title:
|
|
|
|
String command: String arguments?: any[]
|
|
|
|
|
|
|
|
The second argument is the `ctx` of |lsp-handler|
|
|
|
|
|
2021-11-18 14:50:55 -07:00
|
|
|
formatexpr({opts}) *vim.lsp.formatexpr()*
|
|
|
|
Provides an interface between the built-in client and a `formatexpr`
|
|
|
|
function.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2024-03-08 05:25:18 -07:00
|
|
|
Currently only supports a single client. This can be set via
|
2024-08-28 15:11:32 -07:00
|
|
|
`setlocal formatexpr=v:lua.vim.lsp.formatexpr()` or (more typically) in
|
2024-03-08 05:25:18 -07:00
|
|
|
`on_attach` via
|
|
|
|
`vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})'`.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-11-18 14:50:55 -07:00
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {opts} (`table?`) A table with the following fields:
|
|
|
|
• {timeout_ms} (`integer`, default: 500ms) The timeout period
|
|
|
|
for the formatting request..
|
2021-11-18 14:50:55 -07:00
|
|
|
|
2021-01-23 09:43:06 -07:00
|
|
|
*vim.lsp.get_buffers_by_client_id()*
|
|
|
|
get_buffers_by_client_id({client_id})
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Returns list of buffers attached to client_id.
|
2021-11-27 09:10:48 -07:00
|
|
|
|
2021-01-23 09:43:06 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {client_id} (`integer`) client id
|
2021-01-23 09:43:06 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer[]`) buffers list of buffer ids
|
2021-01-23 09:43:06 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
get_client_by_id({client_id}) *vim.lsp.get_client_by_id()*
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Gets a client by id, or nil if the id is invalid. The returned client may
|
|
|
|
not yet be fully initialized.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {client_id} (`integer`) client id
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
(`vim.lsp.Client?`) client rpc object
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2023-07-17 09:27:16 -07:00
|
|
|
get_clients({filter}) *vim.lsp.get_clients()*
|
|
|
|
Get active clients.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {filter} (`table?`) Key-value pairs used to filter the returned
|
|
|
|
clients.
|
|
|
|
• {id}? (`integer`) Only return clients with the given id
|
|
|
|
• {bufnr}? (`integer`) Only return clients attached to this
|
2023-07-17 09:27:16 -07:00
|
|
|
buffer
|
2024-02-27 08:20:32 -07:00
|
|
|
• {name}? (`string`) Only return clients with the given name
|
|
|
|
• {method}? (`string`) Only return clients supporting the
|
|
|
|
given method
|
2023-07-17 09:27:16 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
(`vim.lsp.Client[]`) List of |vim.lsp.Client| objects
|
2023-07-17 09:27:16 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
get_log_path() *vim.lsp.get_log_path()*
|
2020-08-19 09:17:08 -07:00
|
|
|
Gets the path of the logfile used by the LSP client.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`string`) path to log file
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
|
2020-01-13 00:41:55 -07:00
|
|
|
Implements 'omnifunc' compatible LSP completion.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {findstart} (`integer`) 0 or 1, decides behavior
|
|
|
|
• {base} (`integer`) findstart=0, text to match against
|
2020-01-13 00:41:55 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer|table`) Decided by {findstart}:
|
2020-01-13 00:41:55 -07:00
|
|
|
• findstart=0: column where the completion starts, or -2 or -3
|
|
|
|
• findstart=1: list of matches (actually just calls |complete()|)
|
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• |complete-functions|
|
|
|
|
• |complete-items|
|
|
|
|
• |CompleteDone|
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
set_log_level({level}) *vim.lsp.set_log_level()*
|
|
|
|
Sets the global log level for LSP logging.
|
|
|
|
|
2022-05-03 07:49:23 -07:00
|
|
|
Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
|
|
|
|
|
2022-01-17 11:28:23 -07:00
|
|
|
Level numbers begin with "TRACE" at 0
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
Use `lsp.log_levels` for reverse lookup.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {level} (`integer|string`) the case insensitive level name or number
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• |vim.lsp.log_levels|
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2022-06-03 05:59:19 -07:00
|
|
|
start({config}, {opts}) *vim.lsp.start()*
|
|
|
|
Create a new LSP client and start a language server or reuses an already
|
|
|
|
running client if one is found matching `name` and `root_dir`. Attaches
|
|
|
|
the current buffer to the client.
|
|
|
|
|
2022-11-23 04:31:49 -07:00
|
|
|
Example: >lua
|
2023-09-14 06:23:01 -07:00
|
|
|
vim.lsp.start({
|
|
|
|
name = 'my-server-name',
|
|
|
|
cmd = {'name-of-language-server-executable'},
|
2024-04-24 19:43:46 -07:00
|
|
|
root_dir = vim.fs.root(0, {'pyproject.toml', 'setup.py'}),
|
2023-09-14 06:23:01 -07:00
|
|
|
})
|
2022-06-03 05:59:19 -07:00
|
|
|
<
|
|
|
|
|
2022-09-25 16:58:27 -07:00
|
|
|
See |vim.lsp.start_client()| for all available options. The most important
|
|
|
|
are:
|
2022-10-14 08:01:13 -07:00
|
|
|
• `name` arbitrary name for the LSP client. Should be unique per language
|
|
|
|
server.
|
2024-01-18 01:14:48 -07:00
|
|
|
• `cmd` command string[] or function, described at
|
|
|
|
|vim.lsp.start_client()|.
|
2022-10-14 08:01:13 -07:00
|
|
|
• `root_dir` path to the project root. By default this is used to decide
|
|
|
|
if an existing client should be re-used. The example above uses
|
2024-04-24 19:43:46 -07:00
|
|
|
|vim.fs.root()| and |vim.fs.dirname()| to detect the root by traversing
|
2022-10-14 08:01:13 -07:00
|
|
|
the file system upwards starting from the current directory until either
|
|
|
|
a `pyproject.toml` or `setup.py` file is found.
|
|
|
|
• `workspace_folders` list of `{ uri:string, name: string }` tables
|
|
|
|
specifying the project root folders used by the language server. If
|
|
|
|
`nil` the property is derived from `root_dir` for convenience.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-06-03 05:59:19 -07:00
|
|
|
Language servers use this information to discover metadata like the
|
|
|
|
dependencies of your project and they tend to index the contents within
|
|
|
|
the project folder.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-06-03 05:59:19 -07:00
|
|
|
To ensure a language server is only started for languages it can handle,
|
2022-09-25 16:58:27 -07:00
|
|
|
make sure to call |vim.lsp.start()| within a |FileType| autocmd. Either
|
|
|
|
use |:au|, |nvim_create_autocmd()| or put the call in a
|
2022-06-03 05:59:19 -07:00
|
|
|
`ftplugin/<filetype_name>.lua` (See |ftplugin-name|)
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-06-03 05:59:19 -07:00
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {config} (`vim.lsp.ClientConfig`) Configuration for the server. See
|
|
|
|
|vim.lsp.ClientConfig|.
|
|
|
|
• {opts} (`table?`) Optional keyword arguments
|
2024-06-06 19:55:14 -07:00
|
|
|
• {reuse_client}?
|
2024-04-26 06:15:44 -07:00
|
|
|
(`fun(client: vim.lsp.Client, config: vim.lsp.ClientConfig): boolean`)
|
2024-03-08 05:25:18 -07:00
|
|
|
Predicate used to decide if a client should be re-used.
|
|
|
|
Used on all running clients. The default implementation
|
|
|
|
re-uses a client if name and root_dir matches.
|
2024-06-06 19:55:14 -07:00
|
|
|
• {bufnr}? (`integer`) Buffer handle to attach to if
|
|
|
|
starting or re-using a client (0 for current).
|
2024-04-26 11:26:21 -07:00
|
|
|
• {silent}? (`boolean`) Suppress error reporting if the LSP
|
2024-04-26 06:15:44 -07:00
|
|
|
server fails to start (default false).
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-06-03 05:59:19 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer?`) client_id
|
2022-06-03 05:59:19 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
start_client({config}) *vim.lsp.start_client()*
|
2019-12-31 08:51:54 -07:00
|
|
|
Starts and initializes a client with the given configuration.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
Parameters: ~
|
|
|
|
• {config} (`vim.lsp.ClientConfig`) Configuration for the server. See
|
|
|
|
|vim.lsp.ClientConfig|.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2024-04-26 06:15:44 -07:00
|
|
|
Return (multiple): ~
|
2024-02-27 08:20:32 -07:00
|
|
|
(`integer?`) client_id |vim.lsp.get_client_by_id()| Note: client may
|
2023-02-25 10:47:05 -07:00
|
|
|
not be fully initialized. Use `on_init` to do any actions once the
|
|
|
|
client has been initialized.
|
2024-04-26 06:15:44 -07:00
|
|
|
(`string?`) Error message, if any
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2023-06-09 02:32:43 -07:00
|
|
|
status() *vim.lsp.status()*
|
|
|
|
Consumes the latest progress messages from all clients and formats them as
|
|
|
|
a string. Empty if there are no clients or if no new messages
|
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`string`)
|
2023-06-09 02:32:43 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
stop_client({client_id}, {force}) *vim.lsp.stop_client()*
|
2019-12-31 08:51:54 -07:00
|
|
|
Stops a client(s).
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
You can also use the `stop()` function on a |vim.lsp.Client| object. To
|
2023-09-14 06:23:01 -07:00
|
|
|
stop all clients: >lua
|
|
|
|
vim.lsp.stop_client(vim.lsp.get_clients())
|
2019-12-31 08:51:54 -07:00
|
|
|
<
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
By default asks the server to shutdown, unless stop was requested already
|
|
|
|
for this client, then force-shutdown is attempted.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-03-21 08:15:20 -07:00
|
|
|
• {client_id} (`integer|integer[]|vim.lsp.Client[]`) id, list of id's,
|
|
|
|
or list of |vim.lsp.Client| objects
|
2024-01-09 10:36:46 -07:00
|
|
|
• {force} (`boolean?`) shutdown forcefully
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2023-06-07 05:39:41 -07:00
|
|
|
tagfunc({pattern}, {flags}) *vim.lsp.tagfunc()*
|
2021-11-18 14:50:55 -07:00
|
|
|
Provides an interface between the built-in client and 'tagfunc'.
|
|
|
|
|
|
|
|
When used with normal mode commands (e.g. |CTRL-]|) this will invoke the
|
|
|
|
"textDocument/definition" LSP method to find the tag under the cursor.
|
|
|
|
Otherwise, uses "workspace/symbol". If no results are returned from any
|
|
|
|
LSP servers, falls back to using built-in tags.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {pattern} (`string`) Pattern used to find a workspace symbol
|
|
|
|
• {flags} (`string`) See |tag-function|
|
2021-11-18 14:50:55 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table[]`) tags A list of matching tags
|
2021-11-18 14:50:55 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
with({handler}, {override_config}) *vim.lsp.with()*
|
|
|
|
Function to manage overriding defaults for LSP handlers.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {handler} (`lsp.Handler`) See |lsp-handler|
|
|
|
|
• {override_config} (`table`) Table containing the keys to override
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
behavior of the {handler}
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.client *lsp-client*
|
|
|
|
|
|
|
|
*vim.lsp.Client*
|
|
|
|
|
|
|
|
Fields: ~
|
|
|
|
• {id} (`integer`) The id allocated to the client.
|
|
|
|
• {name} (`string`) If a name is specified on creation,
|
|
|
|
that will be used. Otherwise it is just the
|
|
|
|
client id. This is used for logs and messages.
|
|
|
|
• {rpc} (`vim.lsp.rpc.PublicClient`) RPC client
|
|
|
|
object, for low level interaction with the
|
|
|
|
client. See |vim.lsp.rpc.start()|.
|
|
|
|
• {offset_encoding} (`string`) The encoding used for communicating
|
|
|
|
with the server. You can modify this in the
|
|
|
|
`config`'s `on_init` method before text is
|
|
|
|
sent to the server.
|
|
|
|
• {handlers} (`table<string,lsp.Handler>`) The handlers
|
|
|
|
used by the client as described in
|
|
|
|
|lsp-handler|.
|
|
|
|
• {requests} (`table<integer,{ type: string, bufnr: integer, method: string}>`)
|
|
|
|
The current pending requests in flight to the
|
|
|
|
server. Entries are key-value pairs with the
|
2024-02-19 19:28:07 -07:00
|
|
|
key being the request id while the value is a
|
2024-02-27 08:20:32 -07:00
|
|
|
table with `type`, `bufnr`, and `method`
|
|
|
|
key-value pairs. `type` is either "pending"
|
|
|
|
for an active request, or "cancel" for a
|
|
|
|
cancel request. It will be "complete"
|
|
|
|
ephemerally while executing |LspRequest|
|
|
|
|
autocmds when replies are received from the
|
|
|
|
server.
|
|
|
|
• {config} (`vim.lsp.ClientConfig`) copy of the table
|
|
|
|
that was passed by the user to
|
2024-03-05 05:06:15 -07:00
|
|
|
|vim.lsp.start_client()|. See
|
|
|
|
|vim.lsp.ClientConfig|.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {server_capabilities} (`lsp.ServerCapabilities?`) Response from the
|
2024-02-19 19:28:07 -07:00
|
|
|
server sent on `initialize` describing the
|
2024-02-27 08:20:32 -07:00
|
|
|
server's capabilities.
|
|
|
|
• {progress} (`vim.lsp.Client.Progress`) A ring buffer
|
|
|
|
(|vim.ringbuf()|) containing progress messages
|
2024-03-05 05:06:15 -07:00
|
|
|
sent by the server. See
|
|
|
|
|vim.lsp.Client.Progress|.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {initialized} (`true?`)
|
|
|
|
• {workspace_folders} (`lsp.WorkspaceFolder[]?`) The workspace
|
|
|
|
folders configured in the client when the
|
|
|
|
server starts. This property is only available
|
|
|
|
if the client supports workspace folders. It
|
|
|
|
can be `null` if the client supports workspace
|
|
|
|
folders but none are configured.
|
2024-05-25 12:22:41 -07:00
|
|
|
• {root_dir} (`string?`)
|
2024-02-27 08:20:32 -07:00
|
|
|
• {attached_buffers} (`table<integer,true>`)
|
2024-03-08 05:25:18 -07:00
|
|
|
• {commands} (`table<string,fun(command: lsp.Command, ctx: table)>`)
|
|
|
|
Table of command name to function which is
|
|
|
|
called if any LSP action (code action, code
|
|
|
|
lenses, ...) triggers the command. Client
|
|
|
|
commands take precedence over the global
|
|
|
|
command registry.
|
2024-03-05 05:06:15 -07:00
|
|
|
• {settings} (`table`) Map with language server specific
|
|
|
|
settings. These are returned to the language
|
|
|
|
server if requested via
|
|
|
|
`workspace/configuration`. Keys are
|
|
|
|
case-sensitive.
|
|
|
|
• {flags} (`table`) A table with flags for the client.
|
|
|
|
The current (experimental) flags are:
|
2024-03-11 22:51:53 -07:00
|
|
|
• {allow_incremental_sync}? (`boolean`,
|
|
|
|
default: `true`) Allow using incremental
|
|
|
|
sync for buffer edits
|
2024-03-05 05:06:15 -07:00
|
|
|
• {debounce_text_changes} (`integer`, default:
|
|
|
|
`150`) Debounce `didChange` notifications to
|
|
|
|
the server by the given number in
|
|
|
|
milliseconds. No debounce occurs if `nil`.
|
|
|
|
• {exit_timeout} (`integer|false`, default:
|
|
|
|
`false`) Milliseconds to wait for server to
|
|
|
|
exit cleanly after sending the "shutdown"
|
|
|
|
request before sending kill -15. If set to
|
|
|
|
false, nvim exits immediately after sending
|
|
|
|
the "shutdown" request to the server.
|
2024-03-08 05:25:18 -07:00
|
|
|
• {get_language_id} (`fun(bufnr: integer, filetype: string): string`)
|
2024-02-27 08:20:32 -07:00
|
|
|
• {capabilities} (`lsp.ClientCapabilities`) The capabilities
|
|
|
|
provided by the client (editor or tool)
|
|
|
|
• {dynamic_capabilities} (`lsp.DynamicCapabilities`)
|
2024-03-25 12:06:28 -07:00
|
|
|
• {request} (`fun(method: string, params: table?, handler: lsp.Handler?, bufnr: integer?): boolean, integer?`)
|
2024-02-27 08:20:32 -07:00
|
|
|
Sends a request to the server. This is a thin
|
|
|
|
wrapper around {client.rpc.request} with some
|
|
|
|
additional checking. If {handler} is not
|
2024-02-19 19:28:07 -07:00
|
|
|
specified and if there's no respective global
|
|
|
|
handler, then an error will occur. Returns:
|
2024-03-08 05:25:18 -07:00
|
|
|
{status}, {client_id}?. {status} is a boolean
|
2024-02-27 08:20:32 -07:00
|
|
|
indicating if the notification was successful.
|
|
|
|
If it is `false`, then it will always be
|
|
|
|
`false` (the client has shutdown). If {status}
|
|
|
|
is `true`, the function returns {request_id}
|
|
|
|
as the second result. You can use this with
|
|
|
|
`client.cancel_request(request_id)` to cancel
|
|
|
|
the request.
|
|
|
|
• {request_sync} (`fun(method: string, params: table?, timeout_ms: integer?, bufnr: integer): {err: lsp.ResponseError?, result:any}?, string?`)
|
refactor(api)!: rename Dictionary => Dict
In the api_info() output:
:new|put =map(filter(api_info().functions, '!has_key(v:val,''deprecated_since'')'), 'v:val')
...
{'return_type': 'ArrayOf(Integer, 2)', 'name': 'nvim_win_get_position', 'method': v:true, 'parameters': [['Window', 'window']], 'since': 1}
The `ArrayOf(Integer, 2)` return type didn't break clients when we added
it, which is evidence that clients don't use the `return_type` field,
thus renaming Dictionary => Dict in api_info() is not (in practice)
a breaking change.
2024-09-19 22:34:50 -07:00
|
|
|
err # a dict
|
2024-03-08 05:25:18 -07:00
|
|
|
• {notify} (`fun(method: string, params: table?): boolean`)
|
|
|
|
Sends a notification to an LSP server.
|
|
|
|
Returns: a boolean to indicate if the
|
2024-02-27 08:20:32 -07:00
|
|
|
notification was successful. If it is false,
|
|
|
|
then it will always be false (the client has
|
|
|
|
shutdown).
|
|
|
|
• {cancel_request} (`fun(id: integer): boolean`) Cancels a
|
|
|
|
request with a given request id. Returns: same
|
|
|
|
as `notify()`.
|
|
|
|
• {stop} (`fun(force?: boolean)`) Stops a client,
|
|
|
|
optionally with force. By default, it will
|
|
|
|
just ask the server to shutdown without force.
|
|
|
|
If you request to stop a client which has
|
|
|
|
previously been requested to shutdown, it will
|
|
|
|
automatically escalate and force shutdown.
|
|
|
|
• {on_attach} (`fun(bufnr: integer)`) Runs the on_attach
|
|
|
|
function from the client's config if it was
|
|
|
|
defined. Useful for buffer-local setup.
|
|
|
|
• {supports_method} (`fun(method: string, opts?: {bufnr: integer?}): boolean`)
|
|
|
|
Checks if a client supports a given method.
|
|
|
|
Always returns true for unknown off-spec
|
2024-03-08 05:25:18 -07:00
|
|
|
methods. {opts} is a optional
|
|
|
|
`{bufnr?: integer}` table. Some language
|
|
|
|
server capabilities can be file specific.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {is_stopped} (`fun(): boolean`) Checks whether a client is
|
|
|
|
stopped. Returns: true if the client is fully
|
|
|
|
stopped.
|
|
|
|
|
|
|
|
*vim.lsp.Client.Progress*
|
|
|
|
Extends: |vim.Ringbuf|
|
|
|
|
|
2024-03-05 05:06:15 -07:00
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
Fields: ~
|
|
|
|
• {pending} (`table<lsp.ProgressToken,lsp.LSPAny>`)
|
|
|
|
|
|
|
|
*vim.lsp.ClientConfig*
|
|
|
|
|
|
|
|
Fields: ~
|
2024-04-26 06:15:44 -07:00
|
|
|
• {cmd} (`string[]|fun(dispatchers: vim.lsp.rpc.Dispatchers): vim.lsp.rpc.PublicClient`)
|
2024-02-27 08:20:32 -07:00
|
|
|
command string[] that launches the language
|
|
|
|
server (treated as in |jobstart()|, must be
|
|
|
|
absolute or on `$PATH`, shell constructs like
|
|
|
|
"~" are not expanded), or function that creates
|
|
|
|
an RPC client. Function receives a `dispatchers`
|
|
|
|
table and returns a table with member functions
|
|
|
|
`request`, `notify`, `is_closing` and
|
|
|
|
`terminate`. See |vim.lsp.rpc.request()|,
|
|
|
|
|vim.lsp.rpc.notify()|. For TCP there is a
|
|
|
|
builtin RPC client factory:
|
|
|
|
|vim.lsp.rpc.connect()|
|
|
|
|
• {cmd_cwd}? (`string`, default: cwd) Directory to launch the
|
|
|
|
`cmd` process. Not related to `root_dir`.
|
|
|
|
• {cmd_env}? (`table`) Environment flags to pass to the LSP
|
|
|
|
on spawn. Must be specified using a table.
|
|
|
|
Non-string values are coerced to string.
|
|
|
|
Example: >lua
|
|
|
|
{ PORT = 8080; HOST = "0.0.0.0"; }
|
|
|
|
<
|
|
|
|
• {detached}? (`boolean`, default: true) Daemonize the server
|
|
|
|
process so that it runs in a separate process
|
|
|
|
group from Nvim. Nvim will shutdown the process
|
|
|
|
on exit, but if Nvim fails to exit cleanly this
|
|
|
|
could leave behind orphaned server processes.
|
|
|
|
• {workspace_folders}? (`lsp.WorkspaceFolder[]`) List of workspace
|
|
|
|
folders passed to the language server. For
|
|
|
|
backwards compatibility rootUri and rootPath
|
|
|
|
will be derived from the first workspace folder
|
|
|
|
in this list. See `workspaceFolders` in the LSP
|
|
|
|
spec.
|
|
|
|
• {capabilities}? (`lsp.ClientCapabilities`) Map overriding the
|
|
|
|
default capabilities defined by
|
|
|
|
|vim.lsp.protocol.make_client_capabilities()|,
|
|
|
|
passed to the language server on initialization.
|
|
|
|
Hint: use make_client_capabilities() and modify
|
|
|
|
its result.
|
|
|
|
• Note: To send an empty dictionary use
|
|
|
|
|vim.empty_dict()|, else it will be encoded as
|
|
|
|
an array.
|
|
|
|
• {handlers}? (`table<string,function>`) Map of language
|
|
|
|
server method names to |lsp-handler|
|
|
|
|
• {settings}? (`table`) Map with language server specific
|
2024-03-05 05:06:15 -07:00
|
|
|
settings. See the {settings} in
|
|
|
|
|vim.lsp.Client|.
|
2024-03-08 05:25:18 -07:00
|
|
|
• {commands}? (`table<string,fun(command: lsp.Command, ctx: table)>`)
|
|
|
|
Table that maps string of clientside commands to
|
|
|
|
user-defined functions. Commands passed to
|
|
|
|
start_client take precedence over the global
|
|
|
|
command registry. Each key must be a unique
|
|
|
|
command name, and the value is a function which
|
|
|
|
is called if any LSP action (code action, code
|
|
|
|
lenses, ...) triggers the command.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {init_options}? (`table`) Values to pass in the initialization
|
|
|
|
request as `initializationOptions`. See
|
|
|
|
`initialize` in the LSP spec.
|
|
|
|
• {name}? (`string`, default: client-id) Name in log
|
|
|
|
messages.
|
2024-03-08 05:25:18 -07:00
|
|
|
• {get_language_id}? (`fun(bufnr: integer, filetype: string): string`)
|
|
|
|
Language ID as string. Defaults to the filetype.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {offset_encoding}? (`'utf-8'|'utf-16'|'utf-32'`) The encoding that
|
|
|
|
the LSP server expects. Client does not verify
|
|
|
|
this is correct.
|
|
|
|
• {on_error}? (`fun(code: integer, err: string)`) Callback
|
|
|
|
invoked when the client operation throws an
|
|
|
|
error. `code` is a number describing the error.
|
|
|
|
Other arguments may be passed depending on the
|
|
|
|
error kind. See `vim.lsp.rpc.client_errors` for
|
|
|
|
possible errors. Use
|
|
|
|
`vim.lsp.rpc.client_errors[code]` to get
|
|
|
|
human-friendly name.
|
2024-03-05 05:06:15 -07:00
|
|
|
• {before_init}? (`fun(params: lsp.InitializeParams, config: vim.lsp.ClientConfig)`)
|
|
|
|
Callback invoked before the LSP "initialize"
|
|
|
|
phase, where `params` contains the parameters
|
|
|
|
being sent to the server and `config` is the
|
|
|
|
config that was passed to
|
|
|
|
|vim.lsp.start_client()|. You can use this to
|
|
|
|
modify parameters before they are sent.
|
|
|
|
• {on_init}? (`elem_or_list<fun(client: vim.lsp.Client, initialize_result: lsp.InitializeResult)>`)
|
2024-02-27 08:20:32 -07:00
|
|
|
Callback invoked after LSP "initialize", where
|
|
|
|
`result` is a table of `capabilities` and
|
|
|
|
anything else the server may send. For example,
|
|
|
|
clangd sends `initialize_result.offsetEncoding`
|
|
|
|
if `capabilities.offsetEncoding` was sent to it.
|
|
|
|
You can only modify the `client.offset_encoding`
|
|
|
|
here before any notifications are sent.
|
2024-03-05 05:06:15 -07:00
|
|
|
• {on_exit}? (`elem_or_list<fun(code: integer, signal: integer, client_id: integer)>`)
|
2024-02-27 08:20:32 -07:00
|
|
|
Callback invoked on client exit.
|
|
|
|
• code: exit code of the process
|
|
|
|
• signal: number describing the signal used to
|
|
|
|
terminate (if any)
|
|
|
|
• client_id: client handle
|
2024-03-05 05:06:15 -07:00
|
|
|
• {on_attach}? (`elem_or_list<fun(client: vim.lsp.Client, bufnr: integer)>`)
|
2024-02-27 08:20:32 -07:00
|
|
|
Callback invoked when client attaches to a
|
|
|
|
buffer.
|
|
|
|
• {trace}? (`'off'|'messages'|'verbose'`, default: "off")
|
|
|
|
Passed directly to the language server in the
|
|
|
|
initialize request. Invalid/empty values will
|
|
|
|
• {flags}? (`table`) A table with flags for the client. The
|
|
|
|
current (experimental) flags are:
|
2024-03-11 22:51:53 -07:00
|
|
|
• {allow_incremental_sync}? (`boolean`, default:
|
|
|
|
`true`) Allow using incremental sync for
|
|
|
|
buffer edits
|
2024-03-05 05:06:15 -07:00
|
|
|
• {debounce_text_changes} (`integer`, default:
|
|
|
|
`150`) Debounce `didChange` notifications to
|
|
|
|
the server by the given number in
|
|
|
|
milliseconds. No debounce occurs if `nil`.
|
|
|
|
• {exit_timeout} (`integer|false`, default:
|
|
|
|
`false`) Milliseconds to wait for server to
|
|
|
|
exit cleanly after sending the "shutdown"
|
|
|
|
request before sending kill -15. If set to
|
|
|
|
false, nvim exits immediately after sending
|
|
|
|
the "shutdown" request to the server.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {root_dir}? (`string`) Directory where the LSP server will
|
|
|
|
base its workspaceFolders, rootUri, and rootPath
|
|
|
|
on initialization.
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.buf *lsp-buf*
|
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
*vim.lsp.ListOpts*
|
|
|
|
|
|
|
|
Fields: ~
|
|
|
|
• {on_list}? (`fun(t: vim.lsp.LocationOpts.OnList)`) list-handler
|
|
|
|
replacing the default handler. Called for any non-empty
|
|
|
|
result. This table can be used with |setqflist()| or
|
|
|
|
|setloclist()|. E.g.: >lua
|
|
|
|
local function on_list(options)
|
|
|
|
vim.fn.setqflist({}, ' ', options)
|
|
|
|
vim.cmd.cfirst()
|
|
|
|
end
|
|
|
|
|
|
|
|
vim.lsp.buf.definition({ on_list = on_list })
|
|
|
|
vim.lsp.buf.references(nil, { on_list = on_list })
|
|
|
|
<
|
|
|
|
|
2024-05-04 01:10:44 -07:00
|
|
|
If you prefer loclist instead of qflist: >lua
|
|
|
|
vim.lsp.buf.definition({ loclist = true })
|
|
|
|
vim.lsp.buf.references(nil, { loclist = true })
|
2024-02-27 08:20:32 -07:00
|
|
|
<
|
2024-05-04 01:10:44 -07:00
|
|
|
• {loclist}? (`boolean`)
|
2024-02-27 08:20:32 -07:00
|
|
|
|
|
|
|
*vim.lsp.LocationOpts*
|
|
|
|
Extends: |vim.lsp.ListOpts|
|
|
|
|
|
2024-03-05 05:06:15 -07:00
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
Fields: ~
|
|
|
|
• {reuse_win}? (`boolean`) Jump to existing window if buffer is already
|
|
|
|
open.
|
|
|
|
|
|
|
|
*vim.lsp.LocationOpts.OnList*
|
|
|
|
|
|
|
|
Fields: ~
|
|
|
|
• {items} (`table[]`) Structured like |setqflist-what|
|
|
|
|
• {title}? (`string`) Title for the list.
|
|
|
|
• {context}? (`table`) `ctx` from |lsp-handler|
|
|
|
|
|
|
|
|
|
2020-12-08 19:09:33 -07:00
|
|
|
*vim.lsp.buf.add_workspace_folder()*
|
|
|
|
add_workspace_folder({workspace_folder})
|
|
|
|
Add the folder at path to the workspace folders. If {path} is not
|
|
|
|
provided, the user will be prompted for a path using |input()|.
|
|
|
|
|
2024-02-15 10:16:04 -07:00
|
|
|
Parameters: ~
|
|
|
|
• {workspace_folder} (`string?`)
|
|
|
|
|
2023-07-04 05:30:31 -07:00
|
|
|
clear_references() *vim.lsp.buf.clear_references()*
|
2020-08-19 09:17:08 -07:00
|
|
|
Removes document highlights from current buffer.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
code_action({opts}) *vim.lsp.buf.code_action()*
|
2021-09-26 14:40:28 -07:00
|
|
|
Selects a code action available at the current cursor position.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`table?`) A table with the following fields:
|
|
|
|
• {context}? (`lsp.CodeActionContext`) Corresponds to
|
|
|
|
`CodeActionContext` of the LSP specification:
|
|
|
|
• {diagnostics}? (`table`) LSP `Diagnostic[]`. Inferred from
|
|
|
|
the current position if not provided.
|
|
|
|
• {only}? (`table`) List of LSP `CodeActionKind`s used to
|
|
|
|
filter the code actions. Most language servers support
|
|
|
|
values like `refactor` or `quickfix`.
|
|
|
|
• {triggerKind}? (`integer`) The reason why code actions
|
|
|
|
were requested.
|
|
|
|
• {filter}? (`fun(x: lsp.CodeAction|lsp.Command):boolean`)
|
|
|
|
Predicate taking an `CodeAction` and returning a boolean.
|
|
|
|
• {apply}? (`boolean`) When set to `true`, and there is just
|
|
|
|
one remaining action (after filtering), the action is
|
|
|
|
applied without user query.
|
|
|
|
• {range}? (`{start: integer[], end: integer[]}`) Range for
|
|
|
|
which code actions should be requested. If in visual mode
|
|
|
|
this defaults to the active selection. Table must contain
|
|
|
|
`start` and `end` keys with {row,col} tuples using mark-like
|
|
|
|
indexing. See |api-indexing|
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction
|
2023-08-07 06:35:06 -07:00
|
|
|
• vim.lsp.protocol.CodeActionTriggerKind
|
2020-05-15 16:18:59 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
completion({context}) *vim.lsp.buf.completion()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Retrieves the completion items at the current cursor position. Can only be
|
|
|
|
called in Insert mode.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {context} (`table`) (context support not yet implemented) Additional
|
2020-08-19 09:17:08 -07:00
|
|
|
information about the context in which a completion was
|
|
|
|
triggered (how it was triggered, and by which trigger
|
|
|
|
character, if applicable)
|
|
|
|
|
|
|
|
See also: ~
|
2023-08-07 06:35:06 -07:00
|
|
|
• vim.lsp.protocol.CompletionTriggerKind
|
2020-08-19 09:17:08 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
declaration({opts}) *vim.lsp.buf.declaration()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Jumps to the declaration of the symbol under the cursor.
|
2023-07-06 13:47:27 -07:00
|
|
|
|
|
|
|
Note: ~
|
|
|
|
• Many servers do not implement this method. Generally, see
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|vim.lsp.buf.definition()| instead.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-05-18 12:03:24 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.LocationOpts?`) See |vim.lsp.LocationOpts|.
|
2022-05-18 12:03:24 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
definition({opts}) *vim.lsp.buf.definition()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Jumps to the definition of the symbol under the cursor.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2022-05-18 12:03:24 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.LocationOpts?`) See |vim.lsp.LocationOpts|.
|
2022-05-18 12:03:24 -07:00
|
|
|
|
2020-02-26 12:10:16 -07:00
|
|
|
document_highlight() *vim.lsp.buf.document_highlight()*
|
2021-02-24 09:23:47 -07:00
|
|
|
Send request to the server to resolve document highlights for the current
|
|
|
|
text document position. This request can be triggered by a key mapping or
|
2023-09-14 06:23:01 -07:00
|
|
|
by events such as `CursorHold`, e.g.: >vim
|
|
|
|
autocmd CursorHold <buffer> lua vim.lsp.buf.document_highlight()
|
|
|
|
autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight()
|
|
|
|
autocmd CursorMoved <buffer> lua vim.lsp.buf.clear_references()
|
2020-07-02 04:09:17 -07:00
|
|
|
<
|
2020-02-26 12:10:16 -07:00
|
|
|
|
2021-02-24 09:23:47 -07:00
|
|
|
Note: Usage of |vim.lsp.buf.document_highlight()| requires the following
|
|
|
|
highlight groups to be defined or you won't be able to see the actual
|
2022-09-25 16:58:27 -07:00
|
|
|
highlights. |hl-LspReferenceText| |hl-LspReferenceRead|
|
|
|
|
|hl-LspReferenceWrite|
|
2021-02-24 09:23:47 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
document_symbol({opts}) *vim.lsp.buf.document_symbol()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Lists all symbols in the current buffer in the quickfix window.
|
2020-02-22 05:20:38 -07:00
|
|
|
|
feat(lsp): allow passing custom list handler to LSP functions that return lists (#19213)
Currently LSP allows only using loclist or quickfix list window. I
normally prefer to review all quickfix items without opening quickfix
window. This fix allows passing `on_list` option which allows full
control what to do with list.
Here is example how to use it with quick fix list:
```lua
local function on_list(options)
vim.fn.setqflist({}, ' ', options)
vim.api.nvim_command('cfirst')
end
local bufopts = { noremap=true, silent=true, buffer=bufnr }
vim.keymap.set('n', '<leader>ad', function() vim.lsp.buf.declaration{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>d', function() vim.lsp.buf.definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>ai', function() vim.lsp.buf.implementation{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>at', function() vim.lsp.buf.type_definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>af', function() vim.lsp.buf.references(nil, {on_list=on_list}) end, bufopts)
```
If you prefer loclist do something like this:
```lua
local function on_list(options)
vim.fn.setloclist(0, {}, ' ', options)
vim.api.nvim_command('lopen')
end
```
close #19182
Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
2022-07-25 14:02:51 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.ListOpts?`) See |vim.lsp.ListOpts|.
|
feat(lsp): allow passing custom list handler to LSP functions that return lists (#19213)
Currently LSP allows only using loclist or quickfix list window. I
normally prefer to review all quickfix items without opening quickfix
window. This fix allows passing `on_list` option which allows full
control what to do with list.
Here is example how to use it with quick fix list:
```lua
local function on_list(options)
vim.fn.setqflist({}, ' ', options)
vim.api.nvim_command('cfirst')
end
local bufopts = { noremap=true, silent=true, buffer=bufnr }
vim.keymap.set('n', '<leader>ad', function() vim.lsp.buf.declaration{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>d', function() vim.lsp.buf.definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>ai', function() vim.lsp.buf.implementation{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>at', function() vim.lsp.buf.type_definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>af', function() vim.lsp.buf.references(nil, {on_list=on_list}) end, bufopts)
```
If you prefer loclist do something like this:
```lua
local function on_list(options)
vim.fn.setloclist(0, {}, ' ', options)
vim.api.nvim_command('lopen')
end
```
close #19182
Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
2022-07-25 14:02:51 -07:00
|
|
|
|
2022-01-17 11:28:23 -07:00
|
|
|
execute_command({command_params}) *vim.lsp.buf.execute_command()*
|
2020-09-06 16:55:49 -07:00
|
|
|
Executes an LSP server command.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {command_params} (`lsp.ExecuteCommandParams`)
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
format({opts}) *vim.lsp.buf.format()*
|
2022-04-30 06:36:40 -07:00
|
|
|
Formats a buffer using the attached (and optionally filtered) language
|
|
|
|
server clients.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2022-04-30 06:36:40 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`table?`) A table with the following fields:
|
|
|
|
• {formatting_options}? (`table`) Can be used to specify
|
|
|
|
FormattingOptions. Some unspecified options will be
|
|
|
|
automatically derived from the current Nvim options. See
|
|
|
|
https://microsoft.github.io/language-server-protocol/specification/#formattingOptions
|
|
|
|
• {timeout_ms}? (`integer`, default: `1000`) Time in
|
|
|
|
milliseconds to block for formatting requests. No effect if
|
|
|
|
async=true.
|
|
|
|
• {bufnr}? (`integer`, default: current buffer) Restrict
|
|
|
|
formatting to the clients attached to the given buffer.
|
|
|
|
• {filter}? (`fun(client: vim.lsp.Client): boolean?`)
|
|
|
|
Predicate used to filter clients. Receives a client as
|
|
|
|
argument and must return a boolean. Clients matching the
|
|
|
|
predicate are included. Example: >lua
|
|
|
|
-- Never request typescript-language-server for formatting
|
|
|
|
vim.lsp.buf.format {
|
|
|
|
filter = function(client) return client.name ~= "tsserver" end
|
|
|
|
}
|
2022-04-30 06:36:40 -07:00
|
|
|
<
|
2024-04-29 10:20:31 -07:00
|
|
|
• {async}? (`boolean`, default: false) If true the method
|
|
|
|
won't block. Editing the buffer while formatting
|
|
|
|
asynchronous can lead to unexpected changes.
|
|
|
|
• {id}? (`integer`) Restrict formatting to the client with ID
|
|
|
|
(client.id) matching this field.
|
|
|
|
• {name}? (`string`) Restrict formatting to the client with
|
|
|
|
name (client.name) matching this field.
|
2024-06-24 07:54:56 -07:00
|
|
|
• {range}?
|
|
|
|
(`{start:[integer,integer],end:[integer, integer]}|{start:[integer,integer],end:[integer,integer]}[]`,
|
|
|
|
default: current selection in visual mode, `nil` in other
|
|
|
|
modes, formatting the full buffer) Range to format. Table
|
|
|
|
must contain `start` and `end` keys with {row,col} tuples
|
|
|
|
using (1,0) indexing. Can also be a list of tables that
|
|
|
|
contain `start` and `end` keys as described above, in which
|
|
|
|
case `textDocument/rangesFormatting` support is required.
|
2022-04-30 06:36:40 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
hover() *vim.lsp.buf.hover()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Displays hover information about the symbol under the cursor in a floating
|
2024-09-19 08:00:08 -07:00
|
|
|
window. The window will be dismissed on cursor move. Calling the function
|
|
|
|
twice will jump into the floating window (thus by default, "KK" will open
|
|
|
|
the hover window and focus it). In the floating window, all commands and
|
|
|
|
mappings are available as usual, except that "q" dismisses the window. You
|
|
|
|
can scroll the contents the same as you would any other buffer.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
implementation({opts}) *vim.lsp.buf.implementation()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Lists all the implementations for the symbol under the cursor in the
|
|
|
|
quickfix window.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
feat(lsp): allow passing custom list handler to LSP functions that return lists (#19213)
Currently LSP allows only using loclist or quickfix list window. I
normally prefer to review all quickfix items without opening quickfix
window. This fix allows passing `on_list` option which allows full
control what to do with list.
Here is example how to use it with quick fix list:
```lua
local function on_list(options)
vim.fn.setqflist({}, ' ', options)
vim.api.nvim_command('cfirst')
end
local bufopts = { noremap=true, silent=true, buffer=bufnr }
vim.keymap.set('n', '<leader>ad', function() vim.lsp.buf.declaration{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>d', function() vim.lsp.buf.definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>ai', function() vim.lsp.buf.implementation{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>at', function() vim.lsp.buf.type_definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>af', function() vim.lsp.buf.references(nil, {on_list=on_list}) end, bufopts)
```
If you prefer loclist do something like this:
```lua
local function on_list(options)
vim.fn.setloclist(0, {}, ' ', options)
vim.api.nvim_command('lopen')
end
```
close #19182
Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
2022-07-25 14:02:51 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.LocationOpts?`) See |vim.lsp.LocationOpts|.
|
feat(lsp): allow passing custom list handler to LSP functions that return lists (#19213)
Currently LSP allows only using loclist or quickfix list window. I
normally prefer to review all quickfix items without opening quickfix
window. This fix allows passing `on_list` option which allows full
control what to do with list.
Here is example how to use it with quick fix list:
```lua
local function on_list(options)
vim.fn.setqflist({}, ' ', options)
vim.api.nvim_command('cfirst')
end
local bufopts = { noremap=true, silent=true, buffer=bufnr }
vim.keymap.set('n', '<leader>ad', function() vim.lsp.buf.declaration{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>d', function() vim.lsp.buf.definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>ai', function() vim.lsp.buf.implementation{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>at', function() vim.lsp.buf.type_definition{on_list=on_list} end, bufopts)
vim.keymap.set('n', '<leader>af', function() vim.lsp.buf.references(nil, {on_list=on_list}) end, bufopts)
```
If you prefer loclist do something like this:
```lua
local function on_list(options)
vim.fn.setloclist(0, {}, ' ', options)
vim.api.nvim_command('lopen')
end
```
close #19182
Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
2022-07-25 14:02:51 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
incoming_calls() *vim.lsp.buf.incoming_calls()*
|
|
|
|
Lists all the call sites of the symbol under the cursor in the |quickfix|
|
|
|
|
window. If the symbol can resolve to multiple items, the user can pick one
|
2022-09-25 16:58:27 -07:00
|
|
|
in the |inputlist()|.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-12-08 19:09:33 -07:00
|
|
|
list_workspace_folders() *vim.lsp.buf.list_workspace_folders()*
|
|
|
|
List workspace folders.
|
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
outgoing_calls() *vim.lsp.buf.outgoing_calls()*
|
|
|
|
Lists all the items that are called by the symbol under the cursor in the
|
|
|
|
|quickfix| window. If the symbol can resolve to multiple items, the user
|
2022-09-25 16:58:27 -07:00
|
|
|
can pick one in the |inputlist()|.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
references({context}, {opts}) *vim.lsp.buf.references()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Lists all the references to the symbol under the cursor in the quickfix
|
|
|
|
window.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {context} (`table?`) Context for the request
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.ListOpts?`) See |vim.lsp.ListOpts|.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references
|
2020-08-19 09:17:08 -07:00
|
|
|
|
2020-12-08 19:09:33 -07:00
|
|
|
*vim.lsp.buf.remove_workspace_folder()*
|
|
|
|
remove_workspace_folder({workspace_folder})
|
|
|
|
Remove the folder at path from the workspace folders. If {path} is not
|
|
|
|
provided, the user will be prompted for a path using |input()|.
|
|
|
|
|
2024-02-15 10:16:04 -07:00
|
|
|
Parameters: ~
|
|
|
|
• {workspace_folder} (`string?`)
|
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
rename({new_name}, {opts}) *vim.lsp.buf.rename()*
|
2020-08-19 09:17:08 -07:00
|
|
|
Renames all references to the symbol under the cursor.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {new_name} (`string?`) If not provided, the user will be prompted for
|
|
|
|
a new name using |vim.ui.input()|.
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`table?`) Additional options:
|
2024-02-27 08:20:32 -07:00
|
|
|
• {filter}? (`fun(client: vim.lsp.Client): boolean?`)
|
|
|
|
Predicate used to filter clients. Receives a client as
|
|
|
|
argument and must return a boolean. Clients matching the
|
|
|
|
predicate are included.
|
|
|
|
• {name}? (`string`) Restrict clients used for rename to
|
2022-05-05 14:56:00 -07:00
|
|
|
ones where client.name matches this field.
|
2024-03-06 05:15:25 -07:00
|
|
|
• {bufnr}? (`integer`) (default: current buffer)
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
signature_help() *vim.lsp.buf.signature_help()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Displays signature information about the symbol under the cursor in a
|
|
|
|
floating window.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
type_definition({opts}) *vim.lsp.buf.type_definition()*
|
2020-07-19 14:16:12 -07:00
|
|
|
Jumps to the definition of the type of the symbol under the cursor.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2022-05-18 12:03:24 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {opts} (`vim.lsp.LocationOpts?`) See |vim.lsp.LocationOpts|.
|
2022-05-18 12:03:24 -07:00
|
|
|
|
2024-04-23 10:05:01 -07:00
|
|
|
typehierarchy({kind}) *vim.lsp.buf.typehierarchy()*
|
|
|
|
Lists all the subtypes or supertypes of the symbol under the cursor in the
|
|
|
|
|quickfix| window. If the symbol can resolve to multiple items, the user
|
|
|
|
can pick one using |vim.ui.select()|.
|
|
|
|
|
|
|
|
Parameters: ~
|
|
|
|
• {kind} (`"subtypes"|"supertypes"`)
|
|
|
|
|
2024-04-29 10:20:31 -07:00
|
|
|
workspace_symbol({query}, {opts}) *vim.lsp.buf.workspace_symbol()*
|
2020-05-02 08:56:05 -07:00
|
|
|
Lists all symbols in the current workspace in the quickfix window.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
The list is filtered against {query}; if the argument is omitted from the
|
|
|
|
call, the user is prompted to enter a string on the command line. An empty
|
|
|
|
string means no filtering is done.
|
2020-05-02 08:56:05 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-04-29 10:20:31 -07:00
|
|
|
• {query} (`string?`) optional
|
|
|
|
• {opts} (`vim.lsp.ListOpts?`) See |vim.lsp.ListOpts|.
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Lua module: vim.lsp.diagnostic *lsp-diagnostic*
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-08-27 11:16:33 -07:00
|
|
|
from({diagnostics}) *vim.lsp.diagnostic.from()*
|
|
|
|
Converts the input `vim.Diagnostic`s to LSP diagnostics.
|
|
|
|
|
|
|
|
Parameters: ~
|
|
|
|
• {diagnostics} (`vim.Diagnostic[]`)
|
|
|
|
|
|
|
|
Return: ~
|
|
|
|
(`lsp.Diagnostic[]`)
|
|
|
|
|
2023-07-20 00:03:48 -07:00
|
|
|
*vim.lsp.diagnostic.get_namespace()*
|
|
|
|
get_namespace({client_id}, {is_pull})
|
2021-09-06 19:21:18 -07:00
|
|
|
Get the diagnostic namespace associated with an LSP client
|
2023-07-20 00:03:48 -07:00
|
|
|
|vim.diagnostic| for diagnostics
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {client_id} (`integer`) The id of the LSP client
|
|
|
|
• {is_pull} (`boolean?`) Whether the namespace is for a pull or push
|
2023-10-14 00:47:20 -07:00
|
|
|
client. Defaults to push
|
2023-07-20 00:03:48 -07:00
|
|
|
|
|
|
|
*vim.lsp.diagnostic.on_diagnostic()*
|
|
|
|
on_diagnostic({_}, {result}, {ctx}, {config})
|
|
|
|
|lsp-handler| for the method "textDocument/diagnostic"
|
|
|
|
|
|
|
|
See |vim.diagnostic.config()| for configuration options. Handler-specific
|
|
|
|
configuration can be set using |vim.lsp.with()|: >lua
|
2023-09-14 06:23:01 -07:00
|
|
|
vim.lsp.handlers["textDocument/diagnostic"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_diagnostic, {
|
|
|
|
-- Enable underline, use default values
|
|
|
|
underline = true,
|
|
|
|
-- Enable virtual text, override spacing to 4
|
|
|
|
virtual_text = {
|
|
|
|
spacing = 4,
|
|
|
|
},
|
|
|
|
-- Use a function to dynamically turn signs off
|
|
|
|
-- and on, using buffer local variables
|
|
|
|
signs = function(namespace, bufnr)
|
|
|
|
return vim.b[bufnr].show_signs == true
|
|
|
|
end,
|
|
|
|
-- Disable a feature
|
|
|
|
update_in_insert = false,
|
|
|
|
}
|
|
|
|
)
|
2023-07-20 00:03:48 -07:00
|
|
|
<
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-02-08 05:11:47 -07:00
|
|
|
• {result} (`lsp.DocumentDiagnosticReport`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {ctx} (`lsp.HandlerContext`)
|
2024-03-05 05:06:15 -07:00
|
|
|
• {config} (`vim.diagnostic.Opts`) Configuration table (see
|
2024-01-09 10:36:46 -07:00
|
|
|
|vim.diagnostic.config()|).
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
*vim.lsp.diagnostic.on_publish_diagnostics()*
|
2021-08-29 09:38:11 -07:00
|
|
|
on_publish_diagnostics({_}, {result}, {ctx}, {config})
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|lsp-handler| for the method "textDocument/publishDiagnostics"
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-09-06 19:21:18 -07:00
|
|
|
See |vim.diagnostic.config()| for configuration options. Handler-specific
|
2022-11-23 04:31:49 -07:00
|
|
|
configuration can be set using |vim.lsp.with()|: >lua
|
2023-09-14 06:23:01 -07:00
|
|
|
vim.lsp.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
|
|
vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
|
|
-- Enable underline, use default values
|
|
|
|
underline = true,
|
|
|
|
-- Enable virtual text, override spacing to 4
|
|
|
|
virtual_text = {
|
|
|
|
spacing = 4,
|
|
|
|
},
|
|
|
|
-- Use a function to dynamically turn signs off
|
|
|
|
-- and on, using buffer local variables
|
|
|
|
signs = function(namespace, bufnr)
|
|
|
|
return vim.b[bufnr].show_signs == true
|
|
|
|
end,
|
|
|
|
-- Disable a feature
|
|
|
|
update_in_insert = false,
|
|
|
|
}
|
|
|
|
)
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
<
|
2019-12-31 07:52:14 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Parameters: ~
|
2024-02-10 15:03:44 -07:00
|
|
|
• {result} (`lsp.PublishDiagnosticsParams`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {ctx} (`lsp.HandlerContext`)
|
2024-02-10 15:03:44 -07:00
|
|
|
• {config} (`vim.diagnostic.Opts?`) Configuration table (see
|
2024-01-09 10:36:46 -07:00
|
|
|
|vim.diagnostic.config()|).
|
2021-08-19 11:28:18 -07:00
|
|
|
|
2021-01-18 12:11:37 -07:00
|
|
|
|
2020-10-26 03:50:57 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.codelens *lsp-codelens*
|
|
|
|
|
2022-12-31 08:16:21 -07:00
|
|
|
clear({client_id}, {bufnr}) *vim.lsp.codelens.clear()*
|
|
|
|
Clear the lenses
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {client_id} (`integer?`) filter by client_id. All clients if nil
|
2024-01-28 23:21:37 -07:00
|
|
|
• {bufnr} (`integer?`) filter by buffer. All buffers if nil, 0 for
|
|
|
|
current buffer
|
2022-12-31 08:16:21 -07:00
|
|
|
|
2020-10-26 03:50:57 -07:00
|
|
|
display({lenses}, {bufnr}, {client_id}) *vim.lsp.codelens.display()*
|
|
|
|
Display the lenses using virtual text
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {lenses} (`lsp.CodeLens[]?`) lenses to display
|
|
|
|
• {bufnr} (`integer`)
|
|
|
|
• {client_id} (`integer`)
|
2020-10-26 03:50:57 -07:00
|
|
|
|
|
|
|
get({bufnr}) *vim.lsp.codelens.get()*
|
|
|
|
Return all lenses for the given buffer
|
|
|
|
|
2021-09-01 04:29:11 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer number. 0 can be used for the current
|
2023-03-06 23:17:52 -07:00
|
|
|
buffer.
|
2021-09-01 04:29:11 -07:00
|
|
|
|
2020-10-26 03:50:57 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`lsp.CodeLens[]`)
|
2020-10-26 03:50:57 -07:00
|
|
|
|
2024-02-15 10:16:04 -07:00
|
|
|
on_codelens({err}, {result}, {ctx}) *vim.lsp.codelens.on_codelens()*
|
2020-10-26 03:50:57 -07:00
|
|
|
|lsp-handler| for the method `textDocument/codeLens`
|
|
|
|
|
2023-12-13 05:00:11 -07:00
|
|
|
Parameters: ~
|
2024-02-15 10:16:04 -07:00
|
|
|
• {err} (`lsp.ResponseError?`)
|
|
|
|
• {result} (`lsp.CodeLens[]`)
|
|
|
|
• {ctx} (`lsp.HandlerContext`)
|
2023-12-13 05:00:11 -07:00
|
|
|
|
2024-01-28 23:21:37 -07:00
|
|
|
refresh({opts}) *vim.lsp.codelens.refresh()*
|
|
|
|
Refresh the lenses.
|
2020-10-26 03:50:57 -07:00
|
|
|
|
|
|
|
It is recommended to trigger this using an autocmd or via keymap.
|
2022-11-23 04:31:49 -07:00
|
|
|
|
|
|
|
Example: >vim
|
2024-01-28 23:21:37 -07:00
|
|
|
autocmd BufEnter,CursorHold,InsertLeave <buffer> lua vim.lsp.codelens.refresh({ bufnr = 0 })
|
2020-10-26 03:50:57 -07:00
|
|
|
<
|
|
|
|
|
2024-01-28 23:21:37 -07:00
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {opts} (`table?`) Optional fields
|
|
|
|
• {bufnr} (`integer?`) filter by buffer. All buffers if nil, 0
|
|
|
|
for current buffer
|
2024-01-28 23:21:37 -07:00
|
|
|
|
2020-10-26 03:50:57 -07:00
|
|
|
run() *vim.lsp.codelens.run()*
|
|
|
|
Run the code lens in the current line
|
|
|
|
|
|
|
|
save({lenses}, {bufnr}, {client_id}) *vim.lsp.codelens.save()*
|
|
|
|
Store lenses for a specific buffer and client
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {lenses} (`lsp.CodeLens[]?`) lenses to store
|
|
|
|
• {bufnr} (`integer`)
|
|
|
|
• {client_id} (`integer`)
|
2020-10-26 03:50:57 -07:00
|
|
|
|
|
|
|
|
2024-02-04 15:13:23 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.completion *lsp-completion*
|
|
|
|
|
|
|
|
*vim.lsp.completion.BufferOpts*
|
|
|
|
|
|
|
|
Fields: ~
|
|
|
|
• {autotrigger}? (`boolean`) Whether to trigger completion
|
|
|
|
automatically. Default: false
|
2024-09-01 13:01:24 -07:00
|
|
|
• {convert}? (`fun(item: lsp.CompletionItem): table`) Transforms an
|
2024-08-22 12:42:27 -07:00
|
|
|
LSP CompletionItem to |complete-items|.
|
2024-02-04 15:13:23 -07:00
|
|
|
|
|
|
|
|
|
|
|
*vim.lsp.completion.enable()*
|
|
|
|
enable({enable}, {client_id}, {bufnr}, {opts})
|
|
|
|
Enables or disables completions from the given language client in the
|
|
|
|
given buffer.
|
|
|
|
|
|
|
|
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|.
|
|
|
|
|
|
|
|
trigger() *vim.lsp.completion.trigger()*
|
|
|
|
Trigger LSP completion in the current buffer.
|
|
|
|
|
|
|
|
|
2023-11-12 05:54:27 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.inlay_hint *lsp-inlay_hint*
|
|
|
|
|
2024-04-18 07:57:58 -07:00
|
|
|
enable({enable}, {filter}) *vim.lsp.inlay_hint.enable()*
|
2024-05-14 16:18:33 -07:00
|
|
|
Enables or disables inlay hints for the {filter}ed scope.
|
2024-01-18 01:14:48 -07:00
|
|
|
|
|
|
|
To "toggle", pass the inverse of `is_enabled()`: >lua
|
2024-04-18 07:57:58 -07:00
|
|
|
vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled())
|
2024-01-18 01:14:48 -07:00
|
|
|
<
|
2023-11-12 05:54:27 -07:00
|
|
|
|
2024-10-04 02:13:31 -07:00
|
|
|
Attributes: ~
|
|
|
|
Since: 0.10.0
|
|
|
|
|
2023-11-12 05:54:27 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {enable} (`boolean?`) true/nil to enable, false to disable
|
2024-04-18 07:57:58 -07:00
|
|
|
• {filter} (`table?`) Optional filters |kwargs|, or `nil` for all.
|
2024-05-02 06:16:20 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer number, or 0 for current
|
|
|
|
buffer, or nil for all.
|
2023-11-12 05:54:27 -07:00
|
|
|
|
|
|
|
get({filter}) *vim.lsp.inlay_hint.get()*
|
2023-11-27 09:23:04 -07:00
|
|
|
Get the list of inlay hints, (optionally) restricted by buffer or range.
|
2023-11-12 05:54:27 -07:00
|
|
|
|
|
|
|
Example usage: >lua
|
|
|
|
local hint = vim.lsp.inlay_hint.get({ bufnr = 0 })[1] -- 0 for current buffer
|
|
|
|
|
|
|
|
local client = vim.lsp.get_client_by_id(hint.client_id)
|
2024-05-02 06:57:21 -07:00
|
|
|
local resp = client.request_sync('inlayHint/resolve', hint.inlay_hint, 100, 0)
|
|
|
|
local resolved_hint = assert(resp and resp.result, resp.err)
|
2023-11-12 05:54:27 -07:00
|
|
|
vim.lsp.util.apply_text_edits(resolved_hint.textEdits, 0, client.encoding)
|
|
|
|
|
|
|
|
location = resolved_hint.label[1].location
|
2023-11-14 06:15:45 -07:00
|
|
|
client.request('textDocument/hover', {
|
2023-11-12 05:54:27 -07:00
|
|
|
textDocument = { uri = location.uri },
|
|
|
|
position = location.range.start,
|
|
|
|
})
|
|
|
|
<
|
|
|
|
|
2024-10-04 02:13:31 -07:00
|
|
|
Attributes: ~
|
|
|
|
Since: 0.10.0
|
|
|
|
|
2023-11-12 05:54:27 -07:00
|
|
|
Parameters: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
• {filter} (`table?`) Optional filters |kwargs|:
|
|
|
|
• {bufnr} (`integer?`)
|
|
|
|
• {range} (`lsp.Range?`)
|
2023-11-12 05:54:27 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
(`table[]`) A list of objects with the following fields:
|
|
|
|
• {bufnr} (`integer`)
|
|
|
|
• {client_id} (`integer`)
|
|
|
|
• {inlay_hint} (`lsp.InlayHint`)
|
2023-11-12 05:54:27 -07:00
|
|
|
|
2024-05-02 07:26:07 -07:00
|
|
|
is_enabled({filter}) *vim.lsp.inlay_hint.is_enabled()*
|
2024-05-14 16:18:33 -07:00
|
|
|
Query whether inlay hint is enabled in the {filter}ed scope
|
2024-02-15 10:16:04 -07:00
|
|
|
|
2024-10-04 02:13:31 -07:00
|
|
|
Attributes: ~
|
|
|
|
Since: 0.10.0
|
|
|
|
|
2023-11-12 05:54:27 -07:00
|
|
|
Parameters: ~
|
2024-06-14 16:04:27 -07:00
|
|
|
• {filter} (`table?`) Optional filters |kwargs|, or `nil` for all.
|
2024-05-02 07:26:07 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer number, or 0 for current
|
|
|
|
buffer, or nil for all.
|
2023-11-12 05:54:27 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`)
|
2023-11-12 05:54:27 -07:00
|
|
|
|
|
|
|
|
2022-11-23 09:06:36 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.semantic_tokens *lsp-semantic_tokens*
|
|
|
|
|
|
|
|
force_refresh({bufnr}) *vim.lsp.semantic_tokens.force_refresh()*
|
|
|
|
Force a refresh of all semantic tokens
|
|
|
|
|
|
|
|
Only has an effect if the buffer is currently active for semantic token
|
|
|
|
highlighting (|vim.lsp.semantic_tokens.start()| has been called for it)
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) filter by buffer. All buffers if nil, current
|
2023-03-06 11:03:13 -07:00
|
|
|
buffer if 0
|
2022-11-23 09:06:36 -07:00
|
|
|
|
2022-12-10 05:17:07 -07:00
|
|
|
*vim.lsp.semantic_tokens.get_at_pos()*
|
|
|
|
get_at_pos({bufnr}, {row}, {col})
|
|
|
|
Return the semantic token(s) at the given position. If called without
|
2022-12-14 02:46:54 -07:00
|
|
|
arguments, returns the token under the cursor.
|
2022-12-10 05:17:07 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer number (0 for current buffer, default)
|
|
|
|
• {row} (`integer?`) Position row (default cursor position)
|
|
|
|
• {col} (`integer?`) Position column (default cursor position)
|
2022-12-10 05:17:07 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table?`) List of tokens at position. Each token has the following
|
2023-03-06 11:03:13 -07:00
|
|
|
fields:
|
2023-03-06 23:17:52 -07:00
|
|
|
• line (integer) line number, 0-based
|
|
|
|
• start_col (integer) start column, 0-based
|
|
|
|
• end_col (integer) end column, 0-based
|
2023-03-06 11:03:13 -07:00
|
|
|
• type (string) token type as string, e.g. "variable"
|
|
|
|
• modifiers (table) token modifiers as a set. E.g., { static = true,
|
|
|
|
readonly = true }
|
2023-12-13 05:00:11 -07:00
|
|
|
• client_id (integer)
|
2023-03-06 11:03:13 -07:00
|
|
|
|
|
|
|
*vim.lsp.semantic_tokens.highlight_token()*
|
|
|
|
highlight_token({token}, {bufnr}, {client_id}, {hl_group}, {opts})
|
|
|
|
Highlight a semantic token.
|
|
|
|
|
|
|
|
Apply an extmark with a given highlight group for a semantic token. The
|
|
|
|
mark will be deleted by the semantic token engine when appropriate; for
|
|
|
|
example, when the LSP sends updated tokens. This function is intended for
|
|
|
|
use inside |LspTokenUpdate| callbacks.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-21 09:25:54 -07:00
|
|
|
• {token} (`table`) A semantic token, found as `args.data.token` in
|
|
|
|
|LspTokenUpdate|
|
|
|
|
• {bufnr} (`integer`) The buffer to highlight, or `0` for current
|
|
|
|
buffer
|
2024-02-27 08:20:32 -07:00
|
|
|
• {client_id} (`integer`) The ID of the |vim.lsp.Client|
|
2024-01-09 10:36:46 -07:00
|
|
|
• {hl_group} (`string`) Highlight group name
|
2024-02-27 08:20:32 -07:00
|
|
|
• {opts} (`table?`) Optional parameters:
|
|
|
|
• {priority}? (`integer`, default:
|
|
|
|
`vim.highlight.priorities.semantic_tokens + 3`)
|
|
|
|
Priority for the applied extmark.
|
2022-12-10 05:17:07 -07:00
|
|
|
|
2022-11-23 09:06:36 -07:00
|
|
|
start({bufnr}, {client_id}, {opts}) *vim.lsp.semantic_tokens.start()*
|
|
|
|
Start the semantic token highlighting engine for the given buffer with the
|
|
|
|
given client. The client must already be attached to the buffer.
|
|
|
|
|
|
|
|
NOTE: This is currently called automatically by
|
|
|
|
|vim.lsp.buf_attach_client()|. To opt-out of semantic highlighting with a
|
|
|
|
server that supports it, you can delete the semanticTokensProvider table
|
|
|
|
from the {server_capabilities} of your client in your |LspAttach| callback
|
2022-12-12 12:43:14 -07:00
|
|
|
or your configuration's `on_attach` callback: >lua
|
2023-09-14 06:23:01 -07:00
|
|
|
client.server_capabilities.semanticTokensProvider = nil
|
2022-11-23 09:06:36 -07:00
|
|
|
<
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-21 09:25:54 -07:00
|
|
|
• {bufnr} (`integer`) Buffer number, or `0` for current buffer
|
|
|
|
• {client_id} (`integer`) The ID of the |vim.lsp.Client|
|
2024-01-09 10:36:46 -07:00
|
|
|
• {opts} (`table?`) Optional keyword arguments
|
2023-03-06 23:17:52 -07:00
|
|
|
• debounce (integer, default: 200): Debounce token
|
2022-11-23 09:06:36 -07:00
|
|
|
requests to the server by the given number in
|
|
|
|
milliseconds
|
|
|
|
|
|
|
|
stop({bufnr}, {client_id}) *vim.lsp.semantic_tokens.stop()*
|
|
|
|
Stop the semantic token highlighting engine for the given buffer with the
|
|
|
|
given client.
|
|
|
|
|
|
|
|
NOTE: This is automatically called by a |LspDetach| autocmd that is set up
|
|
|
|
as part of `start()`, so you should only need this function to manually
|
|
|
|
disengage the semantic token engine without fully detaching the LSP client
|
|
|
|
from the buffer.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-21 09:25:54 -07:00
|
|
|
• {bufnr} (`integer`) Buffer number, or `0` for current buffer
|
|
|
|
• {client_id} (`integer`) The ID of the |vim.lsp.Client|
|
2022-11-23 09:06:36 -07:00
|
|
|
|
|
|
|
|
2021-01-18 12:11:37 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.handlers *lsp-handlers*
|
|
|
|
|
2021-08-29 09:38:11 -07:00
|
|
|
hover({_}, {result}, {ctx}, {config}) *vim.lsp.handlers.hover()*
|
2022-11-23 04:31:49 -07:00
|
|
|
|lsp-handler| for the method "textDocument/hover" >lua
|
2023-09-14 06:23:01 -07:00
|
|
|
vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(
|
|
|
|
vim.lsp.handlers.hover, {
|
|
|
|
-- Use a sharp border with `FloatBorder` highlights
|
|
|
|
border = "single",
|
|
|
|
-- add the title in hover float window
|
|
|
|
title = "hover"
|
|
|
|
}
|
|
|
|
)
|
2021-07-17 02:15:57 -07:00
|
|
|
<
|
2020-02-26 12:10:16 -07:00
|
|
|
|
2021-04-06 05:22:33 -07:00
|
|
|
Parameters: ~
|
2024-02-15 10:16:04 -07:00
|
|
|
• {result} (`lsp.Hover`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {ctx} (`lsp.HandlerContext`)
|
|
|
|
• {config} (`table`) Configuration table.
|
2021-04-06 05:22:33 -07:00
|
|
|
• border: (default=nil)
|
|
|
|
• Add borders to the floating window
|
2023-09-10 01:02:23 -07:00
|
|
|
• See |vim.lsp.util.open_floating_preview()| for more
|
|
|
|
options.
|
2021-04-06 05:22:33 -07:00
|
|
|
|
2021-07-17 02:15:57 -07:00
|
|
|
*vim.lsp.handlers.signature_help()*
|
2021-08-29 09:38:11 -07:00
|
|
|
signature_help({_}, {result}, {ctx}, {config})
|
2023-09-14 06:23:01 -07:00
|
|
|
|lsp-handler| for the method "textDocument/signatureHelp".
|
|
|
|
|
|
|
|
The active parameter is highlighted with |hl-LspSignatureActiveParameter|. >lua
|
|
|
|
vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
|
|
|
|
vim.lsp.handlers.signature_help, {
|
|
|
|
-- Use a sharp border with `FloatBorder` highlights
|
|
|
|
border = "single"
|
|
|
|
}
|
|
|
|
)
|
2021-04-06 05:22:33 -07:00
|
|
|
<
|
|
|
|
|
2021-07-17 02:15:57 -07:00
|
|
|
Parameters: ~
|
2024-02-15 10:16:04 -07:00
|
|
|
• {result} (`lsp.SignatureHelp`) Response from the language server
|
2024-01-09 10:36:46 -07:00
|
|
|
• {ctx} (`lsp.HandlerContext`) Client context
|
|
|
|
• {config} (`table`) Configuration table.
|
2021-07-17 02:15:57 -07:00
|
|
|
• border: (default=nil)
|
|
|
|
• Add borders to the floating window
|
2023-09-10 01:02:23 -07:00
|
|
|
• See |vim.lsp.util.open_floating_preview()| for more
|
|
|
|
options
|
2021-07-17 02:15:57 -07:00
|
|
|
|
2020-04-25 06:46:58 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.util *lsp-util*
|
|
|
|
|
|
|
|
*vim.lsp.util.apply_text_document_edit()*
|
2022-01-17 11:28:23 -07:00
|
|
|
apply_text_document_edit({text_document_edit}, {index}, {offset_encoding})
|
2022-03-13 05:48:14 -07:00
|
|
|
Applies a `TextDocumentEdit`, which is a list of changes to a single
|
2021-01-11 09:39:11 -07:00
|
|
|
document.
|
|
|
|
|
2020-04-25 06:46:58 -07:00
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {text_document_edit} (`lsp.TextDocumentEdit`)
|
|
|
|
• {index} (`integer?`) Optional index of the edit, if from
|
2024-01-09 10:36:46 -07:00
|
|
|
a list of edits (or nil, if not from a list)
|
2024-02-15 10:16:04 -07:00
|
|
|
• {offset_encoding} (`string?`)
|
2020-07-02 04:09:17 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentEdit
|
2020-07-02 04:09:17 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
*vim.lsp.util.apply_text_edits()*
|
2021-12-15 08:19:54 -07:00
|
|
|
apply_text_edits({text_edits}, {bufnr}, {offset_encoding})
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Applies a list of text edits to a buffer.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {text_edits} (`lsp.TextEdit[]`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer id
|
|
|
|
• {offset_encoding} (`string`) utf-8|utf-16|utf-32
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2021-08-09 11:54:28 -07:00
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textEdit
|
2021-08-09 11:54:28 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
*vim.lsp.util.apply_workspace_edit()*
|
2022-01-17 11:28:23 -07:00
|
|
|
apply_workspace_edit({workspace_edit}, {offset_encoding})
|
2022-03-13 05:48:14 -07:00
|
|
|
Applies a `WorkspaceEdit`.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {workspace_edit} (`lsp.WorkspaceEdit`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`string`) utf-8|utf-16|utf-32 (required)
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2024-02-15 10:16:04 -07:00
|
|
|
See also: ~
|
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit
|
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
buf_clear_references({bufnr}) *vim.lsp.util.buf_clear_references()*
|
|
|
|
Removes document highlights from a buffer.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer id
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-07-02 04:09:17 -07:00
|
|
|
*vim.lsp.util.buf_highlight_references()*
|
2021-11-18 14:50:55 -07:00
|
|
|
buf_highlight_references({bufnr}, {references}, {offset_encoding})
|
2020-09-06 16:55:49 -07:00
|
|
|
Shows a list of document highlights for a certain buffer.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer`) Buffer id
|
2024-05-31 05:41:10 -07:00
|
|
|
• {references} (`lsp.DocumentHighlight[]`) objects to highlight
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`string`) One of "utf-8", "utf-16", "utf-32".
|
2020-02-27 04:12:53 -07:00
|
|
|
|
2021-08-09 11:54:28 -07:00
|
|
|
See also: ~
|
2023-10-16 08:13:37 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specification/#textDocumentContentChangeEvent
|
2021-08-09 11:54:28 -07:00
|
|
|
|
2021-06-06 03:23:07 -07:00
|
|
|
*vim.lsp.util.character_offset()*
|
2021-12-15 08:19:54 -07:00
|
|
|
character_offset({buf}, {row}, {col}, {offset_encoding})
|
2020-08-19 09:17:08 -07:00
|
|
|
Returns the UTF-32 and UTF-16 offsets for a position in a certain buffer.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {buf} (`integer`) buffer number (0 for current)
|
|
|
|
• {row} (`integer`) 0-indexed line
|
|
|
|
• {col} (`integer`) 0-indexed byte offset in line
|
|
|
|
• {offset_encoding} (`string`) utf-8|utf-16|utf-32 defaults to
|
2022-05-12 07:02:46 -07:00
|
|
|
`offset_encoding` of first client of `buf`
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer`) `offset_encoding` index of the character in line {row}
|
2023-07-01 03:42:37 -07:00
|
|
|
column {col} in buffer {buf}
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
*vim.lsp.util.convert_input_to_markdown_lines()*
|
|
|
|
convert_input_to_markdown_lines({input}, {contents})
|
2020-09-06 16:55:49 -07:00
|
|
|
Converts any of `MarkedString` | `MarkedString[]` | `MarkupContent` into a
|
2020-08-19 09:17:08 -07:00
|
|
|
list of lines containing valid markdown. Useful to populate the hover
|
2022-03-13 05:48:14 -07:00
|
|
|
window for `textDocument/hover`, for parsing the result of
|
|
|
|
`textDocument/signatureHelp`, and potentially others.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
2023-09-12 20:51:21 -07:00
|
|
|
Note that if the input is of type `MarkupContent` and its kind is
|
|
|
|
`plaintext`, then the corresponding value is returned without further
|
|
|
|
modifications.
|
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {input} (`lsp.MarkedString|lsp.MarkedString[]|lsp.MarkupContent`)
|
2024-05-31 05:41:10 -07:00
|
|
|
• {contents} (`string[]?`) List of strings to extend with converted
|
|
|
|
lines. Defaults to {}.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`string[]`) extended with lines of converted markdown.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
*vim.lsp.util.convert_signature_help_to_markdown_lines()*
|
2021-07-09 03:39:24 -07:00
|
|
|
convert_signature_help_to_markdown_lines({signature_help}, {ft}, {triggers})
|
2023-09-12 20:51:21 -07:00
|
|
|
Converts `textDocument/signatureHelp` response to markdown lines.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {signature_help} (`lsp.SignatureHelp`) Response of
|
|
|
|
`textDocument/SignatureHelp`
|
2024-01-09 10:36:46 -07:00
|
|
|
• {ft} (`string?`) filetype that will be use as the `lang`
|
2023-07-01 03:42:37 -07:00
|
|
|
for the label markdown code block
|
2024-01-09 10:36:46 -07:00
|
|
|
• {triggers} (`table?`) list of trigger characters from the lsp
|
2021-07-09 03:39:24 -07:00
|
|
|
server. used to better determine parameter offsets
|
2020-08-19 09:17:08 -07:00
|
|
|
|
2023-07-06 06:32:39 -07:00
|
|
|
Return (multiple): ~
|
2024-05-31 05:41:10 -07:00
|
|
|
(`string[]?`) table list of lines of converted markdown.
|
|
|
|
(`number[]?`) table of active hl
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
get_effective_tabstop({bufnr}) *vim.lsp.util.get_effective_tabstop()*
|
2022-03-20 10:41:46 -07:00
|
|
|
Returns indentation size.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer handle, defaults to current
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer`) indentation size
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• 'shiftwidth'
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2022-01-17 11:28:23 -07:00
|
|
|
*vim.lsp.util.jump_to_location()*
|
2022-05-18 12:03:24 -07:00
|
|
|
jump_to_location({location}, {offset_encoding}, {reuse_win})
|
2020-08-19 09:17:08 -07:00
|
|
|
Jumps to a location.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {location} (`lsp.Location|lsp.LocationLink`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`string?`) utf-8|utf-16|utf-32
|
|
|
|
• {reuse_win} (`boolean?`) Jump to existing window if buffer is
|
2022-10-08 01:22:25 -07:00
|
|
|
already open.
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) `true` if the jump succeeded
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2022-01-17 11:28:23 -07:00
|
|
|
*vim.lsp.util.locations_to_items()*
|
|
|
|
locations_to_items({locations}, {offset_encoding})
|
2020-08-19 09:17:08 -07:00
|
|
|
Returns the items with the byte position calculated correctly and in
|
|
|
|
sorted order, for display in quickfix and location lists.
|
|
|
|
|
2023-09-07 01:12:02 -07:00
|
|
|
The `user_data` field of each resulting item will contain the original
|
|
|
|
`Location` or `LocationLink` it was computed from.
|
|
|
|
|
2021-09-06 19:21:18 -07:00
|
|
|
The result can be passed to the {list} argument of |setqflist()| or
|
|
|
|
|setloclist()|.
|
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {locations} (`lsp.Location[]|lsp.LocationLink[]`)
|
|
|
|
• {offset_encoding} (`string`) offset_encoding for locations
|
2023-07-01 03:42:37 -07:00
|
|
|
utf-8|utf-16|utf-32 default to first client of
|
|
|
|
buffer
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-02-27 08:20:32 -07:00
|
|
|
(`table[]`) A list of objects with the following fields:
|
|
|
|
• {filename} (`string`)
|
|
|
|
• {lnum} (`integer`) 1-indexed line number
|
2024-06-09 18:14:55 -07:00
|
|
|
• {end_lnum} (`integer`) 1-indexed end line number
|
2024-02-27 08:20:32 -07:00
|
|
|
• {col} (`integer`) 1-indexed column
|
2024-06-09 18:14:55 -07:00
|
|
|
• {end_col} (`integer`) 1-indexed end column
|
2024-02-27 08:20:32 -07:00
|
|
|
• {text} (`string`)
|
|
|
|
• {user_data} (`lsp.Location|lsp.LocationLink`)
|
2019-12-31 07:52:14 -07:00
|
|
|
|
|
|
|
*vim.lsp.util.make_floating_popup_options()*
|
|
|
|
make_floating_popup_options({width}, {height}, {opts})
|
2020-08-19 09:17:08 -07:00
|
|
|
Creates a table with sensible default options for a floating window. The
|
|
|
|
table can be passed to |nvim_open_win()|.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {width} (`integer`) window width (in character cells)
|
|
|
|
• {height} (`integer`) window height (in character cells)
|
|
|
|
• {opts} (`table`) optional
|
2023-03-06 23:17:52 -07:00
|
|
|
• offset_x (integer) offset to add to `col`
|
|
|
|
• offset_y (integer) offset to add to `row`
|
2021-10-05 10:48:48 -07:00
|
|
|
• border (string or table) override `border`
|
|
|
|
• focusable (string or table) override `focusable`
|
2022-03-13 05:48:14 -07:00
|
|
|
• zindex (string or table) override `zindex`, defaults to 50
|
feat(float): open float relative to mouse #21531
Problem:
No easy way to position a LSP hover window relative to mouse.
Solution:
Introduce another option to the `relative` key in `nvim_open_win()`.
With this PR it should be possible to override the handler and do something
similar to this https://github.com/neovim/neovim/pull/19481#issuecomment-1193248674
to have hover information displayed from the mouse.
Test case:
```lua
local util = require('vim.lsp.util')
local function make_position_param(window, offset_encoding)
window = window or 0
local buf = vim.api.nvim_win_get_buf(window)
local row, col
local mouse = vim.fn.getmousepos()
row = mouse.line
col = mouse.column
offset_encoding = offset_encoding or util._get_offset_encoding(buf)
row = row - 1
local line = vim.api.nvim_buf_get_lines(buf, row, row + 1, true)[1]
if not line then
return { line = 0, character = 0 }
end
if #line < col then
return { line = 0, character = 0 }
end
col = util._str_utfindex_enc(line, col, offset_encoding)
return { line = row, character = col }
end
local make_params = function(window, offset_encoding)
window = window or 0
local buf = vim.api.nvim_win_get_buf(window)
offset_encoding = offset_encoding or util._get_offset_encoding(buf)
return {
textDocument = util.make_text_document_params(buf),
position = make_position_param(window, offset_encoding),
}
end
local hover_timer = nil
vim.o.mousemoveevent = true
vim.keymap.set({ '', 'i' }, '<MouseMove>', function()
if hover_timer then
hover_timer:close()
end
hover_timer = vim.defer_fn(function()
hover_timer = nil
local params = make_params()
vim.lsp.buf_request(
0,
'textDocument/hover',
params,
vim.lsp.with(vim.lsp.handlers.hover, {
silent = true,
focusable = false,
relative = 'mouse',
})
)
end, 500)
return '<MouseMove>'
end, { expr = true })
```
2023-01-10 03:22:41 -07:00
|
|
|
• relative ("mouse"|"cursor") defaults to "cursor"
|
2023-09-10 01:02:23 -07:00
|
|
|
• anchor_bias ("auto"|"above"|"below") defaults to "auto"
|
|
|
|
• "auto": place window based on which side of the cursor
|
|
|
|
has more lines
|
|
|
|
• "above": place the window above the cursor unless there
|
|
|
|
are not enough lines to display the full window height.
|
|
|
|
• "below": place the window below the cursor unless there
|
|
|
|
are not enough lines to display the full window height.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table`) Options
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
*vim.lsp.util.make_formatting_params()*
|
|
|
|
make_formatting_params({options})
|
2021-07-17 02:15:57 -07:00
|
|
|
Creates a `DocumentFormattingParams` object for the current buffer and
|
|
|
|
cursor position.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {options} (`lsp.FormattingOptions?`) with valid `FormattingOptions`
|
|
|
|
entries
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`lsp.DocumentFormattingParams`) object
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-10-20 12:57:07 -07:00
|
|
|
*vim.lsp.util.make_given_range_params()*
|
2021-12-15 08:19:54 -07:00
|
|
|
make_given_range_params({start_pos}, {end_pos}, {bufnr}, {offset_encoding})
|
2020-10-20 12:57:07 -07:00
|
|
|
Using the given range in the current buffer, creates an object that is
|
|
|
|
similar to |vim.lsp.util.make_range_params()|.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-10-20 12:57:07 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {start_pos} (`integer[]?`) {row,col} mark-indexed position.
|
2022-07-28 10:19:07 -07:00
|
|
|
Defaults to the start of the last visual selection.
|
2024-01-09 10:36:46 -07:00
|
|
|
• {end_pos} (`integer[]?`) {row,col} mark-indexed position.
|
2022-07-28 10:19:07 -07:00
|
|
|
Defaults to the end of the last visual selection.
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) buffer handle or 0 for current,
|
2022-07-28 10:19:07 -07:00
|
|
|
defaults to current
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`"utf-8"|"utf-16"|"utf-32"?`) defaults to
|
2022-07-28 10:19:07 -07:00
|
|
|
`offset_encoding` of first client of `bufnr`
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-10-20 12:57:07 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table`) { textDocument = { uri = `current_file_uri` }, range = {
|
|
|
|
start = `start_position`, end = `end_position` } }
|
2020-10-20 12:57:07 -07:00
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
*vim.lsp.util.make_position_params()*
|
|
|
|
make_position_params({window}, {offset_encoding})
|
2020-08-19 09:17:08 -07:00
|
|
|
Creates a `TextDocumentPositionParams` object for the current buffer and
|
|
|
|
cursor position.
|
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {window} (`integer?`) window handle or 0 for current,
|
2022-07-28 10:19:07 -07:00
|
|
|
defaults to current
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`string?`) utf-8|utf-16|utf-32|nil defaults to
|
2022-05-12 07:02:46 -07:00
|
|
|
`offset_encoding` of first client of buffer of
|
|
|
|
`window`
|
2021-12-15 08:19:54 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
(`lsp.TextDocumentPositionParams`)
|
2020-08-19 09:17:08 -07:00
|
|
|
|
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentPositionParams
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
*vim.lsp.util.make_range_params()*
|
|
|
|
make_range_params({window}, {offset_encoding})
|
2020-08-19 09:17:08 -07:00
|
|
|
Using the current position in the current buffer, creates an object that
|
|
|
|
can be used as a building block for several LSP requests, such as
|
2022-03-13 05:48:14 -07:00
|
|
|
`textDocument/codeAction`, `textDocument/colorPresentation`,
|
|
|
|
`textDocument/rangeFormatting`.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {window} (`integer?`) window handle or 0 for current,
|
2022-07-28 10:19:07 -07:00
|
|
|
defaults to current
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`"utf-8"|"utf-16"|"utf-32"?`) defaults to
|
2022-07-28 10:19:07 -07:00
|
|
|
`offset_encoding` of first client of buffer of
|
|
|
|
`window`
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table`) { textDocument = { uri = `current_file_uri` }, range = {
|
|
|
|
start = `current_position`, end = `current_position` } }
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
*vim.lsp.util.make_text_document_params()*
|
|
|
|
make_text_document_params({bufnr})
|
2020-08-19 09:17:08 -07:00
|
|
|
Creates a `TextDocumentIdentifier` object for the current buffer.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2021-12-15 08:19:54 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {bufnr} (`integer?`) Buffer handle, defaults to current
|
2021-12-15 08:19:54 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
Return: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
(`lsp.TextDocumentIdentifier`)
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-08-19 09:17:08 -07:00
|
|
|
See also: ~
|
2023-03-15 04:51:44 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2020-12-08 19:09:33 -07:00
|
|
|
*vim.lsp.util.make_workspace_params()*
|
|
|
|
make_workspace_params({added}, {removed})
|
|
|
|
Create the workspace params
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {added} (`lsp.WorkspaceFolder[]`)
|
|
|
|
• {removed} (`lsp.WorkspaceFolder[]`)
|
|
|
|
|
|
|
|
Return: ~
|
|
|
|
(`lsp.WorkspaceFoldersChangeEvent`)
|
2020-12-08 19:09:33 -07:00
|
|
|
|
2019-12-31 07:52:14 -07:00
|
|
|
*vim.lsp.util.open_floating_preview()*
|
2021-03-19 12:55:58 -07:00
|
|
|
open_floating_preview({contents}, {syntax}, {opts})
|
2020-09-06 16:55:49 -07:00
|
|
|
Shows contents in a floating window.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2020-07-02 04:09:17 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {contents} (`table`) of lines to show in window
|
|
|
|
• {syntax} (`string`) of syntax to set for opened buffer
|
2024-02-27 08:20:32 -07:00
|
|
|
• {opts} (`table?`) with optional fields (additional keys are
|
2024-01-09 10:36:46 -07:00
|
|
|
filtered with |vim.lsp.util.make_floating_popup_options()|
|
|
|
|
before they are passed on to |nvim_open_win()|)
|
2024-02-27 08:20:32 -07:00
|
|
|
• {height}? (`integer`) Height of floating window
|
|
|
|
• {width}? (`integer`) Width of floating window
|
|
|
|
• {wrap}? (`boolean`, default: `true`) Wrap long lines
|
|
|
|
• {wrap_at}? (`integer`) Character to wrap at for
|
|
|
|
computing height when wrap is enabled
|
|
|
|
• {max_width}? (`integer`) Maximal width of floating
|
|
|
|
window
|
|
|
|
• {max_height}? (`integer`) Maximal height of floating
|
|
|
|
window
|
|
|
|
• {focus_id}? (`string`) If a popup with this id is
|
|
|
|
opened, then focus it
|
|
|
|
• {close_events}? (`table`) List of events that closes the
|
2021-06-01 00:34:37 -07:00
|
|
|
floating window
|
2024-02-27 08:20:32 -07:00
|
|
|
• {focusable}? (`boolean`, default: `true`) Make float
|
|
|
|
focusable.
|
|
|
|
• {focus}? (`boolean`, default: `true`) If `true`, and if
|
2022-03-13 05:48:14 -07:00
|
|
|
{focusable} is also `true`, focus an existing floating
|
2021-11-29 15:37:55 -07:00
|
|
|
window with the same {focus_id}
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2023-07-06 06:32:39 -07:00
|
|
|
Return (multiple): ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer`) bufnr of newly created float window
|
|
|
|
(`integer`) winid of newly created float window preview window
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
preview_location({location}, {opts}) *vim.lsp.util.preview_location()*
|
2020-09-06 16:55:49 -07:00
|
|
|
Previews a location in a floating window
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
behavior depends on type of location:
|
|
|
|
• for Location, range is shown (e.g., function definition)
|
|
|
|
• for LocationLink, targetRange is shown (e.g., body of function
|
|
|
|
definition)
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {location} (`lsp.Location|lsp.LocationLink`)
|
2024-02-15 10:16:04 -07:00
|
|
|
• {opts} (`table`)
|
2020-07-02 04:09:17 -07:00
|
|
|
|
2023-07-06 06:32:39 -07:00
|
|
|
Return (multiple): ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer?`) buffer id of float window
|
|
|
|
(`integer?`) window id of float window
|
2019-12-31 07:52:14 -07:00
|
|
|
|
2021-03-19 12:55:58 -07:00
|
|
|
rename({old_fname}, {new_fname}, {opts}) *vim.lsp.util.rename()*
|
2021-08-22 13:55:28 -07:00
|
|
|
Rename old_fname to new_fname
|
|
|
|
|
2024-03-02 07:21:53 -07:00
|
|
|
Existing buffers are renamed as well, while maintaining their bufnr.
|
|
|
|
|
|
|
|
It deletes existing buffers that conflict with the renamed file name only
|
|
|
|
when
|
|
|
|
• `opts` requests overwriting; or
|
2024-03-11 22:51:53 -07:00
|
|
|
• the conflicting buffers are not loaded, so that deleting them does not
|
2024-03-02 07:21:53 -07:00
|
|
|
result in data loss.
|
|
|
|
|
2021-03-19 12:55:58 -07:00
|
|
|
Parameters: ~
|
2024-02-24 08:47:34 -07:00
|
|
|
• {old_fname} (`string`)
|
|
|
|
• {new_fname} (`string`)
|
2024-02-27 08:20:32 -07:00
|
|
|
• {opts} (`table?`) Options:
|
|
|
|
• {overwrite}? (`boolean`)
|
|
|
|
• {ignoreIfExists}? (`boolean`)
|
2021-03-19 12:55:58 -07:00
|
|
|
|
2022-10-08 01:22:25 -07:00
|
|
|
*vim.lsp.util.show_document()*
|
|
|
|
show_document({location}, {offset_encoding}, {opts})
|
|
|
|
Shows document and optionally jumps to the location.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-05-31 05:41:10 -07:00
|
|
|
• {location} (`lsp.Location|lsp.LocationLink`)
|
2024-01-09 10:36:46 -07:00
|
|
|
• {offset_encoding} (`string?`) utf-8|utf-16|utf-32
|
|
|
|
• {opts} (`table?`) options
|
2022-10-08 01:22:25 -07:00
|
|
|
• reuse_win (boolean) Jump to existing window if
|
|
|
|
buffer is already open.
|
|
|
|
• focus (boolean) Whether to focus/jump to location
|
|
|
|
if possible. Defaults to true.
|
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) `true` if succeeded
|
2022-10-08 01:22:25 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
*vim.lsp.util.stylize_markdown()*
|
|
|
|
stylize_markdown({bufnr}, {contents}, {opts})
|
|
|
|
Converts markdown into syntax highlighted regions by stripping the code
|
|
|
|
blocks and converting them into highlighted code. This will by default
|
|
|
|
insert a blank line separator after those code block regions to improve
|
|
|
|
readability.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
This method configures the given buffer and returns the lines to set.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
If you want to open a popup with fancy markdown, use
|
|
|
|
`open_floating_preview` instead
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
Parameters: ~
|
2024-02-15 10:16:04 -07:00
|
|
|
• {bufnr} (`integer`)
|
2024-05-31 05:41:10 -07:00
|
|
|
• {contents} (`string[]`) of lines to show in window
|
2024-01-09 10:36:46 -07:00
|
|
|
• {opts} (`table`) with optional fields
|
2021-05-31 10:47:51 -07:00
|
|
|
• height of floating window
|
|
|
|
• width of floating window
|
|
|
|
• wrap_at character to wrap at for computing height
|
|
|
|
• max_width maximal width of floating window
|
|
|
|
• max_height maximal height of floating window
|
|
|
|
• separator insert separator after code block
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2021-05-31 10:47:51 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`table`) stripped content
|
2021-05-31 10:47:51 -07:00
|
|
|
|
2020-07-02 04:09:17 -07:00
|
|
|
symbols_to_items({symbols}, {bufnr}) *vim.lsp.util.symbols_to_items()*
|
2020-09-06 16:55:49 -07:00
|
|
|
Converts symbols to quickfix list items.
|
2020-07-02 04:09:17 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {symbols} (`table`) DocumentSymbol[] or SymbolInformation[]
|
2024-08-11 03:58:15 -07:00
|
|
|
• {bufnr} (`integer?`)
|
2020-07-02 04:09:17 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.log *lsp-log*
|
|
|
|
|
|
|
|
get_filename() *vim.lsp.log.get_filename()*
|
|
|
|
Returns the log filename.
|
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`string`) log filename
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2021-10-05 10:48:48 -07:00
|
|
|
get_level() *vim.lsp.log.get_level()*
|
2021-11-29 20:31:19 -07:00
|
|
|
Gets the current log level.
|
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`integer`) current log level
|
2021-10-05 10:48:48 -07:00
|
|
|
|
|
|
|
set_format_func({handle}) *vim.lsp.log.set_format_func()*
|
|
|
|
Sets formatting function used to format logs
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {handle} (`function`) function to apply to logging arguments, pass
|
2022-05-12 07:02:46 -07:00
|
|
|
vim.inspect for multi-line formatting
|
2021-10-05 10:48:48 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
set_level({level}) *vim.lsp.log.set_level()*
|
|
|
|
Sets the current log level.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {level} (`string|integer`) One of `vim.lsp.log.levels`
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
should_log({level}) *vim.lsp.log.should_log()*
|
|
|
|
Checks whether the level is sufficient for logging.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {level} (`integer`) log level
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-02-15 10:16:04 -07:00
|
|
|
(`bool`) true if would log, false if not
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.rpc *lsp-rpc*
|
|
|
|
|
2024-02-27 08:20:32 -07:00
|
|
|
*vim.lsp.rpc.PublicClient*
|
|
|
|
|
|
|
|
Fields: ~
|
2024-10-03 03:45:51 -07:00
|
|
|
• {request} (`fun(method: string, params: table?, callback: fun(err: lsp.ResponseError?, result: any), notify_reply_callback: fun(message_id: integer)?):boolean,integer?`)
|
2024-02-27 08:20:32 -07:00
|
|
|
see |vim.lsp.rpc.request()|
|
|
|
|
• {notify} (`fun(method: string, params: any):boolean`) see
|
|
|
|
|vim.lsp.rpc.notify()|
|
|
|
|
• {is_closing} (`fun(): boolean`)
|
|
|
|
• {terminate} (`fun()`)
|
|
|
|
|
|
|
|
|
2024-04-18 06:34:10 -07:00
|
|
|
connect({host_or_path}, {port}) *vim.lsp.rpc.connect()*
|
|
|
|
Create a LSP RPC client factory that connects to either:
|
|
|
|
• a named pipe (windows)
|
|
|
|
• a domain socket (unix)
|
2024-09-03 08:10:39 -07:00
|
|
|
• a host and port via TCP
|
2024-01-09 16:04:27 -07:00
|
|
|
|
|
|
|
Return a function that can be passed to the `cmd` field for
|
|
|
|
|vim.lsp.start_client()| or |vim.lsp.start()|.
|
2022-08-24 11:25:34 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-09-03 08:10:39 -07:00
|
|
|
• {host_or_path} (`string`) host to connect to or path to a pipe/domain
|
|
|
|
socket
|
2024-04-18 06:34:10 -07:00
|
|
|
• {port} (`integer?`) TCP port to connect to. If absent the
|
|
|
|
first argument must be a pipe
|
2024-01-02 02:08:36 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-03-08 05:25:18 -07:00
|
|
|
(`fun(dispatchers: vim.lsp.rpc.Dispatchers): vim.lsp.rpc.PublicClient`)
|
2022-08-24 11:25:34 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
format_rpc_error({err}) *vim.lsp.rpc.format_rpc_error()*
|
|
|
|
Constructs an error message from an LSP error object.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {err} (`table`) The error object
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 16:04:27 -07:00
|
|
|
(`string`) error_message The formatted error message
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
notify({method}, {params}) *vim.lsp.rpc.notify()*
|
|
|
|
Sends a notification to the LSP server.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {method} (`string`) The invoked LSP method
|
|
|
|
• {params} (`table?`) Parameters for the invoked LSP method
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`boolean`) `true` if notification could be sent, `false` if not
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2021-11-18 14:50:55 -07:00
|
|
|
*vim.lsp.rpc.request()*
|
|
|
|
request({method}, {params}, {callback}, {notify_reply_callback})
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Sends a request to the LSP server and runs {callback} upon response.
|
2022-08-11 05:25:48 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {method} (`string`) The invoked LSP method
|
|
|
|
• {params} (`table?`) Parameters for the invoked LSP
|
2022-08-23 13:39:34 -07:00
|
|
|
method
|
2024-01-09 10:36:46 -07:00
|
|
|
• {callback} (`fun(err: lsp.ResponseError?, result: any)`)
|
|
|
|
Callback to invoke
|
2024-01-09 16:04:27 -07:00
|
|
|
• {notify_reply_callback} (`fun(message_id: integer)?`) Callback to
|
|
|
|
invoke as soon as a request is no longer
|
|
|
|
pending
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2024-01-09 16:04:27 -07:00
|
|
|
Return (multiple): ~
|
|
|
|
(`boolean`) success `true` if request could be sent, `false` if not
|
|
|
|
(`integer?`) message_id if request could be sent, `nil` if not
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
*vim.lsp.rpc.rpc_response_error()*
|
|
|
|
rpc_response_error({code}, {message}, {data})
|
2024-01-09 16:04:27 -07:00
|
|
|
Creates an RPC response table `error` to be sent to the LSP response.
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 16:04:27 -07:00
|
|
|
• {code} (`integer`) RPC error code defined, see
|
|
|
|
`vim.lsp.protocol.ErrorCodes`
|
2024-01-09 10:36:46 -07:00
|
|
|
• {message} (`string?`) arbitrary message to send to server
|
|
|
|
• {data} (`any?`) arbitrary data to send to server
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2024-01-02 02:08:36 -07:00
|
|
|
Return: ~
|
2024-01-09 16:04:27 -07:00
|
|
|
(`lsp.ResponseError`)
|
|
|
|
|
|
|
|
See also: ~
|
|
|
|
• lsp.ErrorCodes See `vim.lsp.protocol.ErrorCodes`
|
2024-01-02 02:08:36 -07:00
|
|
|
|
2024-02-11 05:37:20 -07:00
|
|
|
start({cmd}, {dispatchers}, {extra_spawn_params}) *vim.lsp.rpc.start()*
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Starts an LSP server process and create an LSP RPC client object to
|
2022-09-08 10:25:16 -07:00
|
|
|
interact with it. Communication with the spawned process happens via
|
|
|
|
stdio. For communication via TCP, spawn a process manually and use
|
2022-09-25 16:58:27 -07:00
|
|
|
|vim.lsp.rpc.connect()|
|
2022-08-11 05:25:48 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
Parameters: ~
|
2024-02-11 05:37:20 -07:00
|
|
|
• {cmd} (`string[]`) Command to start the LSP server.
|
2024-02-27 08:20:32 -07:00
|
|
|
• {dispatchers} (`table?`) Dispatchers for LSP message types.
|
2024-03-08 05:25:18 -07:00
|
|
|
• {notification}
|
|
|
|
(`fun(method: string, params: table)`)
|
|
|
|
• {server_request}
|
|
|
|
(`fun(method: string, params: table): any?, lsp.ResponseError?`)
|
|
|
|
• {on_exit}
|
|
|
|
(`fun(code: integer, signal: integer)`)
|
2024-02-27 08:20:32 -07:00
|
|
|
• {on_error} (`fun(code: integer, err: any)`)
|
|
|
|
• {extra_spawn_params} (`table?`) Additional context for the LSP server
|
|
|
|
process.
|
|
|
|
• {cwd}? (`string`) Working directory for the
|
|
|
|
LSP server process
|
|
|
|
• {detached}? (`boolean`) Detach the LSP server
|
|
|
|
process from the current process
|
|
|
|
• {env}? (`table<string,string>`) Additional
|
|
|
|
environment variables for LSP server process.
|
|
|
|
See |vim.system()|
|
2022-08-11 05:25:48 -07:00
|
|
|
|
2023-07-10 04:38:15 -07:00
|
|
|
Return: ~
|
2024-04-26 06:15:44 -07:00
|
|
|
(`vim.lsp.rpc.PublicClient`) Client RPC object, with these methods:
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
• `notify()` |vim.lsp.rpc.notify()|
|
|
|
|
• `request()` |vim.lsp.rpc.request()|
|
2022-08-30 04:14:27 -07:00
|
|
|
• `is_closing()` returns a boolean indicating if the RPC is closing.
|
2024-02-27 08:20:32 -07:00
|
|
|
• `terminate()` terminates the RPC client. See
|
|
|
|
|vim.lsp.rpc.PublicClient|.
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
|
|
|
Lua module: vim.lsp.protocol *lsp-protocol*
|
|
|
|
|
|
|
|
*vim.lsp.protocol.make_client_capabilities()*
|
|
|
|
make_client_capabilities()
|
|
|
|
Gets a new ClientCapabilities object describing the LSP client
|
|
|
|
capabilities.
|
|
|
|
|
2023-06-07 05:39:41 -07:00
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`lsp.ClientCapabilities`)
|
2023-06-07 05:39:41 -07:00
|
|
|
|
2023-07-28 00:24:18 -07:00
|
|
|
Methods *vim.lsp.protocol.Methods*
|
|
|
|
LSP method names.
|
|
|
|
|
|
|
|
See also: ~
|
2023-12-10 22:05:24 -07:00
|
|
|
• https://microsoft.github.io/language-server-protocol/specification/#metaModel
|
2023-07-28 00:24:18 -07:00
|
|
|
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
*vim.lsp.protocol.resolve_capabilities()*
|
|
|
|
resolve_capabilities({server_capabilities})
|
2021-12-08 11:01:07 -07:00
|
|
|
Creates a normalized object describing LSP server capabilities.
|
|
|
|
|
|
|
|
Parameters: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
• {server_capabilities} (`table`) Table of capabilities supported by
|
|
|
|
the server
|
2021-12-08 11:01:07 -07:00
|
|
|
|
|
|
|
Return: ~
|
2024-01-09 10:36:46 -07:00
|
|
|
(`lsp.ServerCapabilities?`) Normalized table of capabilities
|
lsp: vim.lsp.diagnostic (#12655)
Breaking Changes:
- Deprecated all `vim.lsp.util.{*diagnostics*}()` functions.
- Instead, all functions must be found in vim.lsp.diagnostic
- For now, they issue a warning ONCE per neovim session. In a
"little while" we will remove them completely.
- `vim.lsp.callbacks` has moved to `vim.lsp.handlers`.
- For a "little while" we will just redirect `vim.lsp.callbacks` to
`vim.lsp.handlers`. However, we will remove this at some point, so
it is recommended that you change all of your references to
`callbacks` into `handlers`.
- This also means that for functions like |vim.lsp.start_client()|
and similar, keyword style arguments have moved from "callbacks"
to "handlers". Once again, these are currently being forward, but
will cease to be forwarded in a "little while".
- Changed the highlight groups for LspDiagnostic highlight as they were
inconsistently named.
- For more information, see |lsp-highlight-diagnostics|
- Changed the sign group names as well, to be consistent with
|lsp-highlight-diagnostics|
General Enhancements:
- Rewrote much of the getting started help document for lsp. It also
provides a much nicer configuration strategy, so as to not recommend
globally overwriting builtin neovim mappings.
LSP Enhancements:
- Introduced the concept of |lsp-handlers| which will allow much better
customization for users without having to copy & paste entire files /
functions / etc.
Diagnostic Enhancements:
- "goto next diagnostic" |vim.lsp.diagnostic.goto_next()|
- "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()|
- For each of the gotos, auto open diagnostics is available as a
configuration option
- Configurable diagnostic handling:
- See |vim.lsp.diagnostic.on_publish_diagnostics()|
- Delay display until after insert mode
- Configure signs
- Configure virtual text
- Configure underline
- Set the location list with the buffers diagnostics.
- See |vim.lsp.diagnostic.set_loclist()|
- Better performance for getting counts and line diagnostics
- They are now cached on save, to enhance lookups.
- Particularly useful for checking in statusline, etc.
- Actual testing :)
- See ./test/functional/plugin/lsp/diagnostic_spec.lua
- Added `guisp` for underline highlighting
NOTE: "a little while" means enough time to feel like most plugins and
plugin authors have had a chance to refactor their code to use the
updated calls. Then we will remove them completely. There is no need to
keep them, because we don't have any released version of neovim that
exposes these APIs. I'm trying to be nice to people following HEAD :)
Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
2020-11-12 20:21:34 -07:00
|
|
|
|
2024-02-15 10:16:04 -07:00
|
|
|
|
2020-09-06 16:55:49 -07:00
|
|
|
vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl:
|