Collection of common configurations for the Nvim LSP client.
The configurations here are strictly best effort and unsupported.
This repo is (1) a place for Nvim LSP users to collaboratively provide starting examples for the many LSP backends out there, and (2) a reference for the current best practice (or most popular) regarding choice of server, setup, etc.
While Nvim LSP undergoes development, the configs in this repo assume that you are using the latest Nvim HEAD/nightly build.
Update Nvim and nvim-lspconfig before reporting an issue.
It's up to you to send improvements so that these configs align with current best practices for a given language.
- Read CONTRIBUTING.md. Ask questions in Neovim Gitter.
- Choose a language from the coc.nvim wiki or emacs-lsp.
- Create a new file at
lua/lspconfig/SERVER_NAME.lua.- Copy an existing config to get started. Most configs are simple. For an extensive example see texlab.lua.
- Requires Nvim HEAD/nightly (v0.5 prerelease).
- nvim-lspconfig is just a plugin. Install it like any other Vim plugin, e.g. with vim-plug:
:Plug 'neovim/nvim-lspconfig' - Call
:packadd nvim-lspconfigin your vimrc if you installed nvim-lspconfig to'packpath'or if you use a package manager such as minpac.
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-lspconfig') -- If installed as a Vim "package".
require'lspconfig'.<config>.setup{name=β¦, settings = {β¦}, β¦}If you want to add this to your vimrc, you will need to enclose it in a lua block.
lua <<EOF
vim.cmd('packadd nvim-lspconfig') -- If installed as a Vim "package".
require'lspconfig'.<config>.setup{name=β¦, settings = {β¦}, β¦}
EOFFind 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 lspconfig.texlab.buf_build({bufnr}).
If you want to see the location of log file, you can run this in neovim:
:lua print(vim.lsp.get_log_path())
To use the defaults, just call setup() with an empty config parameter.
For the gopls config, that would be:
vim.cmd('packadd nvim-lspconfig') -- If installed as a Vim "package".
require'lspconfig'.gopls.setup{}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 lspconfig = require'lspconfig'
lspconfig.gopls.setup{
root_dir = lspconfig.util.root_pattern('.git');
}The documentation for each config lists default values and additional optional properties.
local lspconfig = require'lspconfig'
lspconfig.texlab.setup{
name = 'texlab_fancy';
log_level = vim.lsp.protocol.MessageType.Log;
message_level = vim.lsp.protocol.MessageType.Log;
settings = {
latex = {
build = {
onSave = true;
}
}
}
}To configure a custom/private server, just require lspconfig/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'lspconfig'.foo_lsp.setup{}
local lspconfig = require'lspconfig'
local configs = require'lspconfig/configs'
-- Check if it's already defined for when I reload this file.
if not lspconfig.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 lspconfig.util.find_git_ancestor(fname) or vim.loop.os_homedir()
end;
settings = {};
};
}
end
lspconfig.foo_lsp.setup{}If you want to change default configs for all servers, you can override default_config like this.
local lspconfig = require'lspconfig'
lspconfig.util.default_config = vim.tbl_extend(
"force",
lspconfig.util.default_config,
{ log_level = lsp.protocol.MessageType.Warning.Error }
)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
The setup() interface:
lspconfig.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 |lspconfig.util.search_ancestors()| and the functions which use it:
- |lspconfig.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:
- |lspconfig.util.find_git_root()|
- |lspconfig.util.find_node_modules_root()|
- |lspconfig.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 window/logMessage notifications. Defaults to
vim.lsp.protocol.MessageType.Warning instead of
vim.lsp.protocol.MessageType.Log.
{message_level}
controls the level of messages to show from window/showMessage notifications. 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, new_root_dir)` 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()|.
The following LSP configs are included. Follow a link to find documentation for that config.
- als
- angularls
- bashls
- ccls
- clangd
- clojure_lsp
- cmake
- codeqlls
- cssls
- dartls
- diagnosticls
- dockerls
- efm
- elixirls
- elmls
- flow
- fortls
- gdscript
- ghcide
- gopls
- hie
- hls
- html
- intelephense
- jdtls
- jedi_language_server
- jsonls
- julials
- kotlin_language_server
- leanls
- metals
- nimls
- ocamlls
- ocamllsp
- omnisharp
- purescriptls
- pyls
- pyls_ms
- r_language_server
- rls
- rnix
- rome
- rust_analyzer
- scry
- solargraph
- sourcekit
- sqlls
- sumneko_lua
- terraformls
- texlab
- tsserver
- vimls
- vuels
- yamlls
https://github.com/AdaCore/ada_language_server
Ada language server. Use LspInstall als to install it.
Can be configured by passing a "settings" object to als.setup{}:
require('lspconfig').als.setup{
settings = {
ada = {
projectFile = "project.gpr";
scenarioVariables = { ... };
}
}
}Can be installed in Nvim with :LspInstall als
require'lspconfig'.als.setup{}
Commands:
Default Values:
cmd = { "ada_language_server" }
filetypes = { "ada" }
root_dir = util.root_pattern("Makefile", ".git")https://github.com/angular/vscode-ng-language-service
angular-language-server can be installed via :LspInstall angularls
If you prefer to install this yourself you can through npm npm install @angular/language-server.
Be aware there is no global binary and must be run via node_modules/@angular/language-server/index.js
Can be installed in Nvim with :LspInstall angularls
require'lspconfig'.angularls.setup{}
Commands:
Default Values:
cmd = { "/home/runner/.cache/nvim/lspconfig/angularls/node_modules/.bin/angularls", "--stdio", "--tsProbeLocations", "", "--ngProbeLocations", "" }
filetypes = { "typescript", "html", "typescriptreact", "typescript.tsx" }
root_dir = root_pattern("angular.json", ".git")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'lspconfig'.bashls.setup{}
Commands:
Default Values:
cmd = { "bash-language-server", "start" }
filetypes = { "sh" }
root_dir = vim's starting directoryhttps://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. For details on how to automatically generate one using CMake look here.
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" }null
-
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:
{}null
-
ccls.highlight.global.face:arrayDefault:
{ "fontWeight: bolder" }null
-
ccls.highlight.globalVariable.face:arrayDefault:
{ "variable", "global" }null
-
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" }null
-
ccls.highlight.member.face:arrayDefault:
{ "fontStyle: italic" }null
-
ccls.highlight.memberFunction.face:arrayDefault:
{ "function", "member" }null
-
ccls.highlight.memberVariable.face:arrayDefault:
{ "variable", "member" }null
-
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" }null
-
ccls.highlight.parameter.face:arrayDefault:
{ "variable" }null
-
ccls.highlight.static.face:arrayDefault:
{ "fontWeight: bold" }null
-
ccls.highlight.staticMemberFunction.face:arrayDefault:
{ "function", "static" }null
-
ccls.highlight.staticMemberVariable.face:arrayDefault:
{ "variable", "static" }null
-
ccls.highlight.staticVariable.face:arrayDefault:
{ "variable", "static" }null
-
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:
{}null
-
ccls.highlight.typeAlias.face:arrayDefault:
{ "type" }null
-
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:
{}null
-
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'lspconfig'.ccls.setup{}
Commands:
Default Values:
cmd = { "ccls" }
filetypes = { "c", "cpp", "objc", "objcpp" }
root_dir = root_pattern("compile_commands.json", "compile_flags.txt", ".git")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. For details on how to automatically generate one using CMake look here.
require'lspconfig'.clangd.setup{}
Commands:
- ClangdSwitchSourceHeader: Switch between source/header
Default Values:
capabilities = default capabilities, with offsetEncoding utf-8
cmd = { "clangd", "--background-index" }
filetypes = { "c", "cpp", "objc", "objcpp" }
on_init = function to handle changing offsetEncoding
root_dir = root_pattern("compile_commands.json", "compile_flags.txt", ".git") or dirnamehttps://github.com/snoe/clojure-lsp
Clojure Language Server
require'lspconfig'.clojure_lsp.setup{}
Commands:
Default Values:
cmd = { "clojure-lsp" }
filetypes = { "clojure", "edn" }
root_dir = root_pattern("project.clj", "deps.edn", ".git")https://github.com/regen100/cmake-language-server
CMake LSP Implementation
require'lspconfig'.cmake.setup{}
Commands:
Default Values:
cmd = { "cmake-language-server" }
filetypes = { "cmake" }
init_options = {
buildDirectory = "build"
}
root_dir = root_pattern(".git", "compile_commands.json", "build")Reference: https://help.semmle.com/codeql/codeql-cli.html
Binaries: https://github.com/github/codeql-cli-binaries
This server accepts configuration via the settings key.
Available settings:
-
codeQL.cli.executablePath:stringDefault:
""Path to the CodeQL executable that should be used by the CodeQL extension. The executable is named `codeql` on Linux/Mac and `codeql.exe` on Windows. This overrides all other CodeQL CLI settings.
-
codeQL.queryHistory.format:stringDefault:
"[%t] %q on %d - %s"Default string for how to label query history items. %t is the time of the query, %q is the query name, %d is the database name, and %s is a status string.
-
codeQL.runningQueries.autoSave:booleanEnable automatically saving a modified query file when running a query.
-
codeQL.runningQueries.debug:booleanEnable debug logging and tuple counting when running CodeQL queries. This information is useful for debugging query performance.
-
codeQL.runningQueries.maxQueries:integerDefault:
20Max number of simultaneous queries to run using the 'CodeQL: Run Queries' command.
-
codeQL.runningQueries.memory:integer|nullDefault:
vim.NILMemory (in MB) to use for running queries. Leave blank for CodeQL to choose a suitable value based on your system's available memory.
-
codeQL.runningQueries.numberOfThreads:integerDefault:
1Number of threads for running queries.
-
codeQL.runningQueries.timeout:integer|nullDefault:
vim.NILTimeout (in seconds) for running queries. Leave blank or set to zero for no timeout.
-
codeQL.runningTests.numberOfThreads:integerDefault:
1Number of threads for running CodeQL tests.
require'lspconfig'.codeqlls.setup{}
Commands:
Default Values:
before_init = <function 1>
cmd = { "codeql", "execute", "language-server", "--check-errors", "ON_CHANGE", "-q" }
filetypes = { "ql" }
log_level = 2
root_dir = <function 1>
settings = {
search_path = "list containing all search paths, eg: '~/codeql-home/codeql-repo'"
}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'lspconfig'.cssls.setup{}
Commands:
Default Values:
cmd = { "css-languageserver", "--stdio" }
filetypes = { "css", "scss", "less" }
root_dir = root_pattern("package.json")
settings = {
css = {
validate = true
},
less = {
validate = true
},
scss = {
validate = true
}
}https://github.com/dart-lang/sdk/tree/master/pkg/analysis_server/tool/lsp_spec
Language server for dart.
This server accepts configuration via the settings key.
Available settings:
-
dart.additionalAnalyzerFileExtensions:arrayDefault:
{}Array items:
{type = "string"}Additional file extensions that should be analyzed (usually used in combination with analyzer plugins).
-
dart.allowAnalytics:booleanDefault:
trueWhether to send analytics such as startup timings, frequency of use of features and analysis server crashes.
-
dart.allowTestsOutsideTestFolder:booleannull
-
dart.analysisExcludedFolders:arrayDefault:
{}Array items:
{type = "string"}An array of paths to be excluded from Dart analysis. This option should usually be set at the Workspace level.
-
dart.analysisServerFolding:booleanDefault:
trueWhether to use folding data from the Dart analysis server instead of the built-in VS Code indent-based folding.
-
dart.analyzeAngularTemplates:booleanDefault:
truenull
-
dart.analyzerAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}Additional arguments to pass to the Dart analysis server.
-
dart.analyzerDiagnosticsPort:null|numberDefault:
vim.NILThe port number to be used for the Dart analyzer diagnostic server.
-
dart.analyzerInstrumentationLogFile:null|stringDefault:
vim.NILThe path to a log file for very detailed logging in the Dart analysis server that may be useful when trying to diagnose analysis server issues.
-
dart.analyzerLogFile:null|stringDefault:
vim.NILThe path to a log file for communication between Dart Code and the analysis server.
-
dart.analyzerPath:null|stringDefault:
vim.NILThe path to a custom Dart analysis server.
-
dart.analyzerSshHost:null|stringDefault:
vim.NILAn SSH host to run the analysis server. This can be useful when modifying code on a remote machine using SSHFS.
-
dart.analyzerVmServicePort:null|numberDefault:
vim.NILThe port number to be used for the Dart analysis server VM service.
-
dart.autoImportCompletions:booleanDefault:
trueWhether to include symbols that have not been imported in the code completion list and automatically insert the required import when selecting them.
-
dart.buildRunnerAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}null
-
dart.checkForSdkUpdates:booleanDefault:
trueWhether to check you are using the latest version of the Dart SDK at startup.
-
dart.closingLabels:booleanDefault:
trueWhether to show annotations against constructor, method invocations and lists that span multiple lines.
-
dart.completeFunctionCalls:booleanDefault:
truenull
-
dart.debugExtensionBackendProtocol:enum { "sse", "ws" }Default:
"ws"The protocol to use for the Dart Debug Extension backend service. Using WebSockets can improve performance but may fail when connecting through some proxy servers.
-
dart.debugExternalLibraries:booleannull
-
dart.debugSdkLibraries:booleannull
-
dart.devToolsBrowser:enum { "chrome", "default" }Default:
"chrome"Whether to launch external DevTools windows using Chrome or the system default browser.
-
dart.devToolsLogFile:null|stringDefault:
vim.NILThe path to a low-traffic log file for the Dart DevTools service.
-
dart.devToolsPort:null|numberDefault:
vim.NILThe port number to be used for the Dart DevTools.
-
dart.devToolsReuseWindows:booleanDefault:
trueWhether to try to reuse existing DevTools windows instead of launching new ones. Only works for instances of DevTools launched by the DevTools server on the local machine.
-
dart.devToolsTheme:enum { "dark", "light" }Default:
"dark"The theme to use for Dart DevTools.
-
dart.doNotFormat:arrayDefault:
{}Array items:
{type = "string"}null
-
dart.embedDevTools:booleanDefault:
truenull
-
dart.enableCompletionCommitCharacters:booleannull
-
dart.enableSdkFormatter:booleanDefault:
truenull
-
dart.enableSnippets:booleanDefault:
trueWhether to include Dart and Flutter snippets in code completion.
-
dart.env:objectDefault:
vim.empty_dict()Additional environment variables to be added to all Dart/Flutter processes spawned by the Dart and Flutter extensions.
-
dart.evaluateGettersInDebugViews:booleanDefault:
trueWhether to evaluate getters in order to display them in debug views (such as the Variables, Watch and Hovers views).
-
dart.evaluateToStringInDebugViews:booleanDefault:
trueWhether to call toString() on objects when rendering them in debug views (such as the Variables, Watch and Hovers views). Only applies to views of 100 or fewer values for performance reasons.
-
dart.extensionLogFile:null|stringDefault:
vim.NILThe path to a low-traffic log file for basic extension and editor issues.
-
dart.flutterAdbConnectOnChromeOs:booleannull
-
dart.flutterAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}null
-
dart.flutterCreateAndroidLanguage:enum { "java", "kotlin" }Default:
"kotlin"The programming language to use for Android apps when creating new projects using the 'Flutter: New Project' command.
-
dart.flutterCreateIOSLanguage:enum { "objc", "swift" }Default:
"swift"The programming language to use for iOS apps when creating new projects using the 'Flutter: New Project' command.
-
dart.flutterCreateOffline:booleanWhether to use offline mode when creating new projects with the 'Flutter: New Project' command.
-
dart.flutterCreateOrganization:null|stringDefault:
vim.NILnull
-
dart.flutterCustomEmulators:arrayDefault:
{}Array items:
{properties = {args = {items = {type = "string"},type = "array"},executable = {type = "string"},id = {type = "string"},name = {type = "string"}},type = "object"}Custom emulators to show in the emulator list for easier launching. If IDs match existing emulators returned by Flutter, the custom emulators will override them.
-
dart.flutterDaemonLogFile:null|stringDefault:
vim.NILnull
-
dart.flutterGutterIcons:booleanDefault:
trueWhether to show Flutter icons and colors in the editor gutter.
-
dart.flutterHotReloadOnSave:booleanDefault:
trueWhether to automatically send a Hot Reload request during a debug session when saving files.
-
dart.flutterHotRestartOnSave:booleanDefault:
trueWhether to automatically send a Hot Restart request during a debug session when saving files if Hot Reload is not available but Hot Restart is.
-
dart.flutterOutline:booleanDefault:
trueWhether to show the Flutter Outline tree in the sidebar.
-
dart.flutterRunLogFile:null|stringDefault:
vim.NILnull
-
dart.flutterScreenshotPath:null|stringDefault:
vim.NILThe path to a directory to save Flutter screenshots.
-
dart.flutterSdkPath:null|stringDefault:
vim.NILnull
-
dart.flutterSdkPaths:arrayDefault:
{}Array items:
{type = "string"}An array of paths that either directly point to a Flutter SDK or the parent directory of multiple Flutter SDKs. When set, the version number in the status bar can be used to quickly switch between SDKs.
-
dart.flutterSelectDeviceWhenConnected:booleanDefault:
trueWhether to set newly connected devices as the current device in Flutter projects.
-
dart.flutterStructuredErrors:booleanDefault:
truenull
-
dart.flutterTestAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}null
-
dart.flutterTestLogFile:null|stringDefault:
vim.NILnull
-
dart.flutterTrackWidgetCreation:booleanDefault:
truenull
-
dart.insertArgumentPlaceholders:booleanDefault:
truenull
-
dart.lineLength:integerDefault:
80The maximum length of a line of code. This is used by the document formatter.
-
dart.maxLogLineLength:numberDefault:
2000The maximum length of a line in the log file. Lines longer than this will be truncated and suffixed with an ellipsis.
-
dart.notifyAnalyzerErrors:booleanDefault:
trueWhether to show a notification the first few times an analysis server exception occurs.
-
dart.openDevTools:enum { "never", "flutter", "always" }Default:
"never"Whether to automatically open DevTools at the start of a debug session.
-
dart.openTestView:arrayDefault:
{ "testRunStart" }Array items:
{enum = { "testRunStart", "testFailure" }}When to automatically switch focus to the test list (array to support multiple values).
-
dart.previewBazelWorkspaceCustomScripts:booleannull
-
dart.previewCommitCharacters:booleanEXPERIMENTAL: Whether to enable commit characters for the LSP server. In a future release, the dart.enableCompletionCommitCharacters setting will also apply to LSP.
-
dart.previewFlutterUiGuides:booleannull
-
dart.previewFlutterUiGuidesCustomTracking:booleanWhether to enable custom tracking of Flutter UI guidelines (to hide some latency of waiting for the next Flutter Outline).
-
dart.previewHotReloadOnSaveWatcher:booleannull
-
dart.previewLsp:booleannull
-
dart.promptToGetPackages:booleanDefault:
trueWhether to prompt to get packages when opening a project with out of date packages.
-
dart.promptToRunIfErrors:booleanDefault:
trueWhether to prompt before running if there are errors in your project. Test scripts will be excluded from the check unless they're the script being run.
-
dart.pubAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}Additional args to pass to all pub commands.
-
dart.pubTestLogFile:null|stringDefault:
vim.NILnull
-
dart.runPubGetOnPubspecChanges:booleanDefault:
truenull
-
dart.sdkPath:null|stringDefault:
vim.NILnull
-
dart.sdkPaths:arrayDefault:
{}Array items:
{type = "string"}An array of paths that either directly point to a Dart SDK or the parent directory of multiple Dart SDKs. When set, the version number in the status bar can be used to quickly switch between SDKs.
-
dart.showDartDeveloperLogs:booleanDefault:
truenull
-
dart.showDartPadSampleCodeLens:booleanDefault:
trueWhether to show CodeLens actions in the editor for opening online DartPad samples.
-
dart.showDevToolsDebugToolBarButtons:booleanDefault:
trueWhether to show DevTools buttons in the Debug toolbar.
-
dart.showIgnoreQuickFixes:booleanDefault:
trueWhether to show quick fixes for ignoring hints and lints.
-
dart.showMainCodeLens:booleanDefault:
trueWhether to show CodeLens actions in the editor for quick running / debugging scripts with main functions.
-
dart.showTestCodeLens:booleanDefault:
trueWhether to show CodeLens actions in the editor for quick running / debugging tests.
-
dart.showTodos:booleanDefault:
trueWhether to show TODOs in the Problems list.
-
dart.triggerSignatureHelpAutomatically:booleanWhether to automatically trigger signature help when pressing keys such as , and (.
-
dart.updateImportsOnRename:booleanDefault:
trueWhether to automatically update imports when moving or renaming files. Currently only supports single file moves / renames.
-
dart.useKnownChromeOSPorts:booleanDefault:
trueWhether to use specific ports for the VM service and DevTools when running in Chrome OS. This is required to connect from the native Chrome OS browser but will prevent apps from launching if the ports are already in-use (for example if trying to run a second app).
-
dart.vmAdditionalArgs:arrayDefault:
{}Array items:
{type = "string"}Additional args to pass to the Dart VM when running/debugging command line apps.
-
dart.vmServiceLogFile:null|stringDefault:
vim.NILnull
-
dart.warnWhenEditingFilesInPubCache:booleanDefault:
truenull
-
dart.warnWhenEditingFilesOutsideWorkspace:booleanDefault:
trueWhether to show a warning when modifying files outside of the workspace.
-
dart.webDaemonLogFile:null|stringDefault:
vim.NILnull
require'lspconfig'.dartls.setup{}
Commands:
Default Values:
cmd = { "dart", "./snapshots/analysis_server.dart.snapshot", "--lsp" }
filetypes = { "dart" }
init_options = {
closingLabels = false,
flutterOutline = false,
onlyAnalyzeProjectsWithOpenFiles = false,
outline = false,
suggestFromUnimportedLibraries = true
}
root_dir = root_pattern("pubspec.yaml")https://github.com/iamcco/diagnostic-languageserver
Diagnostic language server integrate with linters.
Can be installed in Nvim with :LspInstall diagnosticls
require'lspconfig'.diagnosticls.setup{}
Commands:
Default Values:
cmd = { "diagnostic-languageserver", "--stdio" }
filetypes = Empty by default, override to add filetypes
root_dir = Vim's starting directoryhttps://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'lspconfig'.dockerls.setup{}
Commands:
Default Values:
cmd = { "docker-langserver", "--stdio" }
filetypes = { "Dockerfile", "dockerfile" }
root_dir = root_pattern("Dockerfile")https://github.com/mattn/efm-langserver
General purpose Language Server that can use specified error message format generated from specified command.
require'lspconfig'.efm.setup{}
Commands:
Default Values:
cmd = { "efm-langserver" }
root_dir = root_pattern(".git")https://github.com/elixir-lsp/elixir-ls
elixir-ls can be installed via :LspInstall elixirls or by yourself by following the instructions here.
This language server does not provide a global binary, but must be installed manually. The command :LspInstaller elixirls makes an attempt at installing the binary by
Fetching the elixir-ls repository from GitHub, compiling it and then installing it.
require'lspconfig'.elixirls.setup{
-- Unix
cmd = { "path/to/language_server.sh" };
-- Windows
cmd = { "path/to/language_server.bat" };
...
}Can be installed in Nvim with :LspInstall elixirls
This server accepts configuration via the settings key.
Available settings:
-
elixirLS.dialyzerEnabled:booleanDefault:
trueRun ElixirLS's rapid Dialyzer when code is saved
-
elixirLS.dialyzerFormat:enum { "dialyzer", "dialyxir_short", "dialyxir_long" }Default:
"dialyzer"Formatter to use for Dialyzer warnings
-
elixirLS.dialyzerWarnOpts:arrayDefault:
{}Array items:
{enum = { "error_handling", "no_behaviours", "no_contracts", "no_fail_call", "no_fun_app", "no_improper_lists", "no_match", "no_missing_calls", "no_opaque", "no_return", "no_undefined_callbacks", "no_unused", "underspecs", "unknown", "unmatched_returns", "overspecs", "specdiffs" },type = "string"}Dialyzer options to enable or disable warnings. See Dialyzer's documentation for options. Note that the "race_conditions" option is unsupported
-
elixirLS.fetchDeps:booleanDefault:
trueAutomatically fetch project dependencies when compiling
-
elixirLS.mixEnv:stringDefault:
"test"Mix environment to use for compilation
-
elixirLS.projectDir:stringSubdirectory containing Mix project if not in the project root
-
elixirLS.suggestSpecs:booleanDefault:
trueSuggest @spec annotations inline using Dialyzer's inferred success typings (Requires Dialyzer)
require'lspconfig'.elixirls.setup{}
Commands:
Default Values:
cmd = { "language_server.sh" }
filetypes = { "elixir", "eelixir" }
root_dir = root_pattern("mix.exs", ".git") or vim.loop.os_homedir()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.disableElmLSDiagnostics:booleanDisable linting diagnostics from the language server.
-
elmLS.elmAnalyseTrigger:enum { "change", "save", "never" }Default:
"never"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'lspconfig'.elmls.setup{}
Commands:
Default Values:
cmd = { "elm-language-server" }
filetypes = { "elm" }
init_options = {
elmAnalyseTrigger = "change",
elmFormatPath = "elm-format",
elmPath = "elm",
elmTestPath = "elm-test"
}
root_dir = root_pattern("elm.json")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.
npx 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'lspconfig'.flow.setup{}
Commands:
Default Values:
cmd = { "npx", "--no-install", "flow", "lsp" }
filetypes = { "javascript", "javascriptreact", "javascript.jsx" }
root_dir = root_pattern(".flowconfig")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.disableDiagnostics:booleanDisable diagnostics (requires v1.12.0+).
-
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'lspconfig'.fortls.setup{}
Commands:
Default Values:
cmd = { "fortls" }
filetypes = { "fortran" }
root_dir = root_pattern(".fortls")
settings = {
nthreads = 1
}https://github.com/godotengine/godot
Language server for GDScript, used by Godot Engine.
require'lspconfig'.gdscript.setup{}
Commands:
Default Values:
cmd = { "nc", "localhost", "6008" }
filetypes = { "gd", "gdscript", "gdscript3" }
root_dir = <function 1>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'lspconfig'.ghcide.setup{}
Commands:
Default Values:
cmd = { "ghcide", "--lsp" }
filetypes = { "haskell", "lhaskell" }
root_dir = root_pattern("stack.yaml", "hie-bios", "BUILD.bazel", "cabal.config", "package.yaml")https://github.com/golang/tools/tree/master/gopls
Google's lsp server for golang.
require'lspconfig'.gopls.setup{}
Commands:
Default Values:
cmd = { "gopls" }
filetypes = { "go", "gomod" }
root_dir = root_pattern("go.mod", ".git")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:
-
haskell.completionSnippetsOn:booleanDefault:
trueShow snippets with type information when using code completion
-
haskell.diagnosticsOnChange:booleanDefault:
trueCompute diagnostics continuously as you type. Turn off to only generate diagnostics on file save.
-
haskell.formatOnImportOn:booleanDefault:
trueWhen adding an import, use the formatter on the result
-
haskell.formattingProvider:enum { "brittany", "floskell", "fourmolu", "ormolu", "stylish-haskell", "none" }Default:
"ormolu"The formatter to use when formatting a document or range
-
haskell.hlintOn:booleanDefault:
trueGet suggestions from hlint
-
haskell.languageServerVariant:enum { "haskell-ide-engine", "haskell-language-server", "ghcide" }Default:
"haskell-language-server"Which language server to use.
-
haskell.liquidOn:booleanGet diagnostics from liquid haskell
-
haskell.logFile:stringDefault:
""If set, redirects the logs to a file.
-
haskell.maxNumberOfProblems:numberDefault:
100Controls the maximum number of problems produced by the server
-
haskell.releasesURL:stringDefault:
""An optional URL to override where to check for haskell-language-server releases
-
haskell.serverExecutablePath:stringDefault:
""Manually set a language server executable. Can be something on the
$PATH or a path to an executable itself. Works with ~, $ {HOME} and ${workspaceFolder}. -
haskell.trace.server:enum { "off", "messages" }Default:
"off"Traces the communication between VS Code and the language server.
-
haskell.updateBehavior:enum { "keep-up-to-date", "prompt", "never-check" }Default:
"keep-up-to-date"null
require'lspconfig'.hie.setup{}
Commands:
Default Values:
cmd = { "hie-wrapper", "--lsp" }
filetypes = { "haskell" }
root_dir = root_pattern("stack.yaml", "package.yaml", ".git")https://github.com/haskell/haskell-language-server
Haskell Language Server
require'lspconfig'.hls.setup{}
Commands:
Default Values:
cmd = { "haskell-language-server-wrapper", "--lsp" }
filetypes = { "haskell", "lhaskell" }
root_dir = root_pattern("*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml")https://github.com/vscode-langservers/vscode-html-languageserver-bin
html-languageserver can be installed via :LspInstall html or by yourself with npm:
npm install -g vscode-html-languageserver-binCan be installed in Nvim with :LspInstall html
require'lspconfig'.html.setup{}
Commands:
Default Values:
cmd = { "html-languageserver", "--stdio" }
filetypes = { "html" }
init_options = {
configurationSection = { "html", "css", "javascript" },
embeddedLanguages = {
css = true,
javascript = true
}
}
root_dir = <function 1>
settings = {}intelephense can be installed via :LspInstall intelephense or by yourself with npm:
npm install -g intelephenseCan be installed in Nvim with :LspInstall intelephense
require'lspconfig'.intelephense.setup{}
Commands:
Default Values:
cmd = { "intelephense", "--stdio" }
filetypes = { "php" }
root_dir = root_pattern("composer.json", ".git")https://projects.eclipse.org/projects/eclipse.jdt.ls
Language server can be installed with :LspInstall jdtls
Language server for Java.
Can be installed in Nvim with :LspInstall jdtls
require'lspconfig'.jdtls.setup{}
Commands:
Default Values:
handlers = {
["textDocument/codeAction"] = <function 1>
}
filetypes = { "java" }
init_options = {
jvm_args = {},
workspace = "/home/runner/workspace"
}
root_dir = root_pattern(".git")https://github.com/pappasam/jedi-language-server
jedi-language-server, a language server for Python, built on top of jedi
require'lspconfig'.jedi_language_server.setup{}
Commands:
Default Values:
cmd = { "jedi-language-server" }
filetypes = { "python" }
root_dir = vim's starting directoryhttps://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.schemaDownload.enable:booleanDefault:
true%json.enableSchemaDownload.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'lspconfig'.jsonls.setup{}
Commands:
Default Values:
cmd = { "vscode-json-languageserver", "--stdio" }
filetypes = { "json" }
root_dir = root_pattern(".git", vim.fn.getcwd())https://github.com/julia-vscode/julia-vscode
LanguageServer.jl can be installed via :LspInstall julials or by yourself the julia and Pkg:
julia --project=/home/runner/.cache/nvim/lspconfig/julials -e 'using Pkg; Pkg.add("LanguageServer"); Pkg.add("SymbolServer")'If you want to install the LanguageServer manually, you will have to ensure that the Julia environment is stored in this location:
:lua print(require'lspconfig'.util.path.join(require'lspconfig'.util.base_install_dir, "julials"))Can be installed in Nvim with :LspInstall julials
This server accepts configuration via the settings key.
Available settings:
-
julia.NumThreads:integer|nullDefault:
vim.NILNumber of threads to use for Julia processes.
-
julia.additionalArgs:arrayDefault:
{}Additional julia arguments.
-
julia.enableCrashReporter:boolean|nullDefault:
vim.NILEnable crash reports to be sent to the julia VS Code extension developers.
-
julia.enableTelemetry:boolean|nullDefault:
vim.NILEnable usage data and errors to be sent to the julia VS Code extension developers.
-
julia.environmentPath:string|nullDefault:
vim.NILPath to a julia environment.
-
julia.executablePath:stringDefault:
""Points to the julia executable.
-
julia.execution.codeInREPL:booleanPrint executed code in REPL and append it to the REPL history.
-
julia.execution.resultType:enum { "REPL", "inline", "both" }Default:
"REPL"Specifies how to show inline execution results
-
julia.format.calls:booleanDefault:
trueFormat function calls.
-
julia.format.comments:booleanDefault:
trueFormat comments.
-
julia.format.curly:booleanDefault:
trueFormat braces.
-
julia.format.docs:booleanDefault:
trueFormat inline documentation.
-
julia.format.indent:integerDefault:
4Indent size for formatting.
-
julia.format.indents:booleanDefault:
trueFormat file indents.
-
julia.format.iterOps:booleanDefault:
trueFormat loop iterators.
-
julia.format.keywords:boolDefault:
trueEnsure single spacing following keywords.
-
julia.format.kwarg:enum { "none", "single", "off" }Default:
"none"Format whitespace around function keyword arguments.
-
julia.format.ops:booleanDefault:
trueFormat whitespace around operators.
-
julia.format.tuples:booleanDefault:
trueFormat tuples.
-
julia.lint.call:booleanDefault:
trueThis compares call signatures against all known methods for the called function. Calls with too many or too few arguments, or unknown keyword parameters are highlighted.
-
julia.lint.constif:booleanDefault:
trueCheck for constant conditionals in if statements that result in branches never being reached..
-
julia.lint.datadecl:booleanDefault:
trueCheck variables used in type declarations are datatypes.
-
julia.lint.disabledDirs:arrayDefault:
{ "docs", "test" }null
-
julia.lint.iter:booleanDefault:
trueCheck iterator syntax of loops. Will identify, for example, attempts to iterate over single values.
-
julia.lint.lazy:booleanDefault:
trueCheck for deterministic lazy boolean operators.
-
julia.lint.missingrefs:enum { "none", "symbols", "all" }Default:
"none"Highlight unknown symbols. The `symbols` option will not mark unknown fields.
-
julia.lint.modname:booleanDefault:
trueCheck submodule names do not shadow their parent's name.
-
julia.lint.nothingcomp:booleanDefault:
trueCheck for use of `==` rather than `===` when comparing against `nothing`.
-
julia.lint.pirates:booleanDefault:
trueCheck for type piracy - the overloading of external functions with methods specified for external datatypes. 'External' here refers to imported code.
-
julia.lint.run:booleanDefault:
trueRun the linter on active files.
-
julia.lint.typeparam:booleanDefault:
trueCheck parameters declared in `where` statements or datatype declarations are used.
-
julia.lint.useoffuncargs:booleanDefault:
trueCheck that all declared arguments are used within the function body.
-
julia.packageServer:stringDefault:
""Julia package server. Set's the `JULIA_PKG_SERVER` environment variable *before* starting a Julia process. Leave this empty to use the systemwide default. Requires a restart of the Julia process.
-
julia.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VS Code and the language server.
-
julia.useCustomSysimage:booleanUse an existing custom sysimage when starting the REPL
-
julia.usePlotPane:booleanDefault:
trueDisplay plots within vscode.
-
julia.useRevise:booleanDefault:
trueLoad Revise.jl on startup of the REPL.
require'lspconfig'.julials.setup{}
Commands:
Default Values:
cmd = { "julia", "--project=/home/runner/.cache/nvim/lspconfig/julials", "--startup-file=no", "--history-file=no", "-e", ' using Pkg;\n Pkg.instantiate()\n using LanguageServer; using SymbolServer;\n depot_path = get(ENV, "JULIA_DEPOT_PATH", "")\n project_path = dirname(something(Base.current_project(pwd()), Base.load_path_expand(LOAD_PATH[2])))\n # Make sure that we only load packages from this environment specifically.\n empty!(LOAD_PATH)\n push!(LOAD_PATH, "@")\n @info "Running language server" env=Base.load_path()[1] pwd() project_path depot_path\n server = LanguageServer.LanguageServerInstance(stdin, stdout, project_path, depot_path);\n server.runlinter = true;\n run(server);\n ' }
filetypes = { "julia" }
root_dir = <function 1>A kotlin language server which was developed for internal usage and
released afterwards. Maintaining is not done by the original author,
but by fwcd.
It is builded via gradle and developed on github.
Source and additional description:
https://github.com/fwcd/kotlin-language-server
This server accepts configuration via the settings key.
Available settings:
-
kotlin.compiler.jvm.target:stringDefault:
"default"Specifies the JVM target, e.g. "1.6" or "1.8"
-
kotlin.completion.snippets.enabled:booleanDefault:
trueSpecifies whether code completion should provide snippets (true) or plain-text items (false).
-
kotlin.debounceTime:integerDefault:
250[DEPRECATED] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.
-
kotlin.debugAdapter.enabled:booleanDefault:
true[Recommended] Specifies whether the debug adapter should be used. When enabled a debugger for Kotlin will be available.
-
kotlin.debugAdapter.path:stringDefault:
""Optionally a custom path to the debug adapter executable.
-
kotlin.externalSources.autoConvertToKotlin:booleanDefault:
trueSpecifies whether decompiled/external classes should be auto-converted to Kotlin.
-
kotlin.externalSources.useKlsScheme:booleanDefault:
true[Recommended] Specifies whether URIs inside JARs should be represented using the 'kls'-scheme.
-
kotlin.languageServer.debugAttach.autoSuspend:boolean[DEBUG] If enabled (together with debugAttach.enabled), the language server will not immediately launch but instead listen on the specified attach port and wait for a debugger. This is ONLY useful if you need to debug the language server ITSELF.
-
kotlin.languageServer.debugAttach.enabled:boolean[DEBUG] Whether the language server should listen for debuggers, i.e. be debuggable while running in VSCode. This is ONLY useful if you need to debug the language server ITSELF.
-
kotlin.languageServer.debugAttach.port:integerDefault:
5005[DEBUG] If transport is stdio this enables you to attach to the running langugage server with a debugger. This is ONLY useful if you need to debug the language server ITSELF.
-
kotlin.languageServer.enabled:booleanDefault:
true[Recommended] Specifies whether the language server should be used. When enabled the extension will provide code completions and linting, otherwise just syntax highlighting. Might require a reload to apply.
-
kotlin.languageServer.path:stringDefault:
""Optionally a custom path to the language server executable.
-
kotlin.languageServer.port:integerDefault:
0The port to which the client will attempt to connect to. A random port is used if zero. Only used if the transport layer is TCP.
-
kotlin.languageServer.transport:enum { "stdio", "tcp" }Default:
"stdio"The transport layer beneath the language server protocol. Note that the extension will launch the server even if a TCP socket is used.
-
kotlin.linting.debounceTime:integerDefault:
250[DEBUG] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.
-
kotlin.snippetsEnabled:booleanDefault:
true[DEPRECATED] Specifies whether code completion should provide snippets (true) or plain-text items (false).
-
kotlin.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VSCode and the Kotlin language server.
require'lspconfig'.kotlin_language_server.setup{}
Commands:
Default Values:
cmd = { "kotlin-language-server" }
filetypes = { "kotlin" }
root_dir = root_pattern("settings.gradle")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. DO NOT CHANGE from the default `lean` unless you know what you're doing!
-
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 `\foo` to `βΊ`.
-
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. DO NOT CHANGE from the default `leanpkg` unless you know what you're doing!
-
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'lspconfig'.leanls.setup{}
Commands:
Default Values:
cmd = { "lean-language-server", "--stdio" }
filetypes = { "lean" }
root_dir = util.root_pattern(".git")To target a specific version on Metals, set the following. If nothing is set, the latest stable will be used.
let g:metals_server_version = '0.8.4+106-5f2b9350-SNAPSHOT'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.ammoniteJvmProperties:arrayArray items:
{type = "string"}null
-
metals.bloopSbtAlreadyInstalled:booleannull
-
metals.bloopVersion:stringnull
-
metals.customRepositories:arrayArray items:
{type = "string"}null
-
metals.enableStripMarginOnTypeFormatting:booleanDefault:
truenull
-
metals.excludedPackages:arrayDefault:
{}null
-
metals.gradleScript:stringnull
-
metals.javaHome:stringnull
-
metals.mavenScript:stringnull
-
metals.millScript:stringnull
-
metals.sbtScript:stringnull
-
metals.scalafixConfigPath:stringnull
-
metals.scalafmtConfigPath:stringnull
-
metals.serverProperties:arrayArray items:
{type = "string"}null
-
metals.serverVersion:stringDefault:
"0.9.5"null
-
metals.showImplicitArguments:booleannull
-
metals.showInferredType:booleannull
-
metals.superMethodLensesEnabled:booleanEnable/disable goto super method code lens.
require'lspconfig'.metals.setup{}
Commands:
Default Values:
cmd = { "metals" }
filetypes = { "scala" }
init_options = {
compilerOptions = {
snippetAutoIndent = false
},
isHttpEnabled = true,
statusBarProvider = "show-message"
}
message_level = 4
root_dir = util.root_pattern("build.sbt", "build.sc", "build.gradle", "pom.xml")https://github.com/PMunch/nimlsp
nimlsp can be installed via :LspInstall nimls or by yourself the nimble package manager:
nimble install nimlspCan be installed in Nvim with :LspInstall nimls
This server accepts configuration via the settings key.
Available settings:
-
nim.buildCommand:stringDefault:
"c"Nim build command (c, cpp, doc, etc)
-
nim.buildOnSave:booleanExecute build task from tasks.json file on save.
-
nim.enableNimsuggest:booleanDefault:
trueEnable calling nimsuggest process to provide completion suggestions, hover suggestions, etc. This option requires restart to take effect.
-
nim.licenseString:stringDefault:
""Optional license text that will be inserted on nim file creation.
-
nim.lintOnSave:booleanDefault:
trueCheck code by using 'nim check' on save.
-
nim.logNimsuggest:booleanEnable verbose logging of nimsuggest to use profile directory.
-
nim.nimprettyIndent:integerDefault:
0Nimpretty: set the number of spaces that is used for indentation --indent:0 means autodetection (default behaviour).
-
nim.nimprettyMaxLineLen:integerDefault:
80Nimpretty: set the desired maximum line length (default: 80).
-
nim.nimsuggestRestartTimeout:integerDefault:
60Nimsuggest will be restarted after this timeout in minutes, if 0 then restart disabled. This option requires restart to take effect.
-
nim.project:arrayDefault:
{}Nim project file, if empty use current selected.
-
nim.projectMapping:objectDefault:
vim.empty_dict()For non project mode list of per file project mapping using regex, for example ```{"(.*).inim": "$1.nim"}```
-
nim.runOutputDirectory:stringDefault:
""Output directory for run selected file command. The directory is relative to the workspace root.
-
nim.test-project:stringDefault:
""Optional test project.
require'lspconfig'.nimls.setup{}
Commands:
Default Values:
cmd = { "nimlsp" }
filetypes = { "nim" }
root_dir = root_pattern(".git") or os_homedirhttps://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'lspconfig'.ocamlls.setup{}
Commands:
Default Values:
cmd = { "ocaml-language-server", "--stdio" }
filetypes = { "ocaml", "reason" }
root_dir = root_pattern(".merlin", "package.json")https://github.com/ocaml/ocaml-lsp
ocaml-lsp can be installed as described in installation guide.
To install the lsp server in a particular opam switch:
opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git
opam install ocaml-lsp-serverrequire'lspconfig'.ocamllsp.setup{}
Commands:
Default Values:
cmd = { "ocamllsp" }
filetypes = { "ocaml", "reason" }
root_dir = root_pattern(".merlin", "package.json")https://github.com/omnisharp/omnisharp-roslyn OmniSharp server based on Roslyn workspaces
Can be installed in Nvim with :LspInstall omnisharp
require'lspconfig'.omnisharp.setup{}
Commands:
Default Values:
cmd = { "/home/runner/.cache/nvim/lspconfig/omnisharp/run", "--languageserver", "--hostPID", "2529" }
filetypes = { "cs", "vb" }
init_options = {}
on_new_config = <function 1>
root_dir = root_pattern(".csproj", ".sln", ".git")https://github.com/nwolverson/purescript-language-server
purescript-language-server can be installed via :LspInstall purescriptls or by yourself with npm
npm install -g purescript-language-serverCan be installed in Nvim with :LspInstall purescriptls
This server accepts configuration via the settings key.
Available settings:
-
purescript.addNpmPath:booleanWhether to add the local npm bin directory to the PATH for purs IDE server and build command.
-
purescript.addPscPackageSources:booleanWhether to add psc-package sources to the globs passed to the IDE server for source locations (specifically the output of `psc-package sources`, if this is a psc-package project). Update due to adding packages/changing package set requires psc-ide server restart.
-
purescript.addSpagoSources:booleanDefault:
trueWhether to add spago sources to the globs passed to the IDE server for source locations (specifically the output of `spago sources`, if this is a spago project). Update due to adding packages/changing package set requires psc-ide server restart.
-
purescript.autoStartPscIde:booleanDefault:
trueWhether to automatically start/connect to purs IDE server when editing a PureScript file (includes connecting to an existing running instance). If this is disabled, various features like autocomplete, tooltips, and other type info will not work until start command is run manually.
-
purescript.autocompleteAddImport:booleanDefault:
trueWhether to automatically add imported identifiers when accepting autocomplete result.
-
purescript.autocompleteAllModules:booleanDefault:
trueWhether to always autocomplete from all built modules, or just those imported in the file. Suggestions from all modules always available by explicitly triggering autocomplete.
-
purescript.autocompleteGrouped:booleanDefault:
trueWhether to group completions in autocomplete results. Requires compiler 0.11.6
-
purescript.autocompleteLimit:null|integerDefault:
vim.NILMaximum number of results to fetch for an autocompletion request. May improve performance on large projects.
-
purescript.buildCommand:stringDefault:
"spago build --purs-args --json-errors"Build command to use with arguments. Not passed to shell. eg `pulp build -- --json-errors` (this default requires pulp >=10)
-
purescript.censorWarnings:arrayDefault:
{}Array items:
{type = "string"}The warning codes to censor, both for fast rebuild and a full build. Unrelated to any psa setup. e.g.: ["ShadowedName","MissingTypeDeclaration"]
-
purescript.codegenTargets:arrayDefault:
vim.NILArray items:
{type = "string"}List of codegen targets to pass to the compiler for rebuild. e.g. js, corefn. If not specified (rather than empty array) this will not be passed and the compiler will default to js. Requires 0.12.1+
-
purescript.editorMode:boolean(DEPRECATED - ignored from purs 0.13.8) Whether to set the editor-mode flag on the IDE server
-
purescript.fastRebuild:booleanDefault:
trueEnable purs IDE server fast rebuild
-
purescript.importsPreferredModules:arrayDefault:
{ "Prelude" }Array items:
{type = "string"}Module to prefer to insert when adding imports which have been re-exported. In order of preference, most preferred first.
-
purescript.outputDirectory:stringDefault:
"output/"Override purs ide output directory (output/ if not specified). This should match up to your build command
-
purescript.packagePath:stringDefault:
""Path to installed packages. Will be used to control globs passed to IDE server for source locations. Change requires IDE server restart.
-
purescript.polling:boolean(DEPRECATED - ignored from purs 0.13.8) Whether to set the polling flag on the IDE server
-
purescript.preludeModule:stringDefault:
"Prelude"Module to consider as your default prelude, if an auto-complete suggestion comes from this module it will be imported unqualified.
-
purescript.pscIdePort:integer|nullDefault:
vim.NILPort to use for purs IDE server (whether an existing server or to start a new one). By default a random port is chosen (or an existing port in .psc-ide-port if present), if this is specified no attempt will be made to select an alternative port on failure.
-
purescript.pscIdelogLevel:stringDefault:
""Log level for purs IDE server
-
purescript.pursExe:stringDefault:
"purs"Location of purs executable (resolved wrt PATH)
-
purescript.sourcePath:stringDefault:
"src"Path to application source root. Will be used to control globs passed to IDE server for source locations. Change requires IDE server restart.
-
purescript.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VSCode and the PureScript language service.
require'lspconfig'.purescriptls.setup{}
Commands:
Default Values:
cmd = { "purescript-language-server", "--stdio" }
filetypes = { "purescript" }
root_dir = root_pattern("spago.dhall, bower.json")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.env_vars:dictionaryDefault:
vim.NILDefine environment variables for jedi.Script and Jedi.names.
-
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.fuzzy:booleanEnable fuzzy when requesting autocomplete.
-
pyls.plugins.jedi_completion.include_class_objects:booleanDefault:
trueAdds class objects as a separate completion item.
-
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.pylint.executable:stringDefault:
vim.NILExecutable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3.
-
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 `null` for not using such a folder at all.
require'lspconfig'.pyls.setup{}
Commands:
Default Values:
cmd = { "pyls" }
filetypes = { "python" }
root_dir = vim's starting directoryhttps://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 | shpython-language-server can be installed via :LspInstall pyls_ms or you can build your own.
If you want to use your own build, set cmd to point to Microsoft.Python.languageServer.dll.
cmd = { "dotnet", "exec", "path/to/Microsoft.Python.languageServer.dll" };If the python interpreter is not in your PATH environment variable, set the InterpreterPath and Version properties accordingly.
InterpreterPath = "path/to/python",
Version = "3.8"This server accepts configuration via the settings key.
Can be installed in Nvim with :LspInstall pyls_ms
require'lspconfig'.pyls_ms.setup{}
Commands:
Default Values:
filetypes = { "python" }
init_options = {
analysisUpdates = true,
asyncStartup = true,
displayOptions = {},
interpreter = {
properties = {
InterpreterPath = "",
Version = ""
}
}
}
on_new_config = <function 1>
root_dir = vim's starting directory
settings = {
python = {
analysis = {
disabled = {},
errors = {},
info = {}
}
}
}[languageserver](https://github.com/REditorSupport/languageserver) is an
implementation of the Microsoft's Language Server Protocol for the R
language.
It is released on CRAN and can be easily installed by
```R
install.packages("languageserver")
```
This server accepts configuration via the settings key.
Available settings:
-
r.lsp.args:arrayDefault:
{}The command line arguments to use when launching R Language Server
-
r.lsp.debug:booleanDebug R Language Server
-
r.lsp.diagnostics:booleanDefault:
trueEnable Diagnostics
-
r.lsp.lang:stringDefault:
""Override default LANG environment variable
-
r.lsp.path:stringDefault:
""Path to R binary for launching Language Server
-
r.lsp.use_stdio:booleanUse STDIO connection instead of TCP. (Unix/macOS users only)
require'lspconfig'.r_language_server.setup{}
Commands:
Default Values:
cmd = { "R", "--slave", "-e", "languageserver::run()" }
filetypes = { "r", "rmd" }
log_level = 2
root_dir = root_pattern(".git") or os_homedirhttps://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.autoStartRls:booleanDefault:
trueStart RLS automatically when opening a file or project.
-
rust-client.channelDefault:
"default"Rust 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/rust-analyzer from PATH.
-
rust-client.enableMultiProjectSetup:boolean|nullDefault:
vim.NILAllow multiple projects in the same folder, along with removing the constraint that the cargo.toml must be located at the root. (Experimental: might not work for certain setups)
-
rust-client.engine:enum { "rls", "rust-analyzer" }Default:
"rls"The underlying LSP server used to provide IDE support for Rust projects.
-
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.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.channel` to ensure your RLS sees the right libraries. If you don't use rustup, make sure to set `rust-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 Rust toolchain and its required components whenever the extension starts up.
-
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>`. Use `null` to 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. Implies `rust.build_on_save`: true.
-
rust.build_lib:boolean|nullDefault:
vim.NILSpecify to run analysis as if running `cargo check --lib`. Use `null` to 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::all` unless 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.rust-analyzer:objectDefault:
vim.empty_dict()Settings passed down to rust-analyzer server
-
rust.rust-analyzer.path:string|nullDefault:
vim.NILWhen specified, uses the rust-analyzer binary at a given path
-
rust.rust-analyzer.releaseTag:stringDefault:
"nightly"Which binary release to download and use
-
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:number|nullDefault:
vim.NILTime in milliseconds between receiving a change notification and starting build.
require'lspconfig'.rls.setup{}
Commands:
Default Values:
cmd = { "rls" }
filetypes = { "rust" }
root_dir = root_pattern("Cargo.toml")https://github.com/nix-community/rnix-lsp
A language server for Nix providing basic completion and formatting via nixpkgs-fmt.
To install manually, run cargo install rnix-lsp. If you are using nix, rnix-lsp is in nixpkgs.
This server accepts configuration via the settings key.
Can be installed in Nvim with :LspInstall rnix
require'lspconfig'.rnix.setup{}
Commands:
Default Values:
cmd = { "rnix-lsp" }
filetypes = { "nix" }
init_options = {}
on_new_config = <function 1>
root_dir = vim's starting directory
settings = {}Language server for the Rome Frontend Toolchain.
npm install [-g] romerequire'lspconfig'.rome.setup{}
Commands:
Default Values:
cmd = { "rome", "lsp" }
filetypes = { "javascript", "javascriptreact", "json", "typescript", "typescript.tsx", "typescriptreact" }
root_dir = root_pattern('package.json', 'node_modules', '.git') or dirnamehttps://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.assist.importMergeBehaviour:enum { "none", "full", "last" }Default:
"full"The strategy to use when inserting new imports or merging imports.
-
rust-analyzer.assist.importPrefix:enum { "plain", "by_self", "by_crate" }Default:
"plain"The path structure for newly inserted paths to use.
-
rust-analyzer.callInfo.full:booleanDefault:
trueShow function name and docs in parameter hints
-
rust-analyzer.cargo.allFeatures:booleanActivate all available features
-
rust-analyzer.cargo.autoreload:booleanDefault:
truenull
-
rust-analyzer.cargo.features:arrayDefault:
{}Array items:
{type = "string"}List of features to activate
-
rust-analyzer.cargo.loadOutDirsFromCheck:booleannull
-
rust-analyzer.cargo.noDefaultFeatures:booleannull
-
rust-analyzer.cargo.target:null|stringDefault:
vim.NILSpecify the compilation target
-
rust-analyzer.cargoRunner:null|stringDefault:
vim.NILCustom cargo runner extension ID.
-
rust-analyzer.checkOnSave.allFeatures:null|booleanDefault:
vim.NILnull
-
rust-analyzer.checkOnSave.allTargets:booleanDefault:
truenull
-
rust-analyzer.checkOnSave.command:stringDefault:
"check"null
-
rust-analyzer.checkOnSave.enable:booleanDefault:
truenull
-
rust-analyzer.checkOnSave.extraArgs:arrayDefault:
{}Array items:
{type = "string"}null
-
rust-analyzer.checkOnSave.features:null|arrayDefault:
vim.NILArray items:
{type = "string"}List of features to activate. Defaults to `rust-analyzer.cargo.features`.
-
rust-analyzer.checkOnSave.noDefaultFeatures:null|booleanDefault:
vim.NILnull
-
rust-analyzer.checkOnSave.overrideCommand:null|arrayDefault:
vim.NILArray items:
{minItems = 1,type = "string"}null
-
rust-analyzer.checkOnSave.target:null|stringDefault:
vim.NILCheck for a specific target. Defaults to `rust-analyzer.cargo.target`.
-
rust-analyzer.completion.addCallArgumentSnippets:booleanDefault:
trueWhether to add argument snippets when completing functions
-
rust-analyzer.completion.addCallParenthesis:booleanDefault:
trueWhether to add parenthesis when completing functions
-
rust-analyzer.completion.postfix.enable:booleanDefault:
truenull
-
rust-analyzer.debug.engine:enum { "auto", "vadimcn.vscode-lldb", "ms-vscode.cpptools" }Default:
"auto"Preferred debug engine.
-
rust-analyzer.debug.engineSettings:objectDefault:
vim.empty_dict()Optional settings passed to the debug engine. Example: { "lldb": { "terminal":"external"} }
-
rust-analyzer.debug.openDebugPane:booleanWhether to open up the Debug Pane on debugging start.
-
rust-analyzer.debug.sourceFileMap:objectDefault:
{["/rustc/<id>"] = "${env:USERPROFILE}/.rustup/toolchains/<toolchain-id>/lib/rustlib/src/rust"}Optional source file mappings passed to the debug engine.
-
rust-analyzer.diagnostics.disabled:arrayDefault:
{}Array items:
{type = "string"}List of rust-analyzer diagnostics to disable
-
rust-analyzer.diagnostics.enable:booleanDefault:
truenull
-
rust-analyzer.diagnostics.enableExperimental:booleanDefault:
truenull
-
rust-analyzer.diagnostics.warningsAsHint:arrayDefault:
{}Array items:
{type = "string"}List of warnings that should be displayed with hint severity. The warnings will be indicated by faded text or three dots in code and will not show up in the problems panel.
-
rust-analyzer.diagnostics.warningsAsInfo:arrayDefault:
{}Array items:
{type = "string"}List of warnings that should be displayed with info severity. The warnings will be indicated by a blue squiggly underline in code and a blue icon in the problems panel.
-
rust-analyzer.files.exclude:arrayDefault:
{}Array items:
{type = "string"}Paths to exclude from analysis.
-
rust-analyzer.files.watcher:enum { "client", "notify" }Default:
"client"Controls file watching implementation.
-
rust-analyzer.hoverActions.debug:booleanDefault:
truenull
-
rust-analyzer.hoverActions.enable:booleanDefault:
trueWhether to show HoverActions in Rust files.
-
rust-analyzer.hoverActions.gotoTypeDef:booleanDefault:
truenull
-
rust-analyzer.hoverActions.implementations:booleanDefault:
truenull
-
rust-analyzer.hoverActions.run:booleanDefault:
truenull
-
rust-analyzer.inlayHints.chainingHints:booleanDefault:
trueWhether to show inlay type hints for method chains.
-
rust-analyzer.inlayHints.enable:booleanDefault:
trueWhether to show inlay hints
-
rust-analyzer.inlayHints.maxLength:null|integerDefault:
20Maximum length for inlay hints
-
rust-analyzer.inlayHints.parameterHints:booleanDefault:
trueWhether to show function parameter name inlay hints at the call site.
-
rust-analyzer.inlayHints.typeHints:booleanDefault:
trueWhether to show inlay type hints for variables.
-
rust-analyzer.lens.debug:booleanDefault:
truenull
-
rust-analyzer.lens.enable:booleanDefault:
trueWhether to show CodeLens in Rust files.
-
rust-analyzer.lens.implementations:booleanDefault:
truenull
-
rust-analyzer.lens.methodReferences:booleannull
-
rust-analyzer.lens.run:booleanDefault:
truenull
-
rust-analyzer.linkedProjects:arrayDefault:
vim.NILArray items:
{type = { "string", "object" }}null
-
rust-analyzer.lruCapacity:null|integerDefault:
vim.NILNumber of syntax trees rust-analyzer keeps in memory.
-
rust-analyzer.noSysroot:booleannull
-
rust-analyzer.notifications.cargoTomlNotFound:booleanDefault:
truenull
-
rust-analyzer.procMacro.enable:booleanEnable Proc macro support, cargo.loadOutDirsFromCheck must be enabled.
-
rust-analyzer.runnableEnvDefault:
vim.NILEnvironment variables passed to the runnable launched using `Test ` or `Debug` lens or `rust-analyzer.run` command.
-
rust-analyzer.runnables.cargoExtraArgs:arrayDefault:
{}Array items:
{type = "string"}Additional arguments to be passed to cargo for runnables such as tests or binaries. For example, it may be '--release'
-
rust-analyzer.runnables.overrideCargo:null|stringDefault:
vim.NILCommand to be executed instead of 'cargo' for runnables.
-
rust-analyzer.rustcSource:null|stringDefault:
vim.NILPath to the rust compiler sources, for usage in rustc_private projects.
-
rust-analyzer.rustfmt.extraArgs:arrayDefault:
{}Array items:
{type = "string"}Additional arguments to rustfmt
-
rust-analyzer.rustfmt.overrideCommand:null|arrayDefault:
vim.NILArray items:
{minItems = 1,type = "string"}null
-
rust-analyzer.serverPath:null|stringDefault:
vim.NILPath to rust-analyzer executable (points to bundled binary by default). If this is set, then "rust-analyzer.updates.channel" setting is not used
-
rust-analyzer.trace.extension:booleanEnable logging of VS Code extensions itself
-
rust-analyzer.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Trace requests to the rust-analyzer (this is usually overly verbose and not recommended for regular users)
-
rust-analyzer.updates.askBeforeDownload:booleanDefault:
trueWhether to ask for permission before downloading any files from the Internet
-
rust-analyzer.updates.channel:enum { "stable", "nightly" }Default:
"stable"null
require'lspconfig'.rust_analyzer.setup{}
Commands:
Default Values:
cmd = { "rust-analyzer" }
filetypes = { "rust" }
root_dir = root_pattern("Cargo.toml", "rust-project.json")
settings = {
["rust-analyzer"] = {}
}https://github.com/crystal-lang-tools/scry
Crystal language server.
require'lspconfig'.scry.setup{}
Commands:
Default Values:
cmd = { "scry" }
filetypes = { "crystal" }
root_dir = root_pattern('shard.yml', '.git') or dirnamesolargraph, 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'. Needs to be an absolute path for the 'bundle' exec/shim
-
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. `warn` is least and `debug` is 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 exec` to run solargraph. (If this is true, the solargraph.commandPath setting is ignored.)
require'lspconfig'.solargraph.setup{}
Commands:
Default Values:
cmd = { "solargraph", "stdio" }
filetypes = { "ruby" }
root_dir = root_pattern("Gemfile", ".git")https://github.com/apple/sourcekit-lsp
Language server for Swift and C/C++/Objective-C.
This server accepts configuration via the settings key.
Available settings:
-
sourcekit-lsp.serverArguments:arrayDefault:
{}Array items:
{type = "string"}Arguments to pass to sourcekit-lsp. Argument keys and values should be provided as separate entries in the array e.g. ['--log-level', 'debug']
-
sourcekit-lsp.serverPath:stringDefault:
"sourcekit-lsp"The path of the sourcekit-lsp executable
-
sourcekit-lsp.toolchainPath:stringDefault:
""(optional) The path of the swift toolchain. By default, sourcekit-lsp uses the toolchain it is installed in.
-
sourcekit-lsp.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VS Code and the SourceKit-LSP language server.
require'lspconfig'.sourcekit.setup{}
Commands:
Default Values:
cmd = { "xcrun", "sourcekit-lsp" }
filetypes = { "swift", "c", "cpp", "objective-c", "objective-cpp" }
root_dir = root_pattern("Package.swift", ".git")https://github.com/joe-re/sql-language-server
cmd value is not set by default. An installer is provided via the :LspInstall command that uses the nvm_lsp node_modules directory to find the sql-language-server executable. The cmd value can be overriden in the setup table;
require'lspconfig'.sqlls.setup{
cmd = {"path/to/command", "up", "--method", "stdio"};
...
}This LSP can be installed via :LspInstall sqlls or with npm. If using LspInstall, run :LspInstallInfo sqlls to view installation paths. Find further instructions on manual installation of the sql-language-server at joe-re/sql-language-server.
Can be installed in Nvim with :LspInstall sqlls
require'lspconfig'.sqlls.setup{}
Commands:
Default Values:
filetypes = { "sql", "mysql" }
root_dir = <function 1>
settings = {}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.
So you should set cmd yourself like this.
require'lspconfig'.sumneko_lua.setup{
cmd = {"path", "to", "cmd"};
...
}If you install via our installer, if you execute :LspInstallInfo sumneko_lua, you can know cmd value.
Can be installed in Nvim with :LspInstall sumneko_lua
This server accepts configuration via the settings key.
Available settings:
-
Lua.awakened.cat:booleanDefault:
truenull
-
Lua.color.mode:enum { "Grammar", "Semantic" }Default:
"Semantic"null
-
Lua.completion.callSnippet:enum { "Disable", "Both", "Replace" }Default:
"Disable"null
-
Lua.completion.displayContext:integerDefault:
6null
-
Lua.completion.enable:booleanDefault:
truenull
-
Lua.completion.keywordSnippet:enum { "Disable", "Both", "Replace" }Default:
"Replace"null
-
Lua.develop.debuggerPort:integerDefault:
11412null
-
Lua.develop.debuggerWait:booleannull
-
Lua.develop.enable:booleannull
-
Lua.diagnostics.disable:arrayArray items:
{type = "string"}null
-
Lua.diagnostics.enable:booleanDefault:
truenull
-
Lua.diagnostics.globals:arrayArray items:
{type = "string"}null
-
Lua.diagnostics.severity:objectnull
-
Lua.diagnostics.workspaceDelay:integerDefault:
0null
-
Lua.diagnostics.workspaceRate:integerDefault:
100null
-
Lua.hover.enable:booleanDefault:
truenull
-
Lua.hover.fieldInfer:integerDefault:
3000null
-
Lua.hover.viewNumber:booleanDefault:
truenull
-
Lua.hover.viewString:booleanDefault:
truenull
-
Lua.hover.viewStringMax:integerDefault:
1000null
-
Lua.intelliSense.fastGlobal:booleanDefault:
truenull
-
Lua.intelliSense.searchDepth:integerDefault:
0null
-
Lua.runtime.path:arrayDefault:
{ "?.lua", "?/init.lua", "?/?.lua" }Array items:
{type = "string"}null
-
Lua.runtime.special:objectnull
-
Lua.runtime.version:enum { "Lua 5.1", "Lua 5.2", "Lua 5.3", "Lua 5.4", "LuaJIT" }Default:
"Lua 5.4"null
-
Lua.signatureHelp.enable:booleanDefault:
truenull
-
Lua.workspace.ignoreDir:arrayDefault:
{ ".vscode" }Array items:
{type = "string"}null
-
Lua.workspace.ignoreSubmodules:booleanDefault:
truenull
-
Lua.workspace.library:objectnull
-
Lua.workspace.maxPreload:integerDefault:
1000null
-
Lua.workspace.preloadFileSize:integerDefault:
100null
-
Lua.workspace.useGitIgnore:booleanDefault:
truenull
require'lspconfig'.sumneko_lua.setup{}
Commands:
Default Values:
filetypes = { "lua" }
log_level = 2
root_dir = root_pattern(".git") or os_homedirhttps://github.com/hashicorp/terraform-ls
Terraform language server Download a released binary from https://github.com/hashicorp/terraform-ls/releases.
This server accepts configuration via the settings key.
Available settings:
-
terraform-ls.excludeRootModules:arrayDefault:
{}Array items:
{type = "string"}Per-workspace list of module directories for the language server to exclude
-
terraform-ls.rootModules:arrayDefault:
{}Array items:
{type = "string"}Per-workspace list of module directories for the language server to read
-
terraform.languageServer:objectDefault:
{args = { "serve" },external = true,maxNumberOfProblems = 100,pathToBinary = "",["trace.server"] = "off"}Language Server settings
require'lspconfig'.terraformls.setup{}
Commands:
Default Values:
cmd = { "terraform-ls", "serve" }
filetypes = { "terraform" }
root_dir = root_pattern(".terraform", ".git")A completion engine built from scratch for (La)TeX.
See https://texlab.netlify.com/docs/reference/configuration for configuration options.
require'lspconfig'.texlab.setup{}
Commands:
- TexlabBuild: Build the current buffer
Default Values:
cmd = { "texlab" }
filetypes = { "tex", "bib" }
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
}
}
}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'lspconfig'.tsserver.setup{}
Commands:
Default Values:
cmd = { "typescript-language-server", "--stdio" }
filetypes = { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" }
root_dir = root_pattern("package.json", "tsconfig.json", ".git")require'lspconfig'.vimls.setup{}
Commands:
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 = ""
}
on_new_config = <function 1>
root_dir = <function 1>https://github.com/vuejs/vetur/tree/master/server
Vue language server(vls)
vue-language-server can be installed via :LspInstall vuels or by yourself with npm:
npm install -g vlsCan be installed in Nvim with :LspInstall vuels
This server accepts configuration via the settings key.
Available settings:
-
vetur.completion.autoImport:booleanDefault:
trueInclude completion for module export and auto import them
-
vetur.completion.scaffoldSnippetSources:objectDefault:
{user = "ποΈ",vetur = "β",workspace = "πΌ"}Where Vetur source Scaffold Snippets from and how to indicate them. Set a source to "" to disable it.
- workspace: `<WORKSPACE>/.vscode/vetur/snippets`. - user: `<USER-DATA-DIR>/User/snippets/vetur`. - vetur: Bundled in Vetur.
The default is: ``` "vetur.completion.scaffoldSnippetSources": { "workspace": "πΌ", "user": "ποΈ", "vetur": "β" } ```
Alternatively, you can do:
``` "vetur.completion.scaffoldSnippetSources": { "workspace": "(W)", "user": "(U)", "vetur": "(V)" } ```
Read more: https://vuejs.github.io/vetur/snippet.html.
-
vetur.completion.tagCasing:enum { "initial", "kebab" }Default:
"kebab"Casing conversion for tag completion
-
vetur.dev.logLevel:enum { "INFO", "DEBUG" }Default:
"INFO"Log level for VLS
-
vetur.dev.vlsPath:stringPath to vls for Vetur developers. There are two ways of using it.
1. Clone vuejs/vetur from GitHub, build it and point it to the ABSOLUTE path of `/server`. 2. `yarn global add vls` and point Vetur to the installed location (`yarn global dir` + node_modules/vls)
-
vetur.dev.vlsPort:numberDefault:
-1The port that VLS listens to. Can be used for attaching to the VLS Node process for debugging / profiling.
-
vetur.experimental.templateInterpolationService:booleanEnable template interpolation service that offers hover / definition / references in Vue interpolations.
-
vetur.format.defaultFormatter.css:enum { "none", "prettier" }Default:
"prettier"Default formatter for <style> region
-
vetur.format.defaultFormatter.html:enum { "none", "prettyhtml", "js-beautify-html", "prettier" }Default:
"prettier"Default formatter for <template> region
-
vetur.format.defaultFormatter.js:enum { "none", "prettier", "prettier-eslint", "vscode-typescript" }Default:
"prettier"Default formatter for <script> region
-
vetur.format.defaultFormatter.less:enum { "none", "prettier" }Default:
"prettier"Default formatter for <style lang='less'> region
-
vetur.format.defaultFormatter.postcss:enum { "none", "prettier" }Default:
"prettier"Default formatter for <style lang='postcss'> region
-
vetur.format.defaultFormatter.pug:enum { "none", "prettier" }Default:
"prettier"Default formatter for <template lang='pug'> region
-
vetur.format.defaultFormatter.sass:enum { "none", "sass-formatter" }Default:
"sass-formatter"Default formatter for <style lang='sass'> region
-
vetur.format.defaultFormatter.scss:enum { "none", "prettier" }Default:
"prettier"Default formatter for <style lang='scss'> region
-
vetur.format.defaultFormatter.stylus:enum { "none", "stylus-supremacy" }Default:
"stylus-supremacy"Default formatter for <style lang='stylus'> region
-
vetur.format.defaultFormatter.ts:enum { "none", "prettier", "prettier-tslint", "vscode-typescript" }Default:
"prettier"Default formatter for <script> region
-
vetur.format.defaultFormatterOptions:objectDefault:
{["js-beautify-html"] = {wrap_attributes = "force-expand-multiline"},prettyhtml = {printWidth = 100,singleQuote = false,sortAttributes = false,wrapAttributes = false}}Options for all default formatters
-
vetur.format.enable:booleanDefault:
trueEnable/disable the Vetur document formatter.
-
vetur.format.options.tabSize:numberDefault:
2Number of spaces per indentation level. Inherited by all formatters.
-
vetur.format.options.useTabs:booleanUse tabs for indentation. Inherited by all formatters.
-
vetur.format.scriptInitialIndent:booleanWhether to have initial indent for <script> region
-
vetur.format.styleInitialIndent:booleanWhether to have initial indent for <style> region
-
vetur.grammar.customBlocks:objectDefault:
{docs = "md",i18n = "json"}Mapping from custom block tag name to language name. Used for generating grammar to support syntax highlighting for custom blocks.
-
vetur.languageFeatures.codeActions:booleanDefault:
trueWhether to enable codeActions
-
vetur.trace.server:enum { "off", "messages", "verbose" }Default:
"off"Traces the communication between VS Code and Vue Language Server.
-
vetur.useWorkspaceDependencies:booleanUse dependencies from workspace. Currently only for TypeScript.
-
vetur.validation.interpolation:booleanDefault:
trueValidate interpolations in <template> region using TypeScript language service
-
vetur.validation.script:booleanDefault:
trueValidate js/ts in <script>
-
vetur.validation.style:booleanDefault:
trueValidate css/scss/less/postcss in <style>
-
vetur.validation.template:booleanDefault:
trueValidate vue-html in <template> using eslint-plugin-vue
-
vetur.validation.templateProps:booleanValidate props usage in <template> region. Show error/warning for not passing declared props to child components and show error for passing wrongly typed interpolation expressions
require'lspconfig'.vuels.setup{}
Commands:
Default Values:
cmd = { "vls" }
filetypes = { "vue" }
init_options = {
config = {
css = {},
emmet = {},
html = {
suggest = {}
},
javascript = {
format = {}
},
stylusSupremacy = {},
typescript = {
format = {}
},
vetur = {
completion = {
autoImport = false,
tagCasing = "kebab",
useScaffoldSnippets = false
},
format = {
defaultFormatter = {
js = "none",
ts = "none"
},
defaultFormatterOptions = {},
scriptInitialIndent = false,
styleInitialIndent = false
},
useWorkspaceDependencies = false,
validation = {
script = true,
style = true,
template = true
}
}
}
}
root_dir = root_pattern("package.json", "vue.config.js")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'lspconfig'.yamlls.setup{}
Commands:
Default Values:
cmd = { "yaml-language-server", "--stdio" }
filetypes = { "yaml" }
root_dir = root_pattern(".git", vim.fn.getcwd())