↓Skip to main content

Neovim lsp

·2 mins

Brief guide to neovim LSP server configuration

Language server protocol recap #

it’s a standard protocol to manage interaction between code editors and process providing code completion and syntax highlighting

flowchart LR subgraph editors direction TB A[vim] B[nvim] C[vscode] end subgraph language_servers direction TB D[C] E[ansiblels] F[dockerls] end editors --send file content--> language_servers language_servers --code completition--> editors

Neovim provides integrated support as it feature a builtin LSP client, in my personal configuration this plugins are also enabled to improve the LSP management experience

Add a language server #

Language servers needs to be installed with mason and then activated with lspconfig then when the correspondent filetype is detected lspconfig will start the server and attach the client to it for the active buffer

:MasonInstall
:lua require("lspconfig").hyprls.setup{}

To check if a language server is running correctly run :LspInfo

lspconfig: require("lspconfig.health").check()

LSP configs active in this session (globally)
- Configured servers: lua_ls, ansiblels, gopls, pyright, bashls, terraformls, docker_compose_language_service, dockerls, eslint
- OK Deprecated servers: (none)

LSP configs active in this buffer (bufnr: 1)
- Language client log: ~/.local/state/nvim/lsp.log
- Detected filetype: yaml
- 0 client(s) attached to this buffer

Docs for active configs:

Setting filetype #

In order to limit a language server to a specific set of files (e.g. ansiblels) configure lspconfig to run the LSP server on a specific filetype (ansible) and configure neovim to set the filetype for the specific set of file

-- in nvim filetypes configuration
vim.filetype.add({pattern = { [".*/playbooks/.*%.yml"] = "ansible" },})
vim.filetype.add({pattern = { [".*/playbooks/.*%.yaml"] = "ansible" },})
vim.filetype.add({pattern = { [".*/roles/.*%.yml"] = "ansible" },})
vim.filetype.add({pattern = { [".*/roles/.*%.yaml"] = "ansible" },})

-- in the lspconfig file
-------------------------------------
require('lspconfig').ansiblels.setup{
	filetypes ={"ansible"};
}
------------------------------------

The pattern objects requires a lua pattern as argument