nvim-lsp
Collection of common configurations for the Nvim LSP client.
It is hoped that these configurations serve as a "source of truth", but they are strictly best effort. If something doesn't work, these configs are useful as a starting point, which you can adjust to fit your environment.
This is work-in-progress and requires Nvim HEAD/nightly. Update Nvim and nvim-lsp before reporting an issue.
Contributions are welcome!
There are many language servers in the world, and not enough time. Help us create configs for all the LSPs!
- Read CONTRIBUTING.md for instructions. Ask questions in Neovim Gitter.
- Choose a language from the coc.nvim wiki or the emacs-lsp project.
- Create a new file at
lua/nvim_lsp/SERVER_NAME.lua. See existing configs for examples (lua/nvim_lsp/texlab.luais an extensive example).
Install
- Requires Nvim HEAD/nightly (v0.5 prerelease).
- nvim-lsp is just a plugin. Install it like any other Vim plugin.
:Plug 'neovim/nvim-lsp' - Call
:packadd nvim-lspin your vimrc if you installed nvim-lsp to'packpath'or if you use a package manager such as minpac.
Usage
Each config provides a setup() function, to initialize the server with
reasonable defaults and some server-specific things like commands or different
diagnostics.
vim.cmd('packadd nvim-lsp')
require'nvim_lsp'.<config>.setup{name=…, settings = {…}, …}
Find the config for your language, then paste the example
given there to your init.vim. All examples are given in Lua, see :help :lua-heredoc to use Lua from your init.vim.
Some configs may define additional server-specific functions, e.g. the texlab
config provides nvim_lsp.texlab.buf_build({bufnr}).
Example: using the defaults
To use the defaults, just call setup() with an empty config parameter.
For the gopls config, that would be:
vim.cmd('packadd nvim-lsp')
require'nvim_lsp'.gopls.setup{}
Example: override some defaults
To set some config properties at setup(), specify their keys. For example to
change how the "project root" is found, set the root_dir key:
local nvim_lsp = require'nvim_lsp'
nvim_lsp.gopls.setup{
root_dir = nvim_lsp.util.root_pattern('.git');
}The documentation for each config lists default values and additional optional properties.
local nvim_lsp = require'nvim_lsp'
nvim_lsp.texlab.setup{
name = 'texlab_fancy';
log_level = vim.lsp.protocol.MessageType.Log;
settings = {
latex = {
build = {
onSave = true;
}
}
}
}Example: custom config
To configure a custom/private server, just require nvim_lsp/configs and do
the same as we do if we were adding it to the repository itself.
- Define the config:
configs.foo_lsp = { … } - Call
setup():require'nvim_lsp'.foo_lsp.setup{}
local nvim_lsp = require'nvim_lsp'
local configs = require'nvim_lsp/configs'
-- Check if it's already defined for when I reload this file.
if not nvim_lsp.foo_lsp then
configs.foo_lsp = {
default_config = {
cmd = {'/home/ashkan/works/3rd/lua-language-server/run.sh'};
filetypes = {'lua'};
root_dir = function(fname)
return nvim_lsp.util.find_git_ancestor(fname) or vim.loop.os_homedir()
end;
log_level = vim.lsp.protocol.MessageType.Warning;
settings = {};
};
}
end
nvim_lsp.foo_lsp.setup{}Installing a language server
Configs may provide an install() function. Then you can use
:LspInstall {name} to install the required language server.
For example, to install the Elm language server:
:LspInstall elmls
Use :LspInstallInfo to see install info.
:LspInstallInfo
setup() function
The setup() interface:
nvim_lsp.SERVER.setup{config}
The `config` parameter has the same shape as that of
|vim.lsp.start_client()|, with these additions and changes:
{root_dir}
Required for some servers, optional for others.
Function of the form `function(filename, bufnr)`.
Called on new candidate buffers being attached-to.
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"
- Related utilities for common tools:
- |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}
Set of filetypes to filter for consideration by {root_dir}.
May be empty.
Server may specify a default value.
{log_level}
controls the level of logs to show from build processes and other
window/logMessage events. Defaults to
vim.lsp.protocol.MessageType.Warning instead of
vim.lsp.protocol.MessageType.Log.
{settings}
Map with case-sensitive keys corresponding to `workspace/configuration`
event responses.
We also notify the server *once* on `initialize` with
`workspace/didChangeConfiguration`.
If you change the settings later on, you must emit the notification
with `client.workspace_did_change_configuration({settings})`
Example: `settings = { keyName = { subKey = 1 } }`
{on_attach}
`function(client)` executed with the current buffer as the one the {client}
is being attached-to. This is different from
|vim.lsp.start_client()|'s on_attach parameter, which passes the {bufnr} as
the second parameter instead. Useful for doing buffer-local setup.
{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()|.
Configurations
The following LSP configs are included. Follow a link to find documentation for that config.
- bashls
- ccls
- clangd
- cssls
- dockerls
- elmls
- flow
- fortls
- ghcide
- gopls
- hie
- intelephense
- jsonls
- leanls
- metals
- ocamlls
- pyls
- pyls_ms
- rls
- rust_analyzer
- solargraph
- sumneko_lua
- terraformls
- texlab
- tsserver
- vimls
- yamlls
bashls
https://github.com/mads-hartmann/bash-language-server
Language server for bash, written using tree sitter in typescript.
Can be installed in Nvim with :LspInstall bashls
require'nvim_lsp'.bashls.setup{}
Default Values:
cmd = { "bash-language-server", "start" }
filetypes = { "sh" }
log_level = 2
root_dir = vim's starting directory
settings = {}ccls
https://github.com/MaskRay/ccls/wiki
ccls relies on a JSON compilation database specified as compile_commands.json or, for simpler projects, a compile_flags.txt.
This server accepts configuration via the settings key.
Available settings:
-
ccls.cache.directory:stringDefault:
".ccls-cache"Absolute or relative (from the project root) path to the directory that the cached index will be stored in. Try to have this directory on an SSD. If empty, cached indexes will not be saved on disk.
${workspaceFolder} will be replaced by the folder where .vscode/settings.json resides.
Cache directories are project-wide, so this should be configured in the workspace settings so multiple indexes do not clash.
Example value: "/work/ccls-cache/chrome/"
-
ccls.cache.hierarchicalPath:booleanIf false, store cache files as $directory/@a@b/c.cc.blob
If true, $directory/a/b/c.cc.blob.
-
ccls.callHierarchy.qualified:booleanDefault:
trueIf true, use qualified names in the call hiearchy
-
ccls.clang.excludeArgs:arrayDefault:
{}An set of command line arguments to strip before passing to clang when indexing. Each list entry is a separate argument.
-
ccls.clang.extraArgs:arrayDefault:
{}An extra set of command line arguments to give clang when indexing. Each list entry is a separate argument.
-
ccls.clang.pathMappings:arrayDefault:
{}Translate paths in compile_commands.json entries, .ccls options and cache files. This allows to reuse cache files built otherwhere if the source paths are different.
-
ccls.clang.resourceDir:stringDefault:
""Default value to use for clang -resource-dir argument. This will be automatically supplied by ccls if not provided.
-
ccls.codeLens.enabled:booleanDefault:
trueSpecifies whether the references CodeLens should be shown.
-
ccls.codeLens.localVariables:booleanSet to false to hide code lens on parameters and function local variables.
-
ccls.codeLens.renderInline:booleanEnables a custom code lens renderer so code lens are displayed inline with code. This removes any vertical-space footprint at the cost of horizontal space.
-
ccls.completion.caseSensitivity:integerDefault:
2Case sensitivity when code completion is filtered. 0: case-insensitive, 1: case-folded, i.e. insensitive if no input character is uppercase, 2: case-sensitive
-
ccls.completion.detailedLabel:booleanWhen this option is enabled, the completion item label is very detailed, it shows the full signature of the candidate.
-
ccls.completion.duplicateOptional:booleanFor functions with default arguments, generate one more item per default argument.
-
ccls.completion.enableSnippetInsertion:booleanIf true, parameter declarations are inserted as snippets in function/method call arguments when completing a function/method call
-
ccls.completion.include.blacklist:arrayDefault:
{}ECMAScript regex that checks absolute path. If it partially matches, the file is not added to include path auto-complete. An example is "/CACHE/"
-
ccls.completion.include.maxPathSize:integerDefault:
37Maximum length for path in #include proposals. If the path length goes beyond this number it will be elided. Set to 0 to always display the full path.
-
ccls.completion.include.suffixWhitelist:arrayDefault:
{ ".h", ".hpp", ".hh" }Only files ending in one of these values will be shown in include auto-complete. Set to the empty-list to disable include auto-complete.
-
ccls.completion.include.whitelist:arrayDefault:
{}ECMAScript regex that checks absolute file path. If it does not partially match, the file is not added to include path auto-complete. An example is "/src/"
-
ccls.diagnostics.blacklist:arrayDefault:
{}Files that match these patterns won't be displayed in diagnostics view.
-
ccls.diagnostics.onChange:integerDefault:
1000Time in milliseconds to wait before computing diagnostics on type. -1: disable diagnostics on type.
-
ccls.diagnostics.onOpen:integerDefault:
0Time in milliseconds to wait before computing diagnostics when a file is opened.
-
ccls.diagnostics.onSave:integerDefault:
0Time in milliseconds to wait before computing diagnostics when a file is saved.
-
ccls.diagnostics.spellChecking:booleanDefault:
trueWhether to do spell checking on undefined symbol names when computing diagnostics.
-
ccls.diagnostics.whitelist:arrayDefault:
{}Files that match these patterns will be displayed in diagnostics view.
-
ccls.highlight.blacklist:array|nullDefault:
vim.NILFiles that match these patterns won't have semantic highlight.
-
ccls.highlight.enum.face:arrayDefault:
{ "variable", "member" } -
ccls.highlight.function.colors:arrayDefault:
{ "#e5b124", "#927754", "#eb992c", "#e2bf8f", "#d67c17", "#88651e", "#e4b953", "#a36526", "#b28927", "#d69855" }Colors to use for semantic highlight. A good generator is http://tools.medialab.sciences-po.fr/iwanthue/. If multiple colors are specified, semantic highlight will cycle through them for successive symbols.
-
ccls.highlight.function.face:arrayDefault:
{} -
ccls.highlight.global.face:arrayDefault:
{ "fontWeight: bolder" } -
ccls.highlight.globalVariable.face:arrayDefault:
{ "variable", "global" } -
ccls.highlight.largeFileSize:integer|nullDefault:
vim.NILDisable semantic highlight for files larger than the size.
-
ccls.highlight.macro.colors:arrayDefault:
{ "#e79528", "#c5373d", "#e8a272", "#d84f2b", "#a67245", "#e27a33", "#9b4a31", "#b66a1e", "#e27a71", "#cf6d49" }Colors to use for semantic highlight. A good generator is http://tools.medialab.sciences-po.fr/iwanthue/. If multiple colors are specified, semantic highlight will cycle through them for successive symbols.
-
ccls.highlight.macro.face:arrayDefault:
{ "variable" } -
ccls.highlight.member.face:arrayDefault:
{ "fontStyle: italic" } -
ccls.highlight.memberFunction.face:arrayDefault:
{ "function", "member" } -
ccls.highlight.memberVariable.face:arrayDefault:
{ "variable", "member" } -
ccls.highlight.namespace.colors:arrayDefault:
{ "#429921", "#58c1a4", "#5ec648", "#36815b", "#83c65d", "#417b2f", "#43cc71", "#7eb769", "#58bf89", "#3e9f4a" }Colors to use for semantic highlight. A good generator is http://tools.medialab.sciences-po.fr/iwanthue/. If multiple colors are specified, semantic highlight will cycle through them for successive symbols.
-
ccls.highlight.namespace.face:arrayDefault:
{ "type" } -
ccls.highlight.parameter.face:arrayDefault:
{ "variable" } -
ccls.highlight.static.face:arrayDefault:
{ "fontWeight: bold" } -
ccls.highlight.staticMemberFunction.face:arrayDefault:
{ "function", "static" } -
ccls.highlight.staticMemberVariable.face:arrayDefault:
{ "variable", "static" } -
ccls.highlight.staticVariable.face:arrayDefault:
{ "variable", "static" } -
ccls.highlight.type.colors:arrayDefault:
{ "#e1afc3", "#d533bb", "#9b677f", "#e350b6", "#a04360", "#dd82bc", "#de3864", "#ad3f87", "#dd7a90", "#e0438a" }Colors to use for semantic highlight. A good generator is http://tools.medialab.sciences-po.fr/iwanthue/. If multiple colors are specified, semantic highlight will cycle through them for successive symbols.
-
ccls.highlight.type.face:arrayDefault:
{} -
ccls.highlight.typeAlias.face:arrayDefault:
{ "type" } -
ccls.highlight.variable.colors:arrayDefault:
{ "#587d87", "#26cdca", "#397797", "#57c2cc", "#306b72", "#6cbcdf", "#368896", "#3ea0d2", "#48a5af", "#7ca6b7" }Colors to use for semantic highlight. A good generator is http://tools.medialab.sciences-po.fr/iwanthue/. If multiple colors are specified, semantic highlight will cycle through them for successive symbols.
-
ccls.highlight.variable.face:arrayDefault:
{} -
ccls.highlight.whitelist:array|nullDefault:
vim.NILFiles that match these patterns will have semantic highlight.
-
ccls.index.blacklist:arrayDefault:
{}A translation unit (cc/cpp file) is not indexed if any of the ECMAScript regexes in this list partially matches translation unit's the absolute path.
-
ccls.index.initialBlacklist:arrayDefault:
{}Files matched by the regexes should not be indexed on initialization. Indexing is deferred to when they are opened.
-
ccls.index.initialWhitelist:arrayDefault:
{}Files matched by the regexes should be indexed on initialization.
-
ccls.index.maxInitializerLines:integerDefault:
15Number of lines of the initializer / macro definition showed in hover.
-
ccls.index.multiVersion:integerDefault:
0If not 0, a file will be indexed in each tranlation unit that includes it.
-
ccls.index.onChange:booleanAllow indexing on textDocument/didChange. May be too slow for big projects, so it is off by default.
-
ccls.index.threads:numberDefault:
0Number of indexer threads. If 0, 80% of cores are used.
-
ccls.index.trackDependency:integerDefault:
2Whether to reparse a file if write times of its dependencies have changed. The file will always be reparsed if its own write time changes.
0: no, 1: only during initial load of project, 2: yes
-
ccls.index.whitelist:arrayDefault:
{}If a translation unit's absolute path partially matches any ECMAScript regex in this list, it will be indexed. The whitelist takes priority over the blacklist. To only index files in the whitelist, make "ccls.index.blacklist" match everything, ie, set it to ".*".
-
ccls.launch.args:arrayDefault:
{}Array containing extra arguments to pass to the ccls binary
-
ccls.launch.command:stringDefault:
"ccls"Path to the ccls binary (default assumes the binary is in the PATH)
-
ccls.misc.compilationDatabaseCommand:stringDefault:
""If not empty, the compilation database command to use
-
ccls.misc.compilationDatabaseDirectory:stringDefault:
""If not empty, the compilation database directory to use instead of the project root
-
ccls.misc.showInactiveRegions:booleanDefault:
trueIf true, ccls will highlight skipped ranges.
-
ccls.statusUpdateInterval:integerDefault:
2000Interval between updating ccls status in milliseconds. Set to 0 to disable.
-
ccls.theme.dark.skippedRange.backgroundColor:stringDefault:
"rgba(18, 18, 18, 0.3)"CSS color to apply to the background when the code region has been disabled by the preprocessor in a dark theme.
-
ccls.theme.dark.skippedRange.textColor:stringDefault:
"rgb(100, 100, 100)"CSS color to apply to text when the code region has been disabled by the preprocessor in a dark theme.
-
ccls.theme.light.skippedRange.backgroundColor:stringDefault:
"rgba(220, 220, 220, 0.3)"CSS color to apply to the background when the code region has been disabled by the preprocessor in a light theme.
-
ccls.theme.light.skippedRange.textColor:stringDefault:
"rgb(100, 100, 100)"CSS color to apply to text when the code region has been disabled by the preprocessor in a light theme.
-
ccls.trace.websocketEndpointUrl:stringDefault:
""When set, logs all LSP messages to specified WebSocket endpoint.
-
ccls.treeViews.doubleClickTimeoutMs:numberDefault:
500If a tree view entry is double-clicked within this timeout value, vscode will navigate to the entry.
-
ccls.workspaceSymbol.caseSensitivity:integerDefault:
1Case sensitivity when searching workspace symbols. 0: case-insensitive, 1: case-folded, i.e. insensitive if no input character is uppercase, 2: case-sensitive
-
ccls.workspaceSymbol.maxNum:number|nullDefault:
vim.NILThe maximum number of global search (ie, Ctrl+P + #foo) search results to report. For small search strings on large projects there can be a massive number of results (ie, over 1,000,000) so this limit is important to avoid extremely long delays. null means use the default value provided by the ccls language server.
require'nvim_lsp'.ccls.setup{}
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "ccls" }
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 = {}clangd
https://clang.llvm.org/extra/clangd/Installation.html
NOTE: Clang >= 9 is recommended! See this issue for more.
clangd relies on a JSON compilation database specified as compile_commands.json or, for simpler projects, a compile_flags.txt.
require'nvim_lsp'.clangd.setup{}
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") or cwd
settings = {}cssls
https://github.com/vscode-langservers/vscode-css-languageserver-bin
css-languageserver can be installed via :LspInstall cssls or by yourself with npm:
npm install -g vscode-css-languageserver-binCan be installed in Nvim with :LspInstall cssls
require'nvim_lsp'.cssls.setup{}
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "css-languageserver", "--stdio" }
filetypes = { "css", "scss", "less" }
log_level = 2
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("package.json")
settings = {
css = {
validate = true
},
less = {
validate = true
},
scss = {
validate = true
}
}dockerls
https://github.com/rcjsuen/dockerfile-language-server-nodejs
docker-langserver can be installed via :LspInstall dockerls or by yourself with npm:
npm install -g dockerfile-language-server-nodejsCan be installed in Nvim with :LspInstall dockerls
require'nvim_lsp'.dockerls.setup{}
Default Values:
cmd = { "docker-langserver", "--stdio" }
filetypes = { "Dockerfile", "dockerfile" }
log_level = 2
root_dir = root_pattern("Dockerfile")
settings = {}elmls
https://github.com/elm-tooling/elm-language-server#installation
If you don't want to use Nvim to install it, then you can use:
npm install -g elm elm-test elm-format @elm-tooling/elm-language-serverCan be installed in Nvim with :LspInstall elmls
This server accepts configuration via the settings key.
Available settings:
-
elmLS.elmAnalyseTrigger:enum { "change", "save", "never" }Default:
"change"When do you want the extension to run elm-analyse? Might need a restart to take effect.
-
elmLS.elmFormatPath:stringDefault:
""The path to your elm-format executable. Should be empty by default, in that case it will assume the name and try to first get it from a local npm installation or a global one. If you set it manually it will not try to load from the npm folder.
-
elmLS.elmPath:stringDefault:
""The path to your elm executable. Should be empty by default, in that case it will assume the name and try to first get it from a local npm installation or a global one. If you set it manually it will not try to load from the npm folder.
-
elmLS.elmTestPath:stringDefault:
""The path to your elm-test executable. Should be empty by default, in that case it will assume the name and try to first get it from a local npm installation or a global one. If you set it manually it will not try to load from the npm folder.
-
elmLS.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VS Code and the language server.
require'nvim_lsp'.elmls.setup{}
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 = {}flow
https://flow.org/ https://github.com/facebook/flow
See below for how to setup Flow itself. https://flow.org/en/docs/install/
See below for lsp command options.
npm run flow lsp -- --helpThis server accepts configuration via the settings key.
Available settings:
-
flow.coverageSeverity:enum { "error", "warn", "info" }Default:
"info"Type coverage diagnostic severity
-
flow.enabled:booleanDefault:
trueIs flow enabled
-
flow.fileExtensions:arrayDefault:
{ ".js", ".mjs", ".jsx", ".flow", ".json" }Array items:
{type = "string"}(Supported only when useLSP: false). File extensions to consider for flow processing
-
flow.lazyMode:stringDefault:
vim.NILSet value to enable flow lazy mode
-
flow.logLevel:enum { "error", "warn", "info", "trace" }Default:
"info"Log level for output panel logs
-
flow.pathToFlow:stringDefault:
"flow"Absolute path to flow binary. Special var ${workspaceFolder} or ${flowconfigDir} can be used in path (NOTE: in windows you can use '/' and can omit '.cmd' in path)
-
flow.runOnAllFiles:boolean(Supported only when useLSP: false) Run Flow on all files, No need to put //@flow comment on top of files.
-
flow.runOnEdit:booleanDefault:
trueIf true will run flow on every edit, otherwise will run only when changes are saved (Note: 'useLSP: true' only supports syntax errors)
-
flow.showStatus:booleanDefault:
true(Supported only when useLSP: false) If true will display flow status is the statusbar
-
flow.showUncovered:booleanIf true will show uncovered code by default
-
flow.stopFlowOnExit:booleanDefault:
trueStop Flow on Exit
-
flow.trace.serverDefault:
"off"Traces the communication between VSCode and the flow lsp service.
-
flow.useBundledFlow:booleanDefault:
trueIf true will use flow bundled with this plugin if nothing works
-
flow.useCodeSnippetOnFunctionSuggest:booleanDefault:
trueComplete functions with their parameter signature.
-
flow.useLSP:booleanDefault:
trueTurn off to switch from the official Flow Language Server implementation to talking directly to flow.
-
flow.useNPMPackagedFlow:booleanDefault:
trueSupport using flow through your node_modules folder, WARNING: Checking this box is a security risk. When you open a project we will immediately run code contained within it.
require'nvim_lsp'.flow.setup{}
Default Values:
cmd = { "npm", "run", "flow", "lsp" }
filetypes = { "javascript", "javascriptreact", "javascript.jsx" }
log_level = 2
root_dir = root_pattern(".flowconfig")
settings = {}fortls
https://github.com/hansec/fortran-language-server
Fortran Language Server for the Language Server Protocol
This server accepts configuration via the settings key.
Available settings:
-
fortran-ls.autocompletePrefix:booleanFilter autocomplete suggestions with variable prefix
-
fortran-ls.displayVerWarning:booleanDefault:
trueProvides notifications when the underlying language server is out of date.
-
fortran-ls.enableCodeActions:booleanEnable experimental code actions (requires v1.7.0+).
-
fortran-ls.executablePath:stringDefault:
"fortls"Path to the Fortran language server (fortls).
-
fortran-ls.hoverSignature:booleanShow signature information in hover for argument (also enables 'variableHover').
-
fortran-ls.includeSymbolMem:booleanDefault:
trueInclude type members in document outline (also used for 'Go to Symbol in File')
-
fortran-ls.incrementalSync:booleanDefault:
trueUse incremental synchronization for file changes.
-
fortran-ls.lowercaseIntrinsics:booleanUse lowercase for intrinsics and keywords in autocomplete requests.
-
fortran-ls.maxCommentLineLength:numberDefault:
-1Maximum comment line length (requires v1.8.0+).
-
fortran-ls.maxLineLength:numberDefault:
-1Maximum line length (requires v1.8.0+).
-
fortran-ls.notifyInit:booleanNotify when workspace initialization is complete (requires v1.7.0+).
-
fortran-ls.useSignatureHelp:booleanDefault:
trueUse signature help instead of snippets when available.
-
fortran-ls.variableHover:booleanShow hover information for variables.
require'nvim_lsp'.fortls.setup{}
Default Values:
cmd = { "fortls" }
filetypes = { "fortran" }
log_level = 2
root_dir = root_pattern(".fortls")
settings = {
nthreads = 1
}ghcide
https://github.com/digital-asset/ghcide
A library for building Haskell IDE tooling.
This server accepts configuration via the settings key.
Available settings:
-
hic.arguments:stringDefault:
"--lsp"The arguments you would like to pass to the executable
-
hic.executablePath:stringDefault:
"ghcide"The location of your ghcide executable
require'nvim_lsp'.ghcide.setup{}
Default Values:
cmd = { "ghcide", "--lsp" }
filetypes = { "haskell", "lhaskell" }
log_level = 2
root_dir = root_pattern("stack.yaml", "hie-bios", "BUILD.bazel", "cabal.config", "package.yaml")
settings = {}gopls
https://github.com/golang/tools/tree/master/gopls
Google's lsp server for golang.
require'nvim_lsp'.gopls.setup{}
Default Values:
cmd = { "gopls" }
filetypes = { "go" }
log_level = 2
root_dir = root_pattern("go.mod", ".git")
settings = {}hie
https://github.com/haskell/haskell-ide-engine
the following init_options are supported (see https://github.com/haskell/haskell-ide-engine#configuration):
init_options = {
languageServerHaskell = {
hlintOn = bool;
maxNumberOfProblems = number;
diagnosticsDebounceDuration = number;
liquidOn = bool (default false);
completionSnippetsOn = bool (default true);
formatOnImportOn = bool (default true);
formattingProvider = string (default "brittany", alternate "floskell");
}
}This server accepts configuration via the settings key.
Available settings:
-
languageServerHaskell.completionSnippetsOn:booleanDefault:
trueShow snippets with type information when using code completion
-
languageServerHaskell.diagnosticsOnChange:booleanDefault:
trueCompute diagnostics continuously as you type. Turn off to only generate diagnostics on file save.
-
languageServerHaskell.enableHIE:booleanDefault:
trueEnable/disable HIE (useful for multi-root workspaces).
-
languageServerHaskell.formatOnImportOn:booleanDefault:
trueWhen adding an import, use the formatter on the result
-
languageServerHaskell.formattingProvider:enum { "brittany", "floskell", "none" }Default:
"brittany"The tool to use for formatting requests.
-
languageServerHaskell.hieExecutablePath:stringDefault:
""Set the path to your hie executable, if it's not already on your $PATH. Works with ~, ${HOME} and ${workspaceFolder}.
-
languageServerHaskell.hlintOn:booleanDefault:
trueGet suggestions from hlint
-
languageServerHaskell.liquidOn:booleanGet diagnostics from liquid haskell
-
languageServerHaskell.logFile:stringDefault:
""If set, redirects the logs to a file.
-
languageServerHaskell.maxNumberOfProblems:numberDefault:
100Controls the maximum number of problems produced by the server.
-
languageServerHaskell.noLspParam:booleanDo not set the '--lsp' flag in the hie/hie-wrapper arguments when launching it
-
languageServerHaskell.showTypeForSelection.command.location:enum { "dropdown", "channel" }Default:
"dropdown"Determines where the type information for selected text will be shown when the
showTypecommand is triggered (distinct from automatically showing this information when hover is triggered). dropdown: in a dropdown channel: will be revealed in an output channel -
languageServerHaskell.showTypeForSelection.onHover:booleanDefault:
trueIf true, when an expression is selected, the hover tooltip will attempt to display the type of the entire expression - rather than just the term under the cursor.
-
languageServerHaskell.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VSCode and the languageServerHaskell service.
-
languageServerHaskell.useCustomHieWrapper:booleanUse your own custom wrapper for hie (remember to specify the path!). This will take precedence over useHieWrapper and hieExecutablePath.
-
languageServerHaskell.useCustomHieWrapperPath:stringDefault:
""Specify the full path to your own custom hie wrapper (e.g. ${HOME}/.hie-wrapper.sh). Works with ~, ${HOME} and ${workspaceFolder}.
require'nvim_lsp'.hie.setup{}
Default Values:
cmd = { "hie-wrapper" }
filetypes = { "haskell" }
log_level = 2
root_dir = root_pattern("stack.yaml", "package.yaml", ".git")
settings = {}intelephense
intelephense can be installed via :LspInstall intelephense or by yourself with npm:
npm install -g intelephenseCan be installed in Nvim with :LspInstall intelephense
require'nvim_lsp'.intelephense.setup{}
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "intelephense", "--stdio" }
filetypes = { "php" }
log_level = 2
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("composer.json", ".git")jsonls
https://github.com/vscode-langservers/vscode-json-languageserver
vscode-json-languageserver, a language server for JSON and JSON schema
vscode-json-languageserver can be installed via :LspInstall jsonls or by yourself with npm:
npm install -g vscode-json-languageserverCan be installed in Nvim with :LspInstall jsonls
This server accepts configuration via the settings key.
Available settings:
-
json.colorDecorators.enable:booleanDefault:
true%json.colorDecorators.enable.desc%
-
json.format.enable:booleanDefault:
true%json.format.enable.desc%
-
json.maxItemsComputed:numberDefault:
5000%json.maxItemsComputed.desc%
-
json.schemas:arrayArray items:
{default = {fileMatch = { "/myfile" },url = "schemaURL"},properties = {fileMatch = {description = "%json.schemas.fileMatch.desc%",items = {default = "MyFile.json",description = "%json.schemas.fileMatch.item.desc%",type = "string"},minItems = 1,type = "array"},schema = {["$ref"] = "http://json-schema.org/draft-07/schema#",description = "%json.schemas.schema.desc%"},url = {default = "/user.schema.json",description = "%json.schemas.url.desc%",type = "string"}},type = "object"}%json.schemas.desc%
-
json.trace.server:enum { "off", "messages", "verbose" }Default:
"off"%json.tracing.desc%
require'nvim_lsp'.jsonls.setup{}
Default Values:
capabilities = {
offsetEncoding = { "utf-8", "utf-16" },
textDocument = {
completion = {
completionItem = {
commitCharactersSupport = false,
deprecatedSupport = false,
documentationFormat = { "markdown", "plaintext" },
preselectSupport = false,
snippetSupport = false
},
completionItemKind = {
valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 }
},
contextSupport = false,
dynamicRegistration = false
},
documentHighlight = {
dynamicRegistration = false
},
hover = {
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
references = {
dynamicRegistration = false
},
signatureHelp = {
dynamicRegistration = false,
signatureInformation = {
documentationFormat = { "markdown", "plaintext" }
}
},
synchronization = {
didSave = true,
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
}
}
}
cmd = { "vscode-json-languageserver", "--stdio" }
filetypes = { "json" }
log_level = 2
on_init = <function 1>
root_dir = root_pattern(".git", vim.fn.getcwd())
settings = {}leanls
https://github.com/leanprover/lean-client-js/tree/master/lean-language-server
Lean language server.
This server accepts configuration via the settings key.
Available settings:
-
lean.executablePath:stringDefault:
"lean"Path to the Lean executable to use.
-
lean.extraOptions:arrayDefault:
{}Array items:
{description = "a single command-line argument",type = "string"}Extra command-line options for the Lean server.
-
lean.infoViewAllErrorsOnLine:booleanInfo view: show all errors on the current line, instead of just the ones on the right of the cursor.
-
lean.infoViewAutoOpen:booleanDefault:
trueInfo view: open info view when Lean extension is activated.
-
lean.infoViewAutoOpenShowGoal:booleanDefault:
trueInfo view: auto open shows goal and messages for the current line (instead of all messages for the whole file)
-
lean.infoViewFilterIndex:numberDefault:
-1Index of the filter applied to the tactic state (in the array infoViewTacticStateFilters). An index of -1 means no filter is applied.
-
lean.infoViewStyle:stringDefault:
""Add an additional CSS snippet to the info view.
-
lean.infoViewTacticStateFilters:arrayDefault:
{ {flags = "",match = false,regex = "^_"}, {flags = "",match = true,name = "goals only",regex = "^(⊢|\\d+ goals|case|$)"} }Array items:
{description = "an object with required properties 'regex': string, 'match': boolean, and 'flags': string, and optional property 'name': string",properties = {flags = {description = "additional flags passed to the RegExp constructor, e.g. 'i' for ignore case",type = "string"},match = {description = "whether tactic state lines matching the value of 'regex' should be included (true) or excluded (false)",type = "boolean"},name = {description = "name displayed in the dropdown",type = "string"},regex = {description = "a properly-escaped regex string, e.g. '^_' matches any string beginning with an underscore",type = "string"}},required = { "regex", "match", "flags" },type = "object"}An array of objects containing regular expression strings that can be used to filter (positively or negatively) the tactic state in the info view. Set to an empty array '[]' to hide the filter select dropdown.
Each object must contain the following keys: 'regex': string, 'match': boolean, 'flags': string. 'regex' is a properly-escaped regex string, 'match' = true (false) means blocks in the tactic state matching 'regex' will be included (excluded) in the info view, 'flags' are additional flags passed to the JavaScript RegExp constructor. The 'name' key is optional and may contain a string that is displayed in the dropdown instead of the full regex details.
-
lean.input.customTranslations:objectDefault:
vim.empty_dict()Array items:
{description = "Unicode character to translate to",type = "string"}Add additional input Unicode translations. Example:
{"foo": "☺"}will correct\footo☺. -
lean.input.enabled:booleanDefault:
trueEnable Lean input mode.
-
lean.input.languages:arrayDefault:
{ "lean" }Array items:
{description = "the name of a language, e.g. 'lean', 'markdown'",type = "string"}Enable Lean Unicode input in other file types.
-
lean.input.leader:stringDefault:
"\\"Leader key to trigger input mode.
-
lean.leanpkgPath:stringDefault:
"leanpkg"Path to the leanpkg executable to use.
-
lean.memoryLimit:numberDefault:
4096Set a memory limit (in megabytes) for the Lean server.
-
lean.progressMessages:booleanShow error messages where Lean is still checking.
-
lean.roiModeDefault:stringDefault:
"visible"Set the default region of interest mode (nothing, visible, lines, linesAndAbove, open, or project) for the Lean extension.
-
lean.timeLimit:numberDefault:
100000Set a deterministic timeout (it is approximately the maximum number of memory allocations in thousands) for the Lean server.
-
lean.typeInStatusBar:booleanDefault:
trueShow the type of term under the cursor in the status bar.
-
lean.typesInCompletionList:booleanDisplay types of all items in the list of completions. By default, only the type of the highlighted item is shown.
require'nvim_lsp'.leanls.setup{}
Default Values:
cmd = { "lean-language-server", "--stdio" }
filetypes = { "lean" }
log_level = 2
root_dir = util.root_pattern(".git")
settings = {}metals
Scala language server with rich IDE features.
metals can be installed via :LspInstall metals.
Can be installed in Nvim with :LspInstall metals
This server accepts configuration via the settings key.
Available settings:
-
metals.customRepositories:arrayArray items:
{type = "string"} -
metals.gradleScript:string -
metals.javaHome:string -
metals.mavenScript:string -
metals.millScript:string -
metals.sbtScript:string -
metals.scalafmtConfigPath:string -
metals.serverProperties:arrayArray items:
{type = "string"} -
metals.serverVersion:stringDefault:
"0.8.0"
require'nvim_lsp'.metals.setup{}
Default Values:
cmd = { "metals" }
filetype = { "scala" }
log_level = 2
root_dir = util.root_pattern("build.sbt")
settings = {}ocamlls
https://github.com/ocaml-lsp/ocaml-language-server
ocaml-language-server can be installed via :LspInstall ocamlls or by yourself with npm
npm install -g ocaml-langauge-serverCan be installed in Nvim with :LspInstall ocamlls
require'nvim_lsp'.ocamlls.setup{}
Default Values:
cmd = { "ocaml-language-server", "--stdio" }
filetypes = { "ocaml", "reason" }
log_level = 2
root_dir = root_pattern(".merlin", "package.json")
settings = {}pyls
https://github.com/palantir/python-language-server
python-language-server, a language server for Python.
This server accepts configuration via the settings key.
Available settings:
-
pyls.configurationSources:arrayDefault:
{ "pycodestyle" }Array items:
{enum = { "pycodestyle", "pyflakes" },type = "string"}List of configuration sources to use.
-
pyls.executable:stringDefault:
"pyls"Language server executable
-
pyls.plugins.jedi.environment:stringDefault:
vim.NILDefine environment for jedi.Script and Jedi.names.
-
pyls.plugins.jedi.extra_paths:arrayDefault:
{}Define extra paths for jedi.Script.
-
pyls.plugins.jedi_completion.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.jedi_completion.include_params:booleanDefault:
trueAuto-completes methods and classes with tabstops for each parameter.
-
pyls.plugins.jedi_definition.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.jedi_definition.follow_builtin_imports:booleanDefault:
trueIf follow_imports is True will decide if it follow builtin imports.
-
pyls.plugins.jedi_definition.follow_imports:booleanDefault:
trueThe goto call will follow imports.
-
pyls.plugins.jedi_hover.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.jedi_references.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.jedi_signature_help.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.jedi_symbols.all_scopes:booleanDefault:
trueIf True lists the names of all scopes instead of only the module namespace.
-
pyls.plugins.jedi_symbols.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.mccabe.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.mccabe.threshold:numberDefault:
15The minimum threshold that triggers warnings about cyclomatic complexity.
-
pyls.plugins.preload.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.preload.modules:arrayDefault:
vim.NILArray items:
{type = "string"}List of modules to import on startup
-
pyls.plugins.pycodestyle.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.pycodestyle.exclude:arrayDefault:
vim.NILArray items:
{type = "string"}Exclude files or directories which match these patterns.
-
pyls.plugins.pycodestyle.filename:arrayDefault:
vim.NILArray items:
{type = "string"}When parsing directories, only check filenames matching these patterns.
-
pyls.plugins.pycodestyle.hangClosing:booleanDefault:
vim.NILHang closing bracket instead of matching indentation of opening bracket's line.
-
pyls.plugins.pycodestyle.ignore:arrayDefault:
vim.NILArray items:
{type = "string"}Ignore errors and warnings
-
pyls.plugins.pycodestyle.maxLineLength:numberDefault:
vim.NILSet maximum allowed line length.
-
pyls.plugins.pycodestyle.select:arrayDefault:
vim.NILArray items:
{type = "string"}Select errors and warnings
-
pyls.plugins.pydocstyle.addIgnore:arrayDefault:
vim.NILArray items:
{type = "string"}Ignore errors and warnings in addition to the specified convention.
-
pyls.plugins.pydocstyle.addSelect:arrayDefault:
vim.NILArray items:
{type = "string"}Select errors and warnings in addition to the specified convention.
-
pyls.plugins.pydocstyle.convention:enum { "pep257", "numpy" }Default:
vim.NILChoose the basic list of checked errors by specifying an existing convention.
-
pyls.plugins.pydocstyle.enabled:booleanEnable or disable the plugin.
-
pyls.plugins.pydocstyle.ignore:arrayDefault:
vim.NILArray items:
{type = "string"}Ignore errors and warnings
-
pyls.plugins.pydocstyle.match:stringDefault:
"(?!test_).*\\.py"Check only files that exactly match the given regular expression; default is to match files that don't start with 'test_' but end with '.py'.
-
pyls.plugins.pydocstyle.matchDir:stringDefault:
"[^\\.].*"Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot.
-
pyls.plugins.pydocstyle.select:arrayDefault:
vim.NILArray items:
{type = "string"}Select errors and warnings
-
pyls.plugins.pyflakes.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.pylint.args:arrayDefault:
vim.NILArray items:
{type = "string"}Arguments to pass to pylint.
-
pyls.plugins.pylint.enabled:booleanEnable or disable the plugin.
-
pyls.plugins.rope_completion.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.plugins.yapf.enabled:booleanDefault:
trueEnable or disable the plugin.
-
pyls.rope.extensionModules:stringDefault:
vim.NILBuiltin and c-extension modules that are allowed to be imported and inspected by rope.
-
pyls.rope.ropeFolder:arrayDefault:
vim.NILArray items:
{type = "string"}The name of the folder in which rope stores project configurations and data. Pass
nullfor not using such a folder at all.
require'nvim_lsp'.pyls.setup{}
Default Values:
cmd = { "pyls" }
filetypes = { "python" }
log_level = 2
root_dir = vim's starting directory
settings = {}pyls_ms
https://github.com/Microsoft/python-language-server
python-language-server, a language server for Python.
Requires .NET Core to run. On Linux or macOS:
curl -L https://dot.net/v1/dotnet-install.sh | shThis server accepts configuration via the settings key.
Can be installed in Nvim with :LspInstall pyls_ms
require'nvim_lsp'.pyls_ms.setup{}
Default Values:
filetypes = { "python" }
init_options = {
analysisUpdates = true,
asyncStartup = true,
displayOptions = {},
interpreter = {
properties = {
InterpreterPath = "/usr/bin/python",
Version = "2.7"
}
}
}
log_level = 2
on_new_config = <function 1>
root_dir = vim's starting directory
settings = {
python = {
analysis = {
disabled = {},
errors = {},
info = {}
}
}
}rls
https://github.com/rust-lang/rls
rls, a language server for Rust
See https://github.com/rust-lang/rls#setup to setup rls itself. See https://github.com/rust-lang/rls#configuration for rls-specific settings.
If you want to use rls for a particular build, eg nightly, set cmd as follows:
cmd = {"rustup", "run", "nightly", "rls"}This server accepts configuration via the settings key.
Available settings:
-
rust-client.channel:enum { "stable", "beta", "nightly" }Default:
vim.NILRust channel to invoke rustup with. Ignored if rustup is disabled. By default, uses the same channel as your currently open project.
-
rust-client.disableRustup:booleanDisable usage of rustup and use rustc/rls from PATH.
-
rust-client.enableMultiProjectSetup:booleanAllow multiple projects in the same folder, along with remove the constraint that the cargo.toml must be located at the root. (Experimental: might not work for certain setups)
-
rust-client.logToFile:booleanWhen set to true, RLS stderr is logged to a file at workspace root level. Requires reloading extension after change.
-
rust-client.nestedMultiRootConfigInOutermost:booleanDefault:
trueIf one root workspace folder is nested in another root folder, look for the Rust config in the outermost root.
-
rust-client.revealOutputChannelOn:enum { "info", "warn", "error", "never" }Default:
"never"Specifies message severity on which the output channel will be revealed. Requires reloading extension after change.
-
rust-client.rlsPath:string|nullDefault:
vim.NILOverride RLS path. Only required for RLS developers. If you set this and use rustup, you should also set
rust-client.channelto ensure your RLS sees the right libraries. If you don't use rustup, make sure to setrust-client.disableRustup. -
rust-client.rustupPath:stringDefault:
"rustup"Path to rustup executable. Ignored if rustup is disabled.
-
rust-client.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VS Code and the Rust language server.
-
rust-client.updateOnStartup:booleanUpdate the RLS whenever the extension starts up.
-
rust-client.useWSL:booleanWhen set to true, RLS is started within Windows Subsystem for Linux.
-
rust.all_features:booleanEnable all Cargo features.
-
rust.all_targets:booleanDefault:
trueChecks the project as if you were running cargo check --all-targets (I.e., check all targets and integration tests too).
-
rust.build_bin:string|nullDefault:
vim.NILSpecify to run analysis as if running
cargo check --bin <name>. Usenullto auto-detect. (unstable) -
rust.build_command:string|nullDefault:
vim.NILEXPERIMENTAL (requires
unstable_features) If set, executes a given program responsible for rebuilding save-analysis to be loaded by the RLS. The program given should output a list of resulting .json files on stdout. Impliesrust.build_on_save: true. -
rust.build_lib:boolean|nullDefault:
vim.NILSpecify to run analysis as if running
cargo check --lib. Usenullto auto-detect. (unstable) -
rust.build_on_save:booleanOnly index the project when a file is saved and not on change.
-
rust.cfg_test:booleanBuild cfg(test) code. (unstable)
-
rust.clear_env_rust_log:booleanDefault:
trueClear the RUST_LOG environment variable before running rustc or cargo.
-
rust.clippy_preference:enum { "on", "opt-in", "off" }Default:
"opt-in"Controls eagerness of clippy diagnostics when available. Valid values are (case-insensitive):
- "off": Disable clippy lints.
- "on": Display the same diagnostics as command-line clippy invoked with no arguments (
clippy::allunless overridden). - "opt-in": Only display the lints explicitly enabled in the code. Start by adding
#![warn(clippy::all)]to the root of each crate you want linted. You need to install clippy via rustup if you haven't already.
-
rust.crate_blacklist:array|nullDefault:
{ "cocoa", "gleam", "glium", "idna", "libc", "openssl", "rustc_serialize", "serde", "serde_json", "typenum", "unicode_normalization", "unicode_segmentation", "winapi" }Overrides the default list of packages for which analysis is skipped. Available since RLS 1.38
-
rust.features:arrayDefault:
{}A list of Cargo features to enable.
-
rust.full_docs:boolean|nullDefault:
vim.NILInstructs cargo to enable full documentation extraction during save-analysis while building the crate.
-
rust.jobs:number|nullDefault:
vim.NILNumber of Cargo jobs to be run in parallel.
-
rust.no_default_features:booleanDo not enable default Cargo features.
-
rust.racer_completion:booleanDefault:
trueEnables code completion using racer.
-
rust.rustflags:string|nullDefault:
vim.NILFlags added to RUSTFLAGS.
-
rust.rustfmt_path:string|nullDefault:
vim.NILWhen specified, RLS will use the Rustfmt pointed at the path instead of the bundled one
-
rust.show_hover_context:booleanDefault:
trueShow additional context in hover tooltips when available. This is often the type local variable declaration.
-
rust.show_warnings:booleanDefault:
trueShow warnings.
-
rust.sysroot:string|nullDefault:
vim.NIL--sysroot
-
rust.target:string|nullDefault:
vim.NIL--target
-
rust.target_dir:string|nullDefault:
vim.NILWhen specified, it places the generated analysis files at the specified target directory. By default it is placed target/rls directory.
-
rust.unstable_features:booleanEnable unstable features.
-
rust.wait_to_build:numberDefault:
1500Time in milliseconds between receiving a change notification and starting build.
require'nvim_lsp'.rls.setup{}
Default Values:
cmd = { "rls" }
filetypes = { "rust" }
log_level = 2
root_dir = root_pattern("Cargo.toml")
settings = {}rust_analyzer
https://github.com/rust-analyzer/rust-analyzer
rust-analyzer (aka rls 2.0), a language server for Rust
See docs for extra settings.
This server accepts configuration via the settings key.
Available settings:
-
rust-analyzer.cargo-watch.allTargets:booleanDefault:
trueCheck all targets and tests (will be passed as
--all-targets) -
rust-analyzer.cargo-watch.arguments:arrayDefault:
{}cargo-watcharguments. (e.g:--features="shumway,pdf"will run ascargo watch -x "check --features="shumway,pdf"") -
rust-analyzer.cargo-watch.command:stringDefault:
"check"cargo-watchcommand. (e.g:clippywill run ascargo watch -x clippy) -
rust-analyzer.cargo-watch.enable:booleanDefault:
trueRun
cargo checkfor diagnostics on save -
rust-analyzer.cargoFeatures.allFeatures:booleanDefault:
trueActivate all available features
-
rust-analyzer.cargoFeatures.features:arrayDefault:
{}List of features to activate
-
rust-analyzer.cargoFeatures.noDefaultFeatures:booleanDo not activate the
defaultfeature -
rust-analyzer.displayInlayHints:booleanDefault:
trueDisplay additional type and parameter information in the editor
-
rust-analyzer.enableEnhancedTyping:booleanDefault:
trueEnables enhanced typing. NOTE: If using a VIM extension, you should set this to false
-
rust-analyzer.excludeGlobs:arrayDefault:
{}Paths to exclude from analysis
-
rust-analyzer.featureFlags:objectDefault:
vim.empty_dict()Fine grained feature flags to disable annoying features
-
rust-analyzer.highlightingOn:booleanHighlight Rust code (overrides built-in syntax highlighting)
-
rust-analyzer.lruCapacity:number|nullDefault:
vim.NILNumber of syntax trees rust-analyzer keeps in memory
-
rust-analyzer.maxInlayHintLength:numberDefault:
20Maximum length for inlay hints
-
rust-analyzer.raLspServerPath:stringDefault:
"ra_lsp_server"Path to ra_lsp_server executable
-
rust-analyzer.rainbowHighlightingOn:booleanWhen highlighting Rust code, use a unique color per identifier
-
rust-analyzer.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Trace requests to the ra_lsp_server
-
rust-analyzer.useClientWatching:booleanDefault:
trueclient provided file watching instead of notify watching.
require'nvim_lsp'.rust_analyzer.setup{}
Default Values:
capabilities = {
offsetEncoding = { "utf-8", "utf-16" },
textDocument = {
completion = {
completionItem = {
commitCharactersSupport = false,
deprecatedSupport = false,
documentationFormat = { "markdown", "plaintext" },
preselectSupport = false,
snippetSupport = false
},
completionItemKind = {
valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 }
},
contextSupport = false,
dynamicRegistration = false
},
documentHighlight = {
dynamicRegistration = false
},
hover = {
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
references = {
dynamicRegistration = false
},
signatureHelp = {
dynamicRegistration = false,
signatureInformation = {
documentationFormat = { "markdown", "plaintext" }
}
},
synchronization = {
didSave = true,
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
}
}
}
cmd = { "ra_lsp_server" }
filetypes = { "rust" }
log_level = 2
on_init = <function 1>
root_dir = root_pattern("Cargo.toml")
settings = {}solargraph
solargraph, a language server for Ruby
You can install solargraph via gem install.
gem install solargraphThis server accepts configuration via the settings key.
Available settings:
-
solargraph.autoformat:enum { true, false }Enable automatic formatting while typing (WARNING: experimental)
-
solargraph.bundlerPath:stringDefault:
"bundle"Path to the bundle executable, defaults to 'bundle'
-
solargraph.checkGemVersion:enum { true, false }Default:
trueAutomatically check if a new version of the Solargraph gem is available.
-
solargraph.commandPath:stringDefault:
"solargraph"Path to the solargraph command. Set this to an absolute path to select from multiple installed Ruby versions.
-
solargraph.completion:enum { true, false }Default:
trueEnable completion
-
solargraph.definitions:enum { true, false }Default:
trueEnable definitions (go to, etc.)
-
solargraph.diagnostics:enum { true, false }Enable diagnostics
-
solargraph.externalServer:objectDefault:
{host = "localhost",port = 7658}The host and port to use for external transports. (Ignored for stdio and socket transports.)
-
solargraph.folding:booleanDefault:
trueEnable folding ranges
-
solargraph.formatting:enum { true, false }Enable document formatting
-
solargraph.hover:enum { true, false }Default:
trueEnable hover
-
solargraph.logLevel:enum { "warn", "info", "debug" }Default:
"warn"Level of debug info to log.
warnis least anddebugis most. -
solargraph.references:enum { true, false }Default:
trueEnable finding references
-
solargraph.rename:enum { true, false }Default:
trueEnable symbol renaming
-
solargraph.symbols:enum { true, false }Default:
trueEnable symbols
-
solargraph.transport:enum { "socket", "stdio", "external" }Default:
"socket"The type of transport to use.
-
solargraph.useBundler:booleanUse
bundle execto run solargraph. (If this is true, the solargraph.commandPath setting is ignored.)
require'nvim_lsp'.solargraph.setup{}
Default Values:
cmd = { "solargraph", "stdio" }
filetypes = { "ruby" }
log_level = 2
root_dir = root_pattern("Gemfile", ".git")
settings = {}sumneko_lua
https://github.com/sumneko/lua-language-server
Lua language server. By default, this doesn't have a cmd set. This is
because it doesn't provide a global binary. We provide an installer for Linux
and macOS using :LspInstall. If you wish to install it yourself, here is a
guide.
Can be installed in Nvim with :LspInstall sumneko_lua
This server accepts configuration via the settings key.
Available settings:
-
Lua.awakened.cat:boolean -
Lua.completion.callSnippet:enum { "Disable", "Both", "Replace" }Default:
"Disable" -
Lua.completion.enable:booleanDefault:
true -
Lua.completion.keywordSnippet:enum { "Disable", "Both", "Replace" }Default:
"Replace" -
Lua.develop.debuggerPort:integerDefault:
11412 -
Lua.develop.debuggerWait:boolean -
Lua.develop.enable:boolean -
Lua.diagnostics.disable:arrayArray items:
{type = "string"} -
Lua.diagnostics.enable:booleanDefault:
true -
Lua.diagnostics.globals:arrayArray items:
{type = "string"} -
Lua.diagnostics.severity:object -
Lua.runtime.path:arrayDefault:
{ "?.lua", "?/init.lua", "?/?.lua" }Array items:
{type = "string"} -
Lua.runtime.version:enum { "Lua 5.1", "Lua 5.2", "Lua 5.3", "Lua 5.4", "LuaJIT" }Default:
"Lua 5.3" -
Lua.workspace.ignoreDir:arrayDefault:
{ ".vscode" }Array items:
{type = "string"} -
Lua.workspace.ignoreSubmodules:booleanDefault:
true -
Lua.workspace.library:object -
Lua.workspace.maxPreload:integerDefault:
300 -
Lua.workspace.preloadFileSize:integerDefault:
100 -
Lua.workspace.useGitIgnore:booleanDefault:
true
require'nvim_lsp'.sumneko_lua.setup{}
Default Values:
filetypes = { "lua" }
log_level = 2
root_dir = root_pattern(".git") or os_homedir
settings = {}terraformls
https://github.com/juliosueiras/terraform-lsp
Terraform language server You can use released binary or build your own.
This server accepts configuration via the settings key.
Available settings:
-
terraform.codelens.enabled:booleanDefault:
trueEnable/disable the CodeLens feature
-
terraform.format:objectDefault:
{ignoreExtensionsOnSave = { ".tfsmurf" }}Formatting settings
-
terraform.indexing:objectDefault:
{delay = 500,enabled = true,exclude = { ".terraform/**/*", "**/.terraform/**/*" },liveIndexing = false}Indexes all terraform sources to get live syntax errors, rename support, go to symbol, and much more...
-
terraform.languageServer:objectDefault:
{args = {},enabled = false}Configures how the language server runs and works
-
terraform.lintConfig:string|nullDefault:
vim.NILPath to the
tflintconfig file. -
terraform.lintPath:stringDefault:
"tflint"Path to the
tflintexecutable. -
terraform.path:stringDefault:
"terraform"Path to the
terraformexecutable -
terraform.paths:arrayDefault:
{}List of terraform paths or paths with versions
-
terraform.telemetry.enabled:booleanDefault:
trueEnable/disable telemetry reporting for this plugin. The global
telemetry.enableTelemetryis also respected. If the global is disabled, this setting has no effect. -
terraform.templateDirectory:stringDefault:
"templates"A relative path to where your templates are stored relative to the workspace root.
require'nvim_lsp'.terraformls.setup{}
Default Values:
cmd = { "terraform-lsp" }
filetypes = { "terraform" }
log_level = 2
root_dir = root_pattern(".git")
settings = {}texlab
A completion engine built from scratch for (La)TeX.
See https://texlab.netlify.com/docs/reference/configuration for configuration options.
require'nvim_lsp'.texlab.setup{}
Commands:
- TexlabBuild: Build the current buffer
Default Values:
cmd = { "texlab" }
filetypes = { "tex", "bib" }
log_level = 2
root_dir = vim's starting directory
settings = {
bibtex = {
formatting = {
lineLength = 120
}
},
latex = {
build = {
args = { "-pdf", "-interaction=nonstopmode", "-synctex=1" },
executable = "latexmk",
onSave = false
},
forwardSearch = {
args = {},
onSave = false
},
lint = {
onChange = false
}
}
}tsserver
https://github.com/theia-ide/typescript-language-server
typescript-language-server can be installed via :LspInstall tsserver or by yourself with npm:
npm install -g typescript-language-serverCan be installed in Nvim with :LspInstall tsserver
require'nvim_lsp'.tsserver.setup{}
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "typescript-language-server", "--stdio" }
filetypes = { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" }
log_level = 2
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("package.json")
settings = {}vimls
require'nvim_lsp'.vimls.setup{}
Default Values:
cmd = { "vim-language-server", "--stdio" }
docs = {
description = "https://github.com/iamcco/vim-language-server\n\nIf you don't want to use Nvim to install it, then you can use:\n```sh\nnpm install -g vim-language-server\n```\n"
}
filetypes = { "vim" }
init_options = {
diagnostic = {
enable = true
},
indexes = {
count = 3,
gap = 100,
projectRootPatterns = { "runtime", "nvim", ".git", "autoload", "plugin" },
runtimepath = true
},
iskeyword = "@,48-57,_,192-255,-#",
runtimepath = "",
suggest = {
fromRuntimepath = true,
fromVimruntime = true
},
vimruntime = ""
}
log_level = 2
on_new_config = <function 1>
root_dir = <function 1>
settings = {}yamlls
https://github.com/redhat-developer/yaml-language-server
yaml-language-server can be installed via :LspInstall yamlls or by yourself with npm:
npm install -g yaml-language-serverCan be installed in Nvim with :LspInstall yamlls
This server accepts configuration via the settings key.
Available settings:
-
yaml.completion:booleanDefault:
trueEnable/disable completion feature
-
yaml.customTags:arrayDefault:
{}Custom tags for the parser to use
-
yaml.format.bracketSpacing:booleanDefault:
truePrint spaces between brackets in objects
-
yaml.format.enable:booleanDefault:
trueEnable/disable default YAML formatter
-
yaml.format.printWidth:integerDefault:
80Specify the line length that the printer will wrap on
-
yaml.format.proseWrap:enum { "preserve", "never", "always" }Default:
"preserve"Always: wrap prose if it exeeds the print width, Never: never wrap the prose, Preserve: wrap prose as-is
-
yaml.format.singleQuote:booleanUse single quotes instead of double quotes
-
yaml.hover:booleanDefault:
trueEnable/disable hover feature
-
yaml.schemaStore.enable:booleanDefault:
trueAutomatically pull available YAML schemas from JSON Schema Store
-
yaml.schemas:objectDefault:
vim.empty_dict()Associate schemas to YAML files in the current workspace
-
yaml.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VSCode and the YAML language service.
-
yaml.validate:booleanDefault:
trueEnable/disable validation feature
require'nvim_lsp'.yamlls.setup{}
Default Values:
capabilities = {
offsetEncoding = { "utf-8", "utf-16" },
textDocument = {
completion = {
completionItem = {
commitCharactersSupport = false,
deprecatedSupport = false,
documentationFormat = { "markdown", "plaintext" },
preselectSupport = false,
snippetSupport = false
},
completionItemKind = {
valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 }
},
contextSupport = false,
dynamicRegistration = false
},
documentHighlight = {
dynamicRegistration = false
},
hover = {
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
references = {
dynamicRegistration = false
},
signatureHelp = {
dynamicRegistration = false,
signatureInformation = {
documentationFormat = { "markdown", "plaintext" }
}
},
synchronization = {
didSave = true,
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
}
}
}
cmd = { "yaml-language-server", "--stdio" }
filetypes = { "yaml" }
log_level = 2
on_init = <function 1>
root_dir = root_pattern(".git", vim.fn.getcwd())
settings = {}