WIP Common configurations for Language Servers.
This repository aims to be a central location to store configurations for
Language Servers which leverage Neovim's built-in LSP client vim.lsp as the
client backbone. The vim.lsp implementation is made to be customizable and
greatly extensible, but most users just want to get up and going. This
plugin/library is for those people, although it still lets you customize
things as much as you want in addition to the defaults that this provides.
NOTE: Requires current Neovim master as of 2019-11-13
CONTRIBUTIONS ARE WELCOME!
There's a lot of language servers in the world, and not enough time. See
lua/nvim_lsp/*.lua
for examples and ask us questions in the Neovim
Gitter to help us complete configurations for
all the LSPs! Read CONTRIBUTING.md for some instructions.
If you don't know where to start, you can pick one that's not in progress or
implemented from this excellent list compiled by the coc.nvim
contributors or
this other excellent list from the emacs lsp-mode
contributors
and create a new file under lua/nvim_lsp/SERVER_NAME.lua. We recommend
looking at lua/nvim_lsp/texlab.lua for the most extensive example, but all of
them are good references.
Implemented:
Planned servers to implement (by me, but contributions welcome anyway):
In progress:
- ...
Plug 'neovim/nvim-lsp'
From vim:
call nvim_lsp#setup("texlab", {})From Lua:
require 'nvim_lsp'.texlab.setup {
name = "texlab_fancy";
log_level = vim.lsp.protocol.MessageType.Log;
settings = {
latex = {
build = {
onSave = true;
}
}
}
}
local nvim_lsp = require 'nvim_lsp'
-- Customize how to find the root_dir
nvim_lsp.gopls.setup {
root_dir = nvim_lsp.util.root_pattern(".git");
}
-- Build the current buffer.
require 'nvim_lsp'.texlab.buf_build(0)These are functions to set up servers more easily with some server specific defaults and more server specific things like commands or different diagnostics.
Servers may define extra functions on the nvim_lsp.SERVER table, e.g.
nvim_lsp.texlab.buf_build({bufnr}).
The main setup signature will be:
nvim_lsp.SERVER.setup({config})
{config} is the same as |vim.lsp.start_client()|, but with some
additions and changes:
{root_dir}
May be required (depending on the server).
`function(filename, bufnr)` which is called on new candidate buffers to
attach to and returns either a root_dir or nil.
If a root_dir is returned, then this file will also be attached. You
can optionally use {filetype} to help pre-filter by filetype.
If a root_dir is returned which is unique from any previously returned
root_dir, a new server will be spawned with that root_dir.
If nil is returned, the buffer is skipped.
See |nvim_lsp.util.search_ancestors()| and the functions which use it:
- |nvim_lsp.util.root_pattern(patterns...)| finds an ancestor which
- contains one of the files in `patterns...`. This is equivalent
to coc.nvim's "rootPatterns"
- More specific utilities:
- |nvim_lsp.util.find_git_root()|
- |nvim_lsp.util.find_node_modules_root()|
- |nvim_lsp.util.find_package_json_root()|
{name}
Defaults to the server's name.
{filetypes}
A set of filetypes to filter for consideration by {root_dir}.
Can be left empty.
A server may specify a default value.
{log_level}
controls the level of logs to show from build processes and other
window/logMessage events. By default it is set to
vim.lsp.protocol.MessageType.Warning instead of
vim.lsp.protocol.MessageType.Log.
{settings}
This is a table, and the keys are case sensitive. This is for the
window/configuration event responses.
Example: `settings = { keyName = { subKey = 1 } }`
{on_attach}
`function(client)` will be executed with the current buffer as the
one the {client} is being attaching to. This is different from
|vim.lsp.start_client()|'s on_attach parameter, which passes the {bufnr} as
the second parameter instead. This is useful for running buffer local
commands.
{on_new_config}
`function(new_config)` will be executed after a new configuration has been
created as a result of {root_dir} returning a unique value. You can use this
as an opportunity to further modify the new_config or use it before it is
sent to |vim.lsp.start_client()|.
https://clang.llvm.org/extra/clangd/Installation.html
clangd relies on a JSON compilation database specified as compile_commands.json or, for simpler projects, a compile_flags.txt.
nvim_lsp.clangd.setup({config})
nvim_lsp#setup("clangd", {config})
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "clangd", "--background-index" }
filetypes = { "c", "cpp", "objc", "objcpp" }
log_level = 2
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("compile_commands.json", "compile_flags.txt", ".git")
settings = {}https://github.com/elm-tooling/elm-language-server#installation
You can install elmls automatically to the path at
stdpath("cache")/nvim_lsp/elmls
by using the function nvim_lsp.elmls.install() or the command :ElmlsInstall.
This will only install if it can't find elm-language-server and if it hasn't
been installed before by neovim.
You can see installation info via :ElmlsInstallInfo or via
nvim_lsp.elmls.get_install_info(). This will let you know if it is installed.
If you don't want to use neovim to install it, then you can use:
npm install -g elm elm-test elm-format @elm-tooling/elm-language-servernvim_lsp.elmls.setup({config})
nvim_lsp#setup("elmls", {config})
Commands:
- ElmlsInstall: Install elmls and its dependencies to stdpath("cache")/nvim_lsp/elmls
- ElmlsInstallInfo: Print installation info for `elmls`
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "elm-language-server" }
filetypes = { "elm" }
init_options = {
elmAnalyseTrigger = "change",
elmFormatPath = "elm-format",
elmPath = "elm",
elmTestPath = "elm-test"
}
log_level = 2
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("elm.json")
settings = {}https://github.com/golang/tools/tree/master/gopls
Google's lsp server for golang.
nvim_lsp.gopls.setup({config})
nvim_lsp#setup("gopls", {config})
Default Values:
cmd = { "gopls" }
filetypes = { "go" }
log_level = 2
root_dir = root_pattern("go.mod", ".git")
settings = {}https://github.com/palantir/python-language-server
python-language-server, a language server for Python
the following settings (with default options) are supported:
settings = {
pyls = {
enable = true;
trace = { server = "verbose"; };
commandPath = "";
configurationSources = { "pycodestyle" };
plugins = {
jedi_completion = { enabled = true; };
jedi_hover = { enabled = true; };
jedi_references = { enabled = true; };
jedi_signature_help = { enabled = true; };
jedi_symbols = {
enabled = true;
all_scopes = true;
};
mccabe = {
enabled = true;
threshold = 15;
};
preload = { enabled = true; };
pycodestyle = { enabled = true; };
pydocstyle = {
enabled = false;
match = "(?!test_).*\\.py";
matchDir = "[^\\.].*";
};
pyflakes = { enabled = true; };
rope_completion = { enabled = true; };
yapf = { enabled = true; };
};
};
};nvim_lsp.pyls.setup({config})
nvim_lsp#setup("pyls", {config})
Default Values:
cmd = { "pyls" }
filetypes = { "python" }
log_level = 2
root_dir = vim's starting directory
settings = {}A completion engine built from scratch for (la)tex.
nvim_lsp.texlab.setup({config})
nvim_lsp#setup("texlab", {config})
Commands:
- TexlabBuild: Build the current buffer
Default Values:
cmd = { "texlab" }
filetypes = { "tex", "bib" }
log_level = 2
root_dir = vim's starting directory
settings = {
latex = {
build = {
args = { "-pdf", "-interaction=nonstopmode", "-synctex=1" },
executable = "latexmk",
onSave = false
}
}
}