The following LSP configs are included. This documentation is autogenerated from the lua files. Follow a link to find documentation for
that config. This file is accessible in neovim via :help lspconfig-server-configurations
- als
- angularls
- ansiblels
- arduino_language_server
- asm_lsp
- astro
- awk_ls
- bashls
- beancount
- bicep
- bsl_ls
- ccls
- clangd
- clarity_lsp
- clojure_lsp
- cmake
- codeqlls
- crystalline
- csharp_ls
- cssls
- cssmodules_ls
- cucumber_language_server
- dartls
- denols
- dhall_lsp_server
- diagnosticls
- dockerls
- dotls
- efm
- elixirls
- elmls
- ember
- emmet_ls
- erlangls
- esbonio
- eslint
- flow
- flux_lsp
- foam_ls
- fortls
- fsautocomplete
- fstar
- gdscript
- ghcide
- glint
- golangci_lint_ls
- gopls
- gradle_ls
- grammarly
- graphql
- groovyls
- haxe_language_server
- hdl_checker
- hhvm
- hie
- hls
- hoon_ls
- html
- idris2_lsp
- intelephense
- java_language_server
- jdtls
- jedi_language_server
- jsonls
- jsonnet_ls
- julials
- kotlin_language_server
- lean3ls
- leanls
- lelwel_ls
- lemminx
- ltex
- metals
- mint
- mm0_ls
- nickel_ls
- nimls
- ocamlls
- ocamllsp
- ols
- omnisharp
- opencl_ls
- openscad_ls
- pasls
- perlls
- perlnavigator
- perlpls
- phpactor
- please
- powershell_es
- prismals
- prosemd_lsp
- psalm
- puppet
- purescriptls
- pylsp
- pyre
- pyright
- quick_lint_js
- r_language_server
- racket_langserver
- reason_ls
- remark_ls
- rescriptls
- rls
- rnix
- robotframework_ls
- rome
- rust_analyzer
- salt_ls
- scry
- serve_d
- sixtyfps
- slint_lsp
- solang
- solargraph
- solc
- solidity_ls
- sorbet
- sourcekit
- sourcery
- spectral
- sqlls
- sqls
- steep
- stylelint_lsp
- sumneko_lua
- svelte
- svls
- tailwindcss
- taplo
- teal_ls
- terraform_lsp
- terraformls
- texlab
- tflint
- theme_check
- tsserver
- typeprof
- vala_ls
- vdmj
- verible
- vimls
- vls
- volar
- vuels
- yamlls
- zeta_note
- zk
- zls
https://github.com/AdaCore/ada_language_server
Installation instructions can be found here.
Can be configured by passing a "settings" object to als.setup{}
:
require('lspconfig').als.setup{
settings = {
ada = {
projectFile = "project.gpr";
scenarioVariables = { ... };
}
}
}
Snippet to enable the language server:
require'lspconfig'.als.setup{}
Default values:
cmd
:
{ "ada_language_server" }
filetypes
:
{ "ada" }
root_dir
:
util.root_pattern("Makefile", ".git", "*.gpr", "*.adc")
https://github.com/angular/vscode-ng-language-service
angular-language-server
can be installed via npm npm install -g @angular/language-server
.
Note, that if you override the default cmd
, you must also update on_new_config
to set new_config.cmd
during startup.
local project_library_path = "/path/to/project/lib"
local cmd = {"ngserver", "--stdio", "--tsProbeLocations", project_library_path , "--ngProbeLocations", project_library_path}
require'lspconfig'.angularls.setup{
cmd = cmd,
on_new_config = function(new_config,new_root_dir)
new_config.cmd = cmd
end,
}
Snippet to enable the language server:
require'lspconfig'.angularls.setup{}
Default values:
cmd
:
{ "ngserver", "--stdio", "--tsProbeLocations", "", "--ngProbeLocations", "" }
filetypes
:
{ "typescript", "html", "typescriptreact", "typescript.tsx" }
root_dir
:
root_pattern("angular.json", ".git")
https://github.com/ansible/ansible-language-server
Language server for the ansible configuration management tool.
ansible-language-server
can be installed via npm
:
npm install -g @ansible/ansible-language-server
Snippet to enable the language server:
require'lspconfig'.ansiblels.setup{}
Default values:
cmd
:
{ "ansible-language-server", "--stdio" }
filetypes
:
{ "yaml.ansible" }
root_dir
:
see source file
settings
:
{
ansible = {
ansible = {
path = "ansible"
},
ansibleLint = {
enabled = true,
path = "ansible-lint"
},
executionEnvironment = {
enabled = false
},
python = {
interpreterPath = "python"
}
}
}
single_file_support
:
true
https://github.com/arduino/arduino-language-server
Language server for Arduino
The arduino-language-server
can be installed by running:
go get -u github.com/arduino/arduino-language-server
The arduino-cli
tools must also be installed. Follow these instructions for your distro:
https://arduino.github.io/arduino-cli/latest/installation/
After installing the arduino-cli
tools, follow these instructions for generating
a configuration file:
https://arduino.github.io/arduino-cli/latest/getting-started/#create-a-configuration-file
and make sure you install any relevant platforms libraries:
https://arduino.github.io/arduino-cli/latest/getting-started/#install-the-core-for-your-board
The language server also requires clangd
be installed. It will look for clangd
by default but
the binary path can be overridden if need be.
After all dependencies are installed you'll need to override the lspconfig command for the language server in your setup function with the necessary configurations:
lspconfig.arduino_language_server.setup({
cmd = {
-- Required
"arduino-language-server",
"-cli-config", "/path/to/arduino-cli.yaml",
-- Optional
"-cli", "/path/to/arduino-cli",
"-clangd", "/path/to/clangd"
}
})
For further instruction about configuration options, run arduino-language-server --help
.
Snippet to enable the language server:
require'lspconfig'.arduino_language_server.setup{}
Default values:
cmd
:
{ "arduino-language-server" }
filetypes
:
{ "arduino" }
root_dir
:
see source file
https://github.com/bergercookie/asm-lsp
Language Server for GAS/GO Assembly
asm-lsp
can be installed via cargo:
cargo install asm-lsp
Snippet to enable the language server:
require'lspconfig'.asm_lsp.setup{}
Default values:
cmd
:
{ "asm-lsp" }
filetypes
:
{ "asm", "vmasm" }
root_dir
:
see source file
https://github.com/withastro/language-tools/tree/main/packages/language-server
astro-ls
can be installed via npm
:
npm install -g @astrojs/language-server
Snippet to enable the language server:
require'lspconfig'.astro.setup{}
Default values:
cmd
:
{ "astro-ls", "--stdio" }
filetypes
:
{ "astro" }
init_options
:
{
configuration = {}
}
root_dir
:
root_pattern("package.json", "tsconfig.json", "jsconfig.json", ".git")
https://github.com/Beaglefoot/awk-language-server/
awk-language-server
can be installed via npm
:
npm install -g awk-language-server
Snippet to enable the language server:
require'lspconfig'.awk_ls.setup{}
Default values:
cmd
:
{ "awk-language-server" }
filetypes
:
{ "awk" }
single_file_support
:
true
https://github.com/mads-hartmann/bash-language-server
bash-language-server
can be installed via npm
:
npm i -g bash-language-server
Language server for bash, written using tree sitter in typescript.
Snippet to enable the language server:
require'lspconfig'.bashls.setup{}
Default values:
cmd
:
{ "bash-language-server", "start" }
cmd_env
:
{
GLOB_PATTERN = "*@(.sh|.inc|.bash|.command)"
}
filetypes
:
{ "sh" }
root_dir
:
util.find_git_ancestor
single_file_support
:
true
https://github.com/polarmutex/beancount-language-server#installation
See https://github.com/polarmutex/beancount-language-server#configuration for configuration options
Snippet to enable the language server:
require'lspconfig'.beancount.setup{}
Default values:
cmd
:
{ "beancount-language-server", "--stdio" }
filetypes
:
{ "beancount", "bean" }
init_options
:
{
journalFile = ""
}
root_dir
:
root_pattern(".git")
single_file_support
:
true
https://github.com/azure/bicep Bicep language server
Bicep language server can be installed by downloading and extracting a release of bicep-langserver.zip from Bicep GitHub releases.
Bicep language server requires the dotnet-sdk to be installed.
Neovim does not have built-in support for the bicep filetype which is required for lspconfig to automatically launch the language server.
Filetype detection can be added via an autocmd:
vim.cmd [[ autocmd BufNewFile,BufRead *.bicep set filetype=bicep ]]
By default, bicep language server does not have a cmd
set. This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set cmd
to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary.
local bicep_lsp_bin = "/path/to/bicep-langserver/Bicep.LangServer.dll"
require'lspconfig'.bicep.setup{
cmd = { "dotnet", bicep_lsp_bin };
...
}
To download the latest release and place in /usr/local/bin/bicep-langserver:
(cd $(mktemp -d) \
&& curl -fLO https://github.com/Azure/bicep/releases/latest/download/bicep-langserver.zip \
&& rm -rf /usr/local/bin/bicep-langserver \
&& unzip -d /usr/local/bin/bicep-langserver bicep-langserver.zip)
Snippet to enable the language server:
require'lspconfig'.bicep.setup{}
Default values:
filetypes
:
{ "bicep" }
init_options
:
{}
root_dir
:
util.find_git_ancestor
https://github.com/1c-syntax/bsl-language-server
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
Snippet to enable the language server:
require'lspconfig'.bsl_ls.setup{}
Default values:
filetypes
:
{ "bsl", "os" }
root_dir
:
root_pattern(".git")
https://github.com/MaskRay/ccls/wiki
ccls relies on a JSON compilation database specified as compile_commands.json or, for simpler projects, a .ccls. For details on how to automatically generate one using CMake look here. Alternatively, you can use Bear.
Customization options are passed to ccls at initialization time via init_options, a list of available options can be found here. For example:
local lspconfig = require'lspconfig'
lspconfig.ccls.setup {
init_options = {
compilationDatabaseDirectory = "build";
index = {
threads = 0;
};
clang = {
excludeArgs = { "-frounding-math"} ;
};
}
}
Snippet to enable the language server:
require'lspconfig'.ccls.setup{}
Default values:
cmd
:
{ "ccls" }
filetypes
:
{ "c", "cpp", "objc", "objcpp" }
offset_encoding
:
"utf-32"
root_dir
:
<function 1>
single_file_support
:
false
https://clangd.llvm.org/installation.html
NOTE: Clang >= 11 is recommended! See this issue for more.
clangd relies on a JSON compilation database specified as compile_commands.json, see https://clangd.llvm.org/installation#compile_commandsjson
Snippet to enable the language server:
require'lspconfig'.clangd.setup{}
Commands:
- ClangdSwitchSourceHeader: Switch between source/header
Default values:
capabilities
:
default capabilities, with offsetEncoding utf-8
cmd
:
{ "clangd" }
filetypes
:
{ "c", "cpp", "objc", "objcpp" }
root_dir
:
root_pattern(
'.clangd',
'.clang-tidy',
'.clang-format',
'compile_commands.json',
'compile_flags.txt',
'configure.ac',
'.git'
)
single_file_support
:
true
clarity-lsp
is a language server for the Clarity language. Clarity is a decidable smart contract language that optimizes for predictability and security. Smart contracts allow developers to encode essential business logic on a blockchain.
To learn how to configure the clarity language server, see the clarity-lsp documentation.
Snippet to enable the language server:
require'lspconfig'.clarity_lsp.setup{}
Default values:
cmd
:
{ "clarity-lsp" }
filetypes
:
{ "clar", "clarity" }
root_dir
:
root_pattern(".git")
https://github.com/snoe/clojure-lsp
Clojure Language Server
Snippet to enable the language server:
require'lspconfig'.clojure_lsp.setup{}
Default values:
cmd
:
{ "clojure-lsp" }
filetypes
:
{ "clojure", "edn" }
root_dir
:
root_pattern("project.clj", "deps.edn", "build.boot", "shadow-cljs.edn", ".git")
https://github.com/regen100/cmake-language-server
CMake LSP Implementation
Snippet to enable the language server:
require'lspconfig'.cmake.setup{}
Default values:
cmd
:
{ "cmake-language-server" }
filetypes
:
{ "cmake" }
init_options
:
{
buildDirectory = "build"
}
root_dir
:
root_pattern(".git", "compile_commands.json", "build")
single_file_support
:
true
Reference: https://help.semmle.com/codeql/codeql-cli.html
Binaries: https://github.com/github/codeql-cli-binaries
Snippet to enable the language server:
require'lspconfig'.codeqlls.setup{}
Default values:
before_init
:
see source file
cmd
:
{ "codeql", "execute", "language-server", "--check-errors", "ON_CHANGE", "-q" }
filetypes
:
{ "ql" }
log_level
:
2
root_dir
:
see source file
settings
:
{
search_path = "list containing all search paths, eg: '~/codeql-home/codeql-repo'"
}
https://github.com/elbywan/crystalline
Crystal language server.
Snippet to enable the language server:
require'lspconfig'.crystalline.setup{}
Default values:
cmd
:
{ "crystalline" }
filetypes
:
{ "crystal" }
root_dir
:
root_pattern('shard.yml', '.git')
single_file_support
:
true
https://github.com/razzmatazz/csharp-language-server
Language Server for C#.
csharp-ls requires the dotnet-sdk to be installed.
The preferred way to install csharp-ls is with dotnet tool install --global csharp-ls
.
Snippet to enable the language server:
require'lspconfig'.csharp_ls.setup{}
Default values:
cmd
:
{ "csharp-ls" }
filetypes
:
{ "cs" }
init_options
:
{
AutomaticWorkspaceInit = true
}
root_dir
:
see source file
https://github.com/hrsh7th/vscode-langservers-extracted
css-languageserver
can be installed via npm
:
npm i -g vscode-langservers-extracted
Neovim does not currently include built-in snippets. vscode-css-language-server
only provides completions when snippet support is enabled. To enable completion, install a snippet plugin and add the following override to your language client capabilities during setup.
--Enable (broadcasting) snippet capability for completion
local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities.textDocument.completion.completionItem.snippetSupport = true
require'lspconfig'.cssls.setup {
capabilities = capabilities,
}
Snippet to enable the language server:
require'lspconfig'.cssls.setup{}
Default values:
cmd
:
{ "vscode-css-language-server", "--stdio" }
filetypes
:
{ "css", "scss", "less" }
root_dir
:
root_pattern("package.json", ".git") or bufdir
settings
:
{
css = {
validate = true
},
less = {
validate = true
},
scss = {
validate = true
}
}
single_file_support
:
true
https://github.com/antonk52/cssmodules-language-server
Language server for autocompletion and go-to-definition functionality for CSS modules.
You can install cssmodules-language-server via npm:
npm install -g cssmodules-language-server
Snippet to enable the language server:
require'lspconfig'.cssmodules_ls.setup{}
Default values:
cmd
:
{ "cssmodules-language-server" }
filetypes
:
{ "javascript", "javascriptreact", "typescript", "typescriptreact" }
root_dir
:
root_pattern("package.json")
https://cucumber.io https://github.com/cucumber/common https://www.npmjs.com/package/@cucumber/language-server
Language server for Cucumber.
cucumber-language-server
can be installed via npm
:
npm install -g @cucumber/language-server
Snippet to enable the language server:
require'lspconfig'.cucumber_language_server.setup{}
Default values:
cmd
:
{ "cucumber-language-server", "--stdio" }
filetypes
:
{ "cucumber" }
root_dir
:
util.find_git_ancestor
https://github.com/dart-lang/sdk/tree/master/pkg/analysis_server/tool/lsp_spec
Language server for dart.
Snippet to enable the language server:
require'lspconfig'.dartls.setup{}
Default values:
cmd
:
{ "dart", "language-server" }
filetypes
:
{ "dart" }
init_options
:
{
closingLabels = true,
flutterOutline = true,
onlyAnalyzeProjectsWithOpenFiles = true,
outline = true,
suggestFromUnimportedLibraries = true
}
root_dir
:
root_pattern("pubspec.yaml")
settings
:
{
dart = {
completeFunctionCalls = true,
showTodos = true
}
}
https://github.com/denoland/deno
Deno's built-in language server
To approrpiately highlight codefences returned from denols, you will need to augment vim.g.markdown_fenced languages in your init.lua. Example:
vim.g.markdown_fenced_languages = {
"ts=typescript"
}
Snippet to enable the language server:
require'lspconfig'.denols.setup{}
Commands:
- DenolsCache: Cache a module and all of its dependencies.
Default values:
cmd
:
{ "deno", "lsp" }
filetypes
:
{ "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" }
handlers
:
{
["textDocument/definition"] = <function 1>,
["textDocument/references"] = <function 1>
}
init_options
:
{
enable = true,
lint = false,
unstable = false
}
root_dir
:
root_pattern("deno.json", "deno.jsonc", "tsconfig.json", ".git")
https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-lsp-server
language server for dhall
dhall-lsp-server
can be installed via cabal:
cabal install dhall-lsp-server
prebuilt binaries can be found here.
Snippet to enable the language server:
require'lspconfig'.dhall_lsp_server.setup{}
Default values:
cmd
:
{ "dhall-lsp-server" }
filetypes
:
{ "dhall" }
root_dir
:
root_pattern(".git")
single_file_support
:
true
https://github.com/iamcco/diagnostic-languageserver
Diagnostic language server integrate with linters.
Snippet to enable the language server:
require'lspconfig'.diagnosticls.setup{}
Default values:
cmd
:
{ "diagnostic-languageserver", "--stdio" }
filetypes
:
Empty by default, override to add filetypes
root_dir
:
Vim's starting directory
single_file_support
:
true
https://github.com/rcjsuen/dockerfile-language-server-nodejs
docker-langserver
can be installed via npm
:
npm install -g dockerfile-language-server-nodejs
Snippet to enable the language server:
require'lspconfig'.dockerls.setup{}
Default values:
cmd
:
{ "docker-langserver", "--stdio" }
filetypes
:
{ "dockerfile" }
root_dir
:
root_pattern("Dockerfile")
single_file_support
:
true
https://github.com/nikeee/dot-language-server
dot-language-server
can be installed via npm
:
npm install -g dot-language-server
Snippet to enable the language server:
require'lspconfig'.dotls.setup{}
Default values:
cmd
:
{ "dot-language-server", "--stdio" }
filetypes
:
{ "dot" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/mattn/efm-langserver
General purpose Language Server that can use specified error message format generated from specified command.
Requires at minimum EFM version v0.0.38 to support launching the language server on single files. If on an older version of EFM, disable single file support:
require('lspconfig')['efm'].setup{
settings = ..., -- You must populate this according to the EFM readme
filetypes = ..., -- Populate this according to the note below
single_file_support = false, -- This is the important line for supporting older version of EFM
}
Note: In order for neovim's built-in language server client to send the appropriate languageId
to EFM, you must
specify filetypes
in your call to setup{}
. Otherwise lspconfig
will launch EFM on the BufEnter
instead
of the FileType
autocommand, and the filetype
variable used to populate the languageId
will not yet be set.
require('lspconfig')['efm'].setup{
settings = ..., -- You must populate this according to the EFM readme
filetypes = { 'python','cpp','lua' }
}
Snippet to enable the language server:
require'lspconfig'.efm.setup{}
Default values:
cmd
:
{ "efm-langserver" }
root_dir
:
util.root_pattern(".git")
single_file_support
:
true
https://github.com/elixir-lsp/elixir-ls
elixir-ls
can be installed by following the instructions here.
curl -fLO https://github.com/elixir-lsp/elixir-ls/releases/latest/download/elixir-ls.zip
unzip elixir-ls.zip -d /path/to/elixir-ls
# Unix
chmod +x /path/to/elixir-ls/language_server.sh
By default, elixir-ls doesn't have a cmd
set. This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set cmd
to the absolute path ($HOME and ~ are not expanded) of your unzipped elixir-ls.
require'lspconfig'.elixirls.setup{
-- Unix
cmd = { "/path/to/elixir-ls/language_server.sh" };
-- Windows
cmd = { "/path/to/elixir-ls/language_server.bat" };
...
}
Snippet to enable the language server:
require'lspconfig'.elixirls.setup{}
Default values:
filetypes
:
{ "elixir", "eelixir", "heex" }
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-server
Snippet to enable the language server:
require'lspconfig'.elmls.setup{}
Default values:
cmd
:
{ "elm-language-server" }
filetypes
:
{ "elm" }
init_options
:
{
elmAnalyseTrigger = "change"
}
root_dir
:
root_pattern("elm.json")
https://github.com/lifeart/ember-language-server
ember-language-server
can be installed via npm
:
npm install -g @lifeart/ember-language-server
Snippet to enable the language server:
require'lspconfig'.ember.setup{}
Default values:
cmd
:
{ "ember-language-server", "--stdio" }
filetypes
:
{ "handlebars", "typescript", "javascript" }
root_dir
:
root_pattern("ember-cli-build.js", ".git")
https://github.com/aca/emmet-ls
Package can be installed via npm
:
npm install -g emmet-ls
Snippet to enable the language server:
require'lspconfig'.emmet_ls.setup{}
Default values:
cmd
:
{ "emmet-ls", "--stdio" }
filetypes
:
{ "html", "css" }
root_dir
:
git root
single_file_support
:
true
Language Server for Erlang.
Clone erlang_ls
Compile the project with make
and copy resulting binaries somewhere in your $PATH eg. cp _build/*/bin/* ~/local/bin
Installation instruction can be found here.
Installation requirements: - Erlang OTP 21+ - rebar3 3.9.1+
Snippet to enable the language server:
require'lspconfig'.erlangls.setup{}
Default values:
cmd
:
{ "erlang_ls" }
filetypes
:
{ "erlang" }
root_dir
:
root_pattern('rebar.config', 'erlang.mk', '.git')
single_file_support
:
true
https://github.com/swyddfa/esbonio
Esbonio is a language server for Sphinx documentation projects. The language server can be installed via pip
pip install esbonio
Since Sphinx is highly extensible you will get best results if you install the language server in the same
Python environment as the one used to build your documentation. To ensure that the correct Python environment
is picked up, you can either launch nvim
with the correct environment activated.
source env/bin/activate
nvim
Or you can modify the default cmd
to include the full path to the Python interpreter.
require'lspconfig'.esbonio.setup {
cmd = { '/path/to/virtualenv/bin/python', '-m', 'esbonio' }
}
Esbonio supports a number of config values passed as init_options
on startup, for example.
require'lspconfig'.esbonio.setup {
init_options = {
server = {
logLevel = "debug"
},
sphinx = {
confDir = "/path/to/docs",
srcDir = "${confDir}/../docs-src"
}
}
A full list and explanation of the available options can be found here
Snippet to enable the language server:
require'lspconfig'.esbonio.setup{}
Default values:
cmd
:
{ "python3", "-m", "esbonio" }
filetypes
:
{ "rst" }
root_dir
:
see source file
https://github.com/hrsh7th/vscode-langservers-extracted
vscode-eslint-language-server: A linting engine for JavaScript / Typescript
vscode-eslint-language-server
can be installed via npm
:
npm i -g vscode-langservers-extracted
vscode-eslint-language-server provides an EslintFixAll command that can be used to format document on save
autocmd BufWritePre *.tsx,*.ts,*.jsx,*.js EslintFixAll
See vscode-eslint for configuration options.
Additional messages you can handle: eslint/noConfig Messages already handled in lspconfig: eslint/openDoc, eslint/confirmESLintExecution, eslint/probeFailed, eslint/noLibrary
Snippet to enable the language server:
require'lspconfig'.eslint.setup{}
Commands:
- EslintFixAll: Fix all eslint problems for this buffer
Default values:
cmd
:
{ "vscode-eslint-language-server", "--stdio" }
filetypes
:
{ "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx", "vue" }
handlers
:
{
["eslint/confirmESLintExecution"] = <function 1>,
["eslint/noLibrary"] = <function 2>,
["eslint/openDoc"] = <function 3>,
["eslint/probeFailed"] = <function 4>
}
on_new_config
:
see source file
root_dir
:
see source file
settings
:
{
codeAction = {
disableRuleComment = {
enable = true,
location = "separateLine"
},
showDocumentation = {
enable = true
}
},
codeActionOnSave = {
enable = false,
mode = "all"
},
format = true,
nodePath = "",
onIgnoredFiles = "off",
packageManager = "npm",
quiet = false,
rulesCustomizations = {},
run = "onType",
useESLintClass = false,
validate = "on",
workingDirectory = {
mode = "location"
}
}
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 --help
Snippet to enable the language server:
require'lspconfig'.flow.setup{}
Default values:
cmd
:
{ "npx", "--no-install", "flow", "lsp" }
filetypes
:
{ "javascript", "javascriptreact", "javascript.jsx" }
root_dir
:
root_pattern(".flowconfig")
https://github.com/influxdata/flux-lsp
flux-lsp
can be installed via cargo
:
cargo install --git https://github.com/influxdata/flux-lsp
Snippet to enable the language server:
require'lspconfig'.flux_lsp.setup{}
Default values:
cmd
:
{ "flux-lsp" }
filetypes
:
{ "flux" }
root_dir
:
util.find_git_ancestor
single_file_support
:
true
https://github.com/FoamScience/foam-language-server
foam-language-server
can be installed via npm
npm install -g foam-language-server
Snippet to enable the language server:
require'lspconfig'.foam_ls.setup{}
Default values:
cmd
:
{ "foam-ls", "--stdio" }
filetypes
:
{ "foam", "OpenFOAM" }
root_dir
:
see source file
https://github.com/gnikit/fortls
fortls is a Fortran Language Server, the server can be installed via pip
pip install fortls
Settings to the server can be passed either through the cmd
option or through
a local configuration file e.g. .fortls
. For more information
see the fortls
documentation.
Snippet to enable the language server:
require'lspconfig'.fortls.setup{}
Default values:
cmd
:
{ "fortls", "--notify_init", "--hover_signature", "--hover_language=fortran", "--use_signature_help" }
filetypes
:
{ "fortran" }
root_dir
:
root_pattern(".fortls")
settings
:
{}
https://github.com/fsharp/FsAutoComplete
Language Server for F# provided by FsAutoComplete (FSAC).
FsAutoComplete requires the dotnet-sdk to be installed.
The preferred way to install FsAutoComplete is with dotnet tool install --global fsautocomplete
.
Instructions to compile from source are found on the main repository.
You may also need to configure the filetype as Vim defaults to Forth for *.fs
files:
autocmd BufNewFile,BufRead *.fs,*.fsx,*.fsi set filetype=fsharp
This is automatically done by plugins such as PhilT/vim-fsharp, fsharp/vim-fsharp, and adelarsq/neofsharp.vim.
Snippet to enable the language server:
require'lspconfig'.fsautocomplete.setup{}
Default values:
cmd
:
{ "fsautocomplete", "--background-service-enabled" }
filetypes
:
{ "fsharp" }
init_options
:
{
AutomaticWorkspaceInit = true
}
root_dir
:
see source file
https://github.com/FStarLang/FStar
LSP support is included in FStar. Make sure fstar.exe
is in your PATH.
Snippet to enable the language server:
require'lspconfig'.fstar.setup{}
Default values:
cmd
:
{ "fstar.exe", "--lsp" }
filetypes
:
{ "fstar" }
root_dir
:
util.find_git_ancestor
https://github.com/godotengine/godot
Language server for GDScript, used by Godot Engine.
Snippet to enable the language server:
require'lspconfig'.gdscript.setup{}
Default values:
cmd
:
{ "nc", "localhost", "6008" }
filetypes
:
{ "gd", "gdscript", "gdscript3" }
root_dir
:
util.root_pattern("project.godot", ".git")
https://github.com/digital-asset/ghcide
A library for building Haskell IDE tooling. "ghcide" isn't for end users now. Use "haskell-language-server" instead of "ghcide".
Snippet to enable the language server:
require'lspconfig'.ghcide.setup{}
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/typed-ember/glint
https://typed-ember.gitbook.io/glint/
glint-language-server
is installed when adding @glint/core
to your project's devDependencies:
npm install @glint/core --save-dev
or
yarn add -D @glint/core
or
pnpm add -D @glint/core
Snippet to enable the language server:
require'lspconfig'.glint.setup{}
Default values:
cmd
:
{ "glint-language-server" }
filetypes
:
{ "html.handlebars", "handlebars", "typescript", "typescript.glimmer", "javascript", "javascript.glimmer" }
on_new_config
:
see source file
root_dir
:
see source file
Combination of both lint server and client
https://github.com/nametake/golangci-lint-langserver https://github.com/golangci/golangci-lint
Installation of binaries needed is done via
go install github.com/nametake/golangci-lint-langserver@latest
go install github.com/golangci/golangci-lint/cmd/[email protected]
Snippet to enable the language server:
require'lspconfig'.golangci_lint_ls.setup{}
Default values:
cmd
:
{ "golangci-lint-langserver" }
filetypes
:
{ "go", "gomod" }
init_options
:
{
command = { "golangci-lint", "run", "--out-format", "json" }
}
root_dir
:
root_pattern('go.work') or root_pattern('go.mod', '.golangci.yaml', '.git')
https://github.com/golang/tools/tree/master/gopls
Google's lsp server for golang.
Snippet to enable the language server:
require'lspconfig'.gopls.setup{}
Default values:
cmd
:
{ "gopls" }
filetypes
:
{ "go", "gomod", "gotmpl" }
root_dir
:
root_pattern("go.mod", ".git")
single_file_support
:
true
https://github.com/microsoft/vscode-gradle
Microsoft's lsp server for gradle files
If you're setting this up manually, build vscode-gradle using ./gradlew installDist
and point cmd
to the gradle-language-server
generated in the build directory
Snippet to enable the language server:
require'lspconfig'.gradle_ls.setup{}
Default values:
cmd
:
{ "gradle-language-server" }
filetypes
:
{ "groovy" }
root_dir
:
root_pattern("settings.gradle")
https://github.com/emacs-grammarly/unofficial-grammarly-language-server
unofficial-grammarly-language-server
can be installed via npm
:
npm i -g @emacs-grammarly/unofficial-grammarly-language-server
WARNING: Since this language server uses Grammarly's API, any document you open with it running is shared with them. Please evaluate their privacy policy before using this.
Snippet to enable the language server:
require'lspconfig'.grammarly.setup{}
Default values:
cmd
:
{ "unofficial-grammarly-language-server", "--stdio" }
filetypes
:
{ "markdown" }
handlers
:
{
["$/updateDocumentState"] = <function 1>
}
root_dir
:
util.find_git_ancestor
single_file_support
:
true
https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli
graphql-lsp
can be installed via npm
:
npm install -g graphql-language-service-cli
Note that you must also have the graphql package installed and create a GraphQL config file.
Snippet to enable the language server:
require'lspconfig'.graphql.setup{}
Default values:
cmd
:
{ "graphql-lsp", "server", "-m", "stream" }
filetypes
:
{ "graphql", "typescriptreact", "javascriptreact" }
root_dir
:
root_pattern('.git', '.graphqlrc*', '.graphql.config.*')
https://github.com/prominic/groovy-language-server.git
Requirements:
- Linux/macOS (for now)
- Java 11+
groovyls
can be installed by following the instructions here.
If you have installed groovy language server, you can set the cmd
custom path as follow:
require'lspconfig'.groovyls.setup{
-- Unix
cmd = { "java", "-jar", "path/to/groovyls/groovy-language-server-all.jar" },
...
}
Snippet to enable the language server:
require'lspconfig'.groovyls.setup{}
Default values:
cmd
:
{ "java", "-jar", "groovy-language-server-all.jar" }
filetypes
:
{ "groovy" }
root_dir
:
see source file
https://github.com/vshaxe/haxe-language-server
The Haxe language server can be built by running the following commands from the project's root directory:
npm install
npx lix run vshaxe-build -t language-server
This will create bin/server.js
. Note that the server requires Haxe 3.4.0 or
higher.
After building the language server, set the cmd
setting in your setup
function:
lspconfig.haxe_language_server.setup({
cmd = {"node", "path/to/bin/server.js"},
})
By default, an HXML compiler arguments file named build.hxml
is expected in
your project's root directory. If your file is named something different,
specify it using the init_options.displayArguments
setting.
Snippet to enable the language server:
require'lspconfig'.haxe_language_server.setup{}
Default values:
cmd
:
{ "haxe-language-server" }
filetypes
:
{ "haxe" }
init_options
:
{
displayArguments = { "build.hxml" }
}
root_dir
:
root_pattern("*.hxml")
settings
:
{
haxe = {
executable = "haxe"
}
}
https://github.com/suoto/hdl_checker
Language server for hdl-checker.
Install using: pip install hdl-checker --upgrade
Snippet to enable the language server:
require'lspconfig'.hdl_checker.setup{}
Default values:
cmd
:
{ "hdl_checker", "--lsp" }
filetypes
:
{ "vhdl", "verilog", "systemverilog" }
root_dir
:
util.find_git_ancestor
single_file_support
:
true
Language server for programs written in Hack https://hhvm.com/ https://github.com/facebook/hhvm See below for how to setup HHVM & typechecker: https://docs.hhvm.com/hhvm/getting-started/getting-started
Snippet to enable the language server:
require'lspconfig'.hhvm.setup{}
Default values:
cmd
:
{ "hh_client", "lsp" }
filetypes
:
{ "php", "hack" }
root_dir
:
root_pattern(".hhconfig")
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");
}
}
Snippet to enable the language server:
require'lspconfig'.hie.setup{}
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
Snippet to enable the language server:
require'lspconfig'.hls.setup{}
Default values:
cmd
:
{ "haskell-language-server-wrapper", "--lsp" }
filetypes
:
{ "haskell", "lhaskell" }
lspinfo
:
see source file
root_dir
:
root_pattern("*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml")
settings
:
{
haskell = {
formattingProvider = "ormolu"
}
}
single_file_support
:
true
https://github.com/urbit/hoon-language-server
A language server for Hoon.
The language server can be installed via npm install -g @hoon-language-server
Start a fake ~zod with urbit -F zod
.
Start the language server at the Urbit Dojo prompt with: |start %language-server
Snippet to enable the language server:
require'lspconfig'.hoon_ls.setup{}
Default values:
cmd
:
{ "hoon-language-server" }
filetypes
:
{ "hoon" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/hrsh7th/vscode-langservers-extracted
vscode-html-language-server
can be installed via npm
:
npm i -g vscode-langservers-extracted
Neovim does not currently include built-in snippets. vscode-html-language-server
only provides completions when snippet support is enabled.
To enable completion, install a snippet plugin and add the following override to your language client capabilities during setup.
The code-formatting feature of the lsp can be controlled with the provideFormatter
option.
--Enable (broadcasting) snippet capability for completion
local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities.textDocument.completion.completionItem.snippetSupport = true
require'lspconfig'.html.setup {
capabilities = capabilities,
}
Snippet to enable the language server:
require'lspconfig'.html.setup{}
Default values:
cmd
:
{ "vscode-html-language-server", "--stdio" }
filetypes
:
{ "html" }
init_options
:
{
configurationSection = { "html", "css", "javascript" },
embeddedLanguages = {
css = true,
javascript = true
},
provideFormatter = true
}
root_dir
:
see source file
settings
:
{}
single_file_support
:
true
https://github.com/idris-community/idris2-lsp
The Idris 2 language server.
Plugins for the Idris 2 filetype include Idris2-Vim (fewer features, stable) and Nvim-Idris2 (cutting-edge, experimental).
Idris2-Lsp requires a build of Idris 2 that includes the "Idris 2 API" package. Package managers with known support for this build include the AUR and Homebrew.
If your package manager does not support the Idris 2 API, you will need to build Idris 2 from source. Refer to the the Idris 2 installation instructions for details. Steps 5 and 8 are listed as "optional" in that guide, but they are necessary in order to make the Idris 2 API available.
You need to install a version of Idris2-Lsp that is compatible with your version of Idris 2. There should be a branch corresponding to every released Idris 2 version after v0.4.0. Use the latest commit on that branch. For example, if you have Idris v0.5.1, you should use the v0.5.1 branch of Idris2-Lsp.
If your Idris 2 version is newer than the newest Idris2-Lsp branch, use the
latest commit on the master
branch, and set a reminder to check the Idris2-Lsp
repo for the release of a compatible versioned branch.
Snippet to enable the language server:
require'lspconfig'.idris2_lsp.setup{}
Default values:
cmd
:
{ "idris2-lsp" }
filetypes
:
{ "idris2" }
root_dir
:
see source file
intelephense
can be installed via npm
:
npm install -g intelephense
Snippet to enable the language server:
require'lspconfig'.intelephense.setup{}
Default values:
cmd
:
{ "intelephense", "--stdio" }
filetypes
:
{ "php" }
root_dir
:
root_pattern("composer.json", ".git")
https://github.com/georgewfraser/java-language-server
Java language server
Point cmd
to lang_server_linux.sh
or the equivalent script for macOS/Windows provided by java-language-server
Snippet to enable the language server:
require'lspconfig'.java_language_server.setup{}
Default values:
filetypes
:
{ "java" }
root_dir
:
see source file
settings
:
{}
https://projects.eclipse.org/projects/eclipse.jdt.ls
Language server for Java.
IMPORTANT: If you want all the features jdtls has to offer, nvim-jdtls is highly recommended. If all you need is diagnostics, completion, imports, gotos and formatting and some code actions you can keep reading here.
For manual installation you can download precompiled binaries from the official downloads site
Due to the nature of java, settings cannot be inferred. Please set the following environmental variables to match your installation. If you need per-project configuration direnv is highly recommended.
# Mandatory:
# .bashrc
export JDTLS_HOME=/path/to/jdtls_root # Directory with the plugin and configs directories
# Optional:
export JAVA_HOME=/path/to/java_home # In case you don't have java in path or want to use a version in particular
export WORKSPACE=/path/to/workspace # Defaults to $HOME/workspace
-- init.lua
require'lspconfig'.jdtls.setup{}
For automatic installation you can use the following unofficial installers/launchers under your own risk:
- jdtls-launcher (Includes lombok support by default)
-- init.lua require'lspconfig'.jdtls.setup{ cmd = { 'jdtls' } }
Snippet to enable the language server:
require'lspconfig'.jdtls.setup{}
Default values:
cmd
:
{ "/usr/lib/jvm/temurin-11-jdk-amd64/bin/java", "-Declipse.application=org.eclipse.jdt.ls.core.id1", "-Dosgi.bundles.defaultStartLevel=4", "-Declipse.product=org.eclipse.jdt.ls.core.product", "-Dlog.protocol=true", "-Dlog.level=ALL", "-Xms1g", "-Xmx2G", "--add-modules=ALL-SYSTEM", "--add-opens", "java.base/java.util=ALL-UNNAMED", "--add-opens", "java.base/java.lang=ALL-UNNAMED", "-jar", "/plugins/org.eclipse.equinox.launcher_*.jar", "-configuration", "config_linux", "-data", "/home/runner/workspace" }
filetypes
:
{ "java" }
handlers
:
{
["language/status"] = <function 1>,
["textDocument/codeAction"] = <function 2>,
["textDocument/rename"] = <function 3>,
["workspace/applyEdit"] = <function 4>
}
init_options
:
{
jvm_args = {},
workspace = "/home/runner/workspace"
}
root_dir
:
{
-- Single-module projects
{
'build.xml', -- Ant
'pom.xml', -- Maven
'settings.gradle', -- Gradle
'settings.gradle.kts', -- Gradle
},
-- Multi-module projects
{ 'build.gradle', 'build.gradle.kts' },
} or vim.fn.getcwd()
single_file_support
:
true
https://github.com/pappasam/jedi-language-server
jedi-language-server
, a language server for Python, built on top of jedi
Snippet to enable the language server:
require'lspconfig'.jedi_language_server.setup{}
Default values:
cmd
:
{ "jedi-language-server" }
filetypes
:
{ "python" }
root_dir
:
vim's starting directory
single_file_support
:
true
https://github.com/hrsh7th/vscode-langservers-extracted
vscode-json-language-server, a language server for JSON and JSON schema
vscode-json-language-server
can be installed via npm
:
npm i -g vscode-langservers-extracted
Neovim does not currently include built-in snippets. vscode-json-language-server
only provides completions when snippet support is enabled. To enable completion, install a snippet plugin and add the following override to your language client capabilities during setup.
--Enable (broadcasting) snippet capability for completion
local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities.textDocument.completion.completionItem.snippetSupport = true
require'lspconfig'.jsonls.setup {
capabilities = capabilities,
}
Snippet to enable the language server:
require'lspconfig'.jsonls.setup{}
Default values:
cmd
:
{ "vscode-json-language-server", "--stdio" }
filetypes
:
{ "json", "jsonc" }
init_options
:
{
provideFormatter = true
}
root_dir
:
util.find_git_ancestor
single_file_support
:
true
https://github.com/grafana/jsonnet-language-server
A Language Server Protocol (LSP) server for Jsonnet.
The language server can be installed with go
:
go install github.com/grafana/jsonnet-language-server@latest
Snippet to enable the language server:
require'lspconfig'.jsonnet_ls.setup{}
Default values:
cmd
:
{ "jsonnet-language-server" }
filetypes
:
{ "jsonnet", "libsonnet" }
on_new_config
:
see source file
root_dir
:
root_pattern("jsonnetfile.json")
https://github.com/julia-vscode/julia-vscode
LanguageServer.jl can be installed with julia
and Pkg
:
julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.add("LanguageServer")'
where ~/.julia/environments/nvim-lspconfig
is the location where
the default configuration expects LanguageServer.jl to be installed.
To update an existing install, use the following command:
julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.update()'
Note: In order to have LanguageServer.jl pick up installed packages or dependencies in a Julia project, you must make sure that the project is instantiated:
julia --project=/path/to/my/project -e 'using Pkg; Pkg.instantiate()'
Snippet to enable the language server:
require'lspconfig'.julials.setup{}
Default values:
cmd
:
{ "julia", "--startup-file=no", "--history-file=no", "-e", ' # Load LanguageServer.jl: attempt to load from ~/.julia/environments/nvim-lspconfig\n # with the regular load path as a fallback\n ls_install_path = joinpath(\n get(DEPOT_PATH, 1, joinpath(homedir(), ".julia")),\n "environments", "nvim-lspconfig"\n )\n pushfirst!(LOAD_PATH, ls_install_path)\n using LanguageServer\n popfirst!(LOAD_PATH)\n depot_path = get(ENV, "JULIA_DEPOT_PATH", "")\n project_path = let\n dirname(something(\n ## 1. Finds an explicitly set project (JULIA_PROJECT)\n Base.load_path_expand((\n p = get(ENV, "JULIA_PROJECT", nothing);\n p === nothing ? nothing : isempty(p) ? nothing : p\n )),\n ## 2. Look for a Project.toml file in the current working directory,\n ## or parent directories, with $HOME as an upper boundary\n Base.current_project(),\n ## 3. First entry in the load path\n get(Base.load_path(), 1, nothing),\n ## 4. Fallback to default global environment,\n ## this is more or less unreachable\n Base.load_path_expand("@v#.#"),\n ))\n end\n @info "Running language server" VERSION 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
:
see source file
single_file_support
:
true
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 built via gradle and developed on github.
Source and additional description:
https://github.com/fwcd/kotlin-language-server
This server requires vim to be aware of the kotlin-filetype.
You could refer for this capability to:
https://github.com/udalov/kotlin-vim (recommended)
Note that there is no LICENSE specified yet.
Snippet to enable the language server:
require'lspconfig'.kotlin_language_server.setup{}
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 installation instructions can be found here.
Once Lean is installed, you can install the Lean 3 language server by running
npm install -g lean-language-server
Note: that if you're using lean.nvim,
that plugin fully handles the setup of the Lean language server,
and you shouldn't set up lean3ls
both with it and lspconfig
.
Snippet to enable the language server:
require'lspconfig'.lean3ls.setup{}
Default values:
cmd
:
{ "lean-language-server", "--stdio", "--", "-M", "4096", "-T", "100000" }
filetypes
:
{ "lean3" }
offset_encoding
:
"utf-32"
root_dir
:
root_pattern("leanpkg.toml") or root_pattern(".git")
single_file_support
:
true
https://github.com/leanprover/lean4
Lean installation instructions can be found here.
The Lean 4 language server is built-in with a Lean 4 install
(and can be manually run with, e.g., lean --server
).
Note: that if you're using lean.nvim,
that plugin fully handles the setup of the Lean language server,
and you shouldn't set up leanls
both with it and lspconfig
.
Snippet to enable the language server:
require'lspconfig'.leanls.setup{}
Default values:
cmd
:
{ "lake", "serve", "--" }
filetypes
:
{ "lean" }
on_new_config
:
see source file
options
:
{
no_lake_lsp_cmd = { "lean", "--server" }
}
root_dir
:
root_pattern("lakefile.lean", "lean-toolchain", "leanpkg.toml", ".git")
single_file_support
:
true
https://github.com/0x2a-42/lelwel
Language server for lelwel grammars.
You can install lelwel-ls
via cargo:
cargo install --features="lsp" lelwel
Snippet to enable the language server:
require'lspconfig'.lelwel_ls.setup{}
Default values:
cmd
:
{ "lelwel-ls" }
filetypes
:
{ "llw" }
root_dir
:
see source file
https://github.com/eclipse/lemminx
The easiest way to install the server is to get a binary at https://download.jboss.org/jbosstools/vscode/stable/lemminx-binary/ and place it in your PATH.
NOTE to macOS users: Binaries from unidentified developers are blocked by default. If you trust the downloaded binary from jboss.org, run it once, cancel the prompt, then remove the binary from Gatekeeper quarantine with xattr -d com.apple.quarantine lemminx
. It should now run without being blocked.
Snippet to enable the language server:
require'lspconfig'.lemminx.setup{}
Default values:
cmd
:
{ "lemminx" }
filetypes
:
{ "xml", "xsd", "xsl", "xslt", "svg" }
root_dir
:
util.find_git_ancestor
single_file_support
:
true
https://github.com/valentjn/ltex-ls
LTeX Language Server: LSP language server for LanguageTool 🔍✔️ with support for LaTeX 🎓, Markdown 📝, and others
To install, download the latest release and ensure ltex-ls
is on your path.
To support org files or R sweave, users can define a custom filetype autocommand (or use a plugin which defines these filetypes):
vim.cmd [[ autocmd BufRead,BufNewFile *.org set filetype=org ]]
Snippet to enable the language server:
require'lspconfig'.ltex.setup{}
Default values:
cmd
:
{ "ltex-ls" }
filetypes
:
{ "bib", "gitcommit", "markdown", "org", "plaintex", "rst", "rnoweb", "tex" }
get_language_id
:
see source file
root_dir
:
see source file
single_file_support
:
true
Scala language server with rich IDE features.
See full instructions in the Metals documentation:
https://scalameta.org/metals/docs/editors/vim.html#using-an-alternative-lsp-client
Note: that if you're using nvim-metals, that plugin fully handles the setup and installation of Metals, and you shouldn't set up Metals both with it and lspconfig
.
To install Metals, make sure to have coursier installed, and once you do you can install the latest Metals with cs install metals
. You can also manually bootstrap Metals with the following command.
cs bootstrap \
--java-opt -Xss4m \
--java-opt -Xms100m \
org.scalameta:metals_2.12:<enter-version-here> \
-r bintray:scalacenter/releases \
-r sonatype:snapshots \
-o /usr/local/bin/metals -f
Snippet to enable the language server:
require'lspconfig'.metals.setup{}
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")
Install Mint using the instructions. The language server is included since version 0.12.0.
Snippet to enable the language server:
require'lspconfig'.mint.setup{}
Default values:
cmd
:
{ "mint", "ls" }
filetypes
:
{ "mint" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/digama0/mm0
Language Server for the metamath-zero theorem prover.
Requires mm0-rs to be installed
and available on the PATH
.
Snippet to enable the language server:
require'lspconfig'.mm0_ls.setup{}
Default values:
cmd
:
{ "mm0-rs", "server" }
filetypes
:
{ "metamath-zero" }
root_dir
:
see source file
single_file_support
:
true
Nickel Language Server
https://github.com/tweag/nickel
nls
can be installed with nix, or cargo, from the Nickel repository.
git clone https://github.com/tweag/nickel.git
Nix:
cd nickel
nix-env -f . -i
cargo:
cd nickel/lsp/nls
cargo install --path .
In order to have lspconfig detect Nickel filetypes (a prequisite for autostarting a server), install the Nickel vim plugin.
Snippet to enable the language server:
require'lspconfig'.nickel_ls.setup{}
Default values:
cmd
:
{ "nls" }
filetypes
:
{ "ncl", "nickel" }
root_dir
:
see source file
https://github.com/PMunch/nimlsp
nimlsp
can be installed via the nimble
package manager:
nimble install nimlsp
Snippet to enable the language server:
require'lspconfig'.nimls.setup{}
Default values:
cmd
:
{ "nimlsp" }
filetypes
:
{ "nim" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/ocaml-lsp/ocaml-language-server
ocaml-language-server
can be installed via npm
npm install -g ocaml-language-server
Snippet to enable the language server:
require'lspconfig'.ocamlls.setup{}
Default values:
cmd
:
{ "ocaml-language-server", "--stdio" }
filetypes
:
{ "ocaml", "reason" }
root_dir
:
root_pattern("*.opam", "esy.json", "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-server
Snippet to enable the language server:
require'lspconfig'.ocamllsp.setup{}
Default values:
cmd
:
{ "ocamllsp" }
filetypes
:
{ "ocaml", "ocaml.menhir", "ocaml.interface", "ocaml.ocamllex", "reason", "dune" }
get_language_id
:
see source file
root_dir
:
root_pattern("*.opam", "esy.json", "package.json", ".git", "dune-project", "dune-workspace")
https://github.com/DanielGavin/ols
`Odin Language Server`.
Snippet to enable the language server:
require'lspconfig'.ols.setup{}
Default values:
cmd
:
{ "ols" }
filetypes
:
{ "odin" }
root_dir
:
util.root_pattern("ols.json", ".git")
single_file_support
:
true
https://github.com/omnisharp/omnisharp-roslyn OmniSharp server based on Roslyn workspaces
omnisharp-roslyn
can be installed by downloading and extracting a release from here.
Omnisharp can also be built from source by following the instructions here.
Omnisharp requires the dotnet-sdk to be installed.
By default, omnisharp-roslyn doesn't have a cmd
set. This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set cmd
to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary.
local pid = vim.fn.getpid()
-- On linux/darwin if using a release build, otherwise under scripts/OmniSharp(.Core)(.cmd)
local omnisharp_bin = "/path/to/omnisharp-repo/run"
-- on Windows
-- local omnisharp_bin = "/path/to/omnisharp/OmniSharp.exe"
require'lspconfig'.omnisharp.setup{
cmd = { omnisharp_bin, "--languageserver" , "--hostPID", tostring(pid) };
...
}
Note, if you download the executable for darwin you will need to strip the quarantine label to run:
find /path/to/omnisharp-osx | xargs xattr -r -d com.apple.quarantine
Snippet to enable the language server:
require'lspconfig'.omnisharp.setup{}
Default values:
filetypes
:
{ "cs", "vb" }
init_options
:
{}
on_new_config
:
see source file
root_dir
:
root_pattern(".sln") or root_pattern(".csproj")
https://github.com/Galarius/opencl-language-server
Build instructions can be found here.
Prebuilt binaries are available for Linux, macOS and Windows here.
Snippet to enable the language server:
require'lspconfig'.opencl_ls.setup{}
Default values:
cmd
:
{ "opencl-language-server" }
filetypes
:
{ "opencl" }
root_dir
:
util.root_pattern(".git")
https://github.com/dzhu/openscad-language-server
A Language Server Protocol server for OpenSCAD
You can build and install openscad-language-server
binary with cargo
:
cargo install openscad-language-server
Vim does not have built-in syntax for the openscad
filetype currently.
This can be added via an autocmd:
vim.cmd [[ autocmd BufRead,BufNewFile *.scad set filetype=openscad ]]
or by installing a filetype plugin such as https://github.com/sirtaj/vim-openscad
Snippet to enable the language server:
require'lspconfig'.openscad_ls.setup{}
Default values:
cmd
:
{ "openscad-language-server" }
filetypes
:
{ "openscad" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/genericptr/pascal-language-server
An LSP server implementation for Pascal variants that are supported by Free Pascal, including Object Pascal. It uses CodeTools from Lazarus as backend.
First set cmd
to the Pascal lsp binary.
Customization options are passed to pasls as environment variables for example in your .bashrc
:
export FPCDIR='/usr/lib/fpc/src' # FPC source directory (This is the only required option for the server to work).
export PP='/usr/lib/fpc/3.2.2/ppcx64' # Path to the Free Pascal compiler executable.
export LAZARUSDIR='/usr/lib/lazarus' # Path to the Lazarus sources.
export FPCTARGET='' # Target operating system for cross compiling.
export FPCTARGETCPU='x86_64' # Target CPU for cross compiling.
Snippet to enable the language server:
require'lspconfig'.pasls.setup{}
Default values:
cmd
:
{ "pasls" }
filetypes
:
{ "pascal" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/richterger/Perl-LanguageServer/tree/master/clients/vscode/perl
Perl-LanguageServer
, a language server for Perl.
To use the language server, ensure that you have Perl::LanguageServer installed and perl command is on your path.
Snippet to enable the language server:
require'lspconfig'.perlls.setup{}
Default values:
cmd
:
{ "perl", "-MPerl::LanguageServer", "-e", "Perl::LanguageServer::run", "--", "--port 13603", "--nostdio 0", "--version 2.1.0" }
filetypes
:
{ "perl" }
root_dir
:
vim's starting directory
settings
:
{
perl = {
fileFilter = { ".pm", ".pl" },
ignoreDirs = ".git",
perlCmd = "perl",
perlInc = " "
}
}
single_file_support
:
true
https://github.com/bscan/PerlNavigator
A Perl language server
By default, perlnavigator doesn't have a cmd
set. This is because nvim-lspconfig does not make assumptions about your path.
You have to install the language server manually.
Clone the PerlNavigator repo, install based on the instructions,
and point cmd
to server.js
inside the server/out
directory:
cmd = {'node', '<path_to_repo>/server/out/server.js', '--stdio'}
At minimum, you will need perl
in your path. If you want to use a non-standard perl
you will need to set your configuration like so:
settings = {
perlnavigator = {
perlPath = '/some/odd/location/my-perl'
}
}
The contributes.configuration.properties
section of perlnavigator
's package.json
has all available configuration settings. All
settings have a reasonable default, but, at minimum, you may want to point perlnavigator
at your perltidy
and perlcritic
configurations.
Snippet to enable the language server:
require'lspconfig'.perlnavigator.setup{}
Default values:
cmd
:
{}
filetypes
:
{ "perl" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/FractalBoy/perl-language-server https://metacpan.org/pod/PLS
PLS
, another language server for Perl.
To use the language server, ensure that you have PLS installed and that it is in your path
Snippet to enable the language server:
require'lspconfig'.perlpls.setup{}
Default values:
cmd
:
{ "pls" }
filetypes
:
{ "perl" }
root_dir
:
util.find_git_ancestor
settings
:
{
perl = {
perlcritic = {
enabled = false
},
syntax = {
enabled = true
}
}
}
single_file_support
:
true
https://github.com/phpactor/phpactor
Installation: https://phpactor.readthedocs.io/en/master/usage/standalone.html#global-installation
Snippet to enable the language server:
require'lspconfig'.phpactor.setup{}
Default values:
cmd
:
{ "phpactor", "language-server" }
filetypes
:
{ "php" }
root_dir
:
root_pattern("composer.json", ".git")
https://github.com/thought-machine/please
High-performance extensible build system for reproducible multi-language builds.
The plz
binary will automatically install the LSP for you on first run
Snippet to enable the language server:
require'lspconfig'.please.setup{}
Default values:
cmd
:
{ "plz", "tool", "lps" }
filetypes
:
{ "bzl" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/PowerShell/PowerShellEditorServices
Language server for PowerShell.
To install, download and extract PowerShellEditorServices.zip
from the releases.
To configure the language server, set the property bundle_path
to the root
of the extracted PowerShellEditorServices.zip.
The default configuration doesn't set cmd
unless bundle_path
is specified.
require'lspconfig'.powershell_es.setup{
bundle_path = 'c:/w/PowerShellEditorServices',
}
By default the languageserver is started in pwsh
(PowerShell Core). This can be changed by specifying shell
.
require'lspconfig'.powershell_es.setup{
bundle_path = 'c:/w/PowerShellEditorServices',
shell = 'powershell.exe',
}
Note that the execution policy needs to be set to Unrestricted
for the languageserver run under PowerShell
If necessary, specific cmd
can be defined instead of bundle_path
.
See PowerShellEditorServices
to learn more.
require'lspconfig'.powershell_es.setup{
cmd = {'pwsh', '-NoLogo', '-NoProfile', '-Command', "c:/PSES/Start-EditorServices.ps1 ..."}
}
Snippet to enable the language server:
require'lspconfig'.powershell_es.setup{}
Default values:
filetypes
:
{ "ps1" }
on_new_config
:
see source file
root_dir
:
git root or current directory
shell
:
"pwsh"
single_file_support
:
true
Language Server for the Prisma JavaScript and TypeScript ORM
@prisma/language-server
can be installed via npm
npm install -g @prisma/language-server
Snippet to enable the language server:
require'lspconfig'.prismals.setup{}
Default values:
cmd
:
{ "prisma-language-server", "--stdio" }
filetypes
:
{ "prisma" }
root_dir
:
root_pattern(".git", "package.json")
settings
:
{
prisma = {
prismaFmtBinPath = ""
}
}
https://github.com/kitten/prosemd-lsp
An experimental LSP for Markdown.
Please see the manual installation instructions: https://github.com/kitten/prosemd-lsp#manual-installation
Snippet to enable the language server:
require'lspconfig'.prosemd_lsp.setup{}
Default values:
cmd
:
{ "prosemd-lsp", "--stdio" }
filetypes
:
{ "markdown" }
root_dir
:
<function 1>
single_file_support
:
true
https://github.com/vimeo/psalm
Can be installed with composer.
composer global require vimeo/psalm
Snippet to enable the language server:
require'lspconfig'.psalm.setup{}
Default values:
cmd
:
{ "psalm-language-server" }
filetypes
:
{ "php" }
root_dir
:
root_pattern("psalm.xml", "psalm.xml.dist")
LSP server for Puppet.
Installation:
-
Clone the editor-services repository: https://github.com/puppetlabs/puppet-editor-services
-
Navigate into that directory and run:
bundle install
-
Install the 'puppet-lint' gem:
gem install puppet-lint
-
Add that repository to $PATH.
-
Ensure you can run
puppet-languageserver
from outside the editor-services directory.
Snippet to enable the language server:
require'lspconfig'.puppet.setup{}
Default values:
cmd
:
{ "puppet-languageserver", "--stdio" }
filetypes
:
{ "puppet" }
root_dir
:
root_pattern("manifests", ".puppet-lint.rc", "hiera.yaml", ".git")
single_file_support
:
true
https://github.com/nwolverson/purescript-language-server
purescript-language-server
can be installed via npm
npm install -g purescript-language-server
Snippet to enable the language server:
require'lspconfig'.purescriptls.setup{}
Default values:
cmd
:
{ "purescript-language-server", "--stdio" }
filetypes
:
{ "purescript" }
root_dir
:
root_pattern("spago.dhall, 'psc-package.json', bower.json")
https://github.com/python-lsp/python-lsp-server
A Python 3.6+ implementation of the Language Server Protocol.
The language server can be installed via pipx install 'python-lsp-server[all]'
.
Further instructions can be found in the project's README.
Note: This is a community fork of pyls
.
Snippet to enable the language server:
require'lspconfig'.pylsp.setup{}
Default values:
cmd
:
{ "pylsp" }
filetypes
:
{ "python" }
root_dir
:
see source file
single_file_support
:
true
pyre
a static type checker for Python 3.
pyre
offers an extremely limited featureset. It currently only supports diagnostics,
which are triggered on save.
Do not report issues for missing features in pyre
to lspconfig
.
Snippet to enable the language server:
require'lspconfig'.pyre.setup{}
Default values:
cmd
:
{ "pyre", "persistent" }
filetypes
:
{ "python" }
root_dir
:
see source file
https://github.com/microsoft/pyright
pyright
, a static type checker and language server for python
Snippet to enable the language server:
require'lspconfig'.pyright.setup{}
Commands:
- PyrightOrganizeImports: Organize Imports
Default values:
cmd
:
{ "pyright-langserver", "--stdio" }
filetypes
:
{ "python" }
root_dir
:
see source file
settings
:
{
python = {
analysis = {
autoSearchPaths = true,
diagnosticMode = "workspace",
useLibraryCodeForTypes = true
}
}
}
single_file_support
:
true
quick-lint-js finds bugs in JavaScript programs.
See installation instructions
Snippet to enable the language server:
require'lspconfig'.quick_lint_js.setup{}
Default values:
cmd
:
{ "quick-lint-js", "--lsp-server" }
filetypes
:
{ "javascript" }
root_dir
:
see source file
single_file_support
:
true
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
install.packages("languageserver")
Snippet to enable the language server:
require'lspconfig'.r_language_server.setup{}
Default values:
cmd
:
{ "R", "--slave", "-e", "languageserver::run()" }
filetypes
:
{ "r", "rmd" }
log_level
:
2
root_dir
:
root_pattern(".git") or os_homedir
https://github.com/jeapostrophe/racket-langserver
The Racket language server. This project seeks to use DrRacket's public API to provide functionality that mimics DrRacket's code tools as closely as possible.
Install via raco
: raco pkg install racket-langserver
Snippet to enable the language server:
require'lspconfig'.racket_langserver.setup{}
Default values:
cmd
:
{ "racket", "--lib", "racket-langserver" }
filetypes
:
{ "racket", "scheme" }
root_dir
:
see source file
single_file_support
:
true
Reason language server
You can install reason language server from reason-language-server repository.
Snippet to enable the language server:
require'lspconfig'.reason_ls.setup{}
Default values:
cmd
:
{ "reason-language-server" }
filetypes
:
{ "reason" }
root_dir
:
see source file
https://github.com/remarkjs/remark-language-server
remark-language-server
can be installed via npm
:
npm install -g remark-language-server
remark-language-server
uses the same
configuration files
as remark-cli
.
This uses a plugin based system. Each plugin needs to be installed locally using npm
or yarn
.
For example, given the following .remarkrc.json
:
{
"presets": [
"remark-preset-lint-recommended"
]
}
remark-preset-lint-recommended
needs to be installed in the local project:
npm install remark-preset-lint-recommended
Snippet to enable the language server:
require'lspconfig'.remark_ls.setup{}
Default values:
cmd
:
{ "remark-language-server", "--stdio" }
filetypes
:
{ "markdown" }
root_dir
:
see source file
single_file_support
:
true
https://github.com/rescript-lang/rescript-vscode
ReScript language server
By default, rescriptls doesn't have a cmd
set. This is because nvim-lspconfig does not make assumptions about your path.
You have to install the language server manually.
You can use the bundled language server inside the vim-rescript repo.
Clone the vim-rescript repo and point cmd
to server.js
inside server/out
directory:
cmd = {'node', '<path_to_repo>/server/out/server.js', '--stdio'}
If you have vim-rescript installed you can also use that installation. for example if you're using packer.nvim you can set cmd to something like this:
cmd = {
'node',
'/home/username/.local/share/nvim/site/pack/packer/start/vim-rescript/server/out/server.js',
'--stdio'
}
Another option is to use vscode extension release. Take a look at here for instructions.
Snippet to enable the language server:
require'lspconfig'.rescriptls.setup{}
Default values:
cmd
:
{}
filetypes
:
{ "rescript" }
root_dir
:
see source file
settings
:
{}
https://github.com/rust-lang/rls
rls, a language server for Rust
See https://github.com/rust-lang/rls#setup to setup rls itself. See https://github.com/rust-lang/rls#configuration for rls-specific settings. All settings listed on the rls configuration section of the readme must be set under settings.rust as follows:
nvim_lsp.rls.setup {
settings = {
rust = {
unstable_features = true,
build_on_save = false,
all_features = true,
},
},
}
If you want to use rls for a particular build, eg nightly, set cmd as follows:
cmd = {"rustup", "run", "nightly", "rls"}
Snippet to enable the language server:
require'lspconfig'.rls.setup{}
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.
Snippet to enable the language server:
require'lspconfig'.rnix.setup{}
Default values:
cmd
:
{ "rnix-lsp" }
filetypes
:
{ "nix" }
init_options
:
{}
root_dir
:
vim's starting directory
settings
:
{}
https://github.com/robocorp/robotframework-lsp
Language Server Protocol implementation for Robot Framework.
Snippet to enable the language server:
require'lspconfig'.robotframework_ls.setup{}
Default values:
cmd
:
{ "robotframework_ls" }
filetypes
:
{ "robot" }
root_dir
:
util.root_pattern('robotidy.toml', 'pyproject.toml')(fname) or util.find_git_ancestor(fname)
Language server for the Rome Frontend Toolchain.
npm install [-g] rome
Snippet to enable the language server:
require'lspconfig'.rome.setup{}
Default values:
cmd
:
{ "rome", "lsp" }
filetypes
:
{ "javascript", "javascriptreact", "json", "typescript", "typescript.tsx", "typescriptreact" }
root_dir
:
root_pattern('package.json', 'node_modules', '.git')
single_file_support
:
true
https://github.com/rust-analyzer/rust-analyzer
rust-analyzer (aka rls 2.0), a language server for Rust
See docs for extra settings.
Snippet to enable the language server:
require'lspconfig'.rust_analyzer.setup{}
Commands:
- CargoReload: Reload current cargo workspace
Default values:
cmd
:
{ "rust-analyzer" }
filetypes
:
{ "rust" }
root_dir
:
root_pattern("Cargo.toml", "rust-project.json")
settings
:
{
["rust-analyzer"] = {}
}
Language server for Salt configuration files. https://github.com/dcermak/salt-lsp
The language server can be installed with pip
:
pip install salt-lsp
Snippet to enable the language server:
require'lspconfig'.salt_ls.setup{}
Default values:
cmd
:
{ "salt_lsp_server" }
filetypes
:
{ "sls" }
root_dir
:
root_pattern('.git')
single_file_support
:
true
https://github.com/crystal-lang-tools/scry
Crystal language server.
Snippet to enable the language server:
require'lspconfig'.scry.setup{}
Default values:
cmd
:
{ "scry" }
filetypes
:
{ "crystal" }
root_dir
:
root_pattern('shard.yml', '.git')
single_file_support
:
true
https://github.com/Pure-D/serve-d
`Microsoft language server protocol implementation for D using workspace-d.`
Download a binary from https://github.com/Pure-D/serve-d/releases and put it in your $PATH.
Snippet to enable the language server:
require'lspconfig'.serve_d.setup{}
Default values:
cmd
:
{ "serve-d" }
filetypes
:
{ "d" }
root_dir
:
util.root_pattern("dub.json", "dub.sdl", ".git")
https://github.com/sixtyfpsui/sixtyfps
SixtyFPS
's language server
You can build and install sixtyfps-lsp
binary with cargo
:
cargo install sixtyfps-lsp
Vim does not have built-in syntax for the sixtyfps
filetype currently.
This can be added via an autocmd:
vim.cmd [[ autocmd BufRead,BufNewFile *.60 set filetype=sixtyfps ]]
or by installing a filetype plugin such as https://github.com/RustemB/sixtyfps-vim
Snippet to enable the language server:
require'lspconfig'.sixtyfps.setup{}
Default values:
cmd
:
{ "sixtyfps-lsp" }
filetypes
:
{ "sixtyfps" }
single_file_support
:
true
https://github.com/slint-ui/slint
Slint
's language server
You can build and install slint-lsp
binary with cargo
:
cargo install slint-lsp
Vim does not have built-in syntax for the slint
filetype at this time.
This can be added via an autocmd:
vim.cmd [[ autocmd BufRead,BufNewFile *.slint set filetype=slint ]]
Snippet to enable the language server:
require'lspconfig'.slint_lsp.setup{}
Default values:
cmd
:
{ "slint-lsp" }
filetypes
:
{ "slint" }
single_file_support
:
true
A language server for Solidity
See the documentation for installation instructions.
The language server only provides the following capabilities:
- Syntax highlighting
- Diagnostics
- Hover
There is currently no support for completion, goto definition, references, or other functionality.
Snippet to enable the language server:
require'lspconfig'.solang.setup{}
Default values:
cmd
:
{ "solang", "--language-server", "--target", "ewasm" }
filetypes
:
{ "solidity" }
root_dir
:
util.find_git_ancestor
solargraph, a language server for Ruby
You can install solargraph via gem install.
gem install --user-install solargraph
Snippet to enable the language server:
require'lspconfig'.solargraph.setup{}
Default values:
cmd
:
{ "solargraph", "stdio" }
filetypes
:
{ "ruby" }
init_options
:
{
formatting = true
}
root_dir
:
root_pattern("Gemfile", ".git")
settings
:
{
solargraph = {
diagnostics = true
}
}
https://docs.soliditylang.org/en/latest/installing-solidity.html
solc is the native language server for the Solidity language.
Snippet to enable the language server:
require'lspconfig'.solc.setup{}
Default values:
cmd
:
{ "solc", "--lsp" }
filetypes
:
{ "solidity" }
root_dir
:
root_pattern(".git")
npm install -g solidity-language-server
solidity-language-server is a language server for the solidity language ported from the vscode solidity extension
Snippet to enable the language server:
require'lspconfig'.solidity_ls.setup{}
Default values:
cmd
:
{ "solidity-language-server", "--stdio" }
filetypes
:
{ "solidity" }
root_dir
:
root_pattern(".git", "package.json")
Sorbet is a fast, powerful type checker designed for Ruby.
You can install Sorbet via gem install. You might also be interested in how to set Sorbet up for new projects: https://sorbet.org/docs/adopting.
gem install sorbet
Snippet to enable the language server:
require'lspconfig'.sorbet.setup{}
Default values:
cmd
:
{ "srb", "tc", "--lsp" }
filetypes
:
{ "ruby" }
root_dir
:
root_pattern("Gemfile", ".git")
https://github.com/apple/sourcekit-lsp
Language server for Swift and C/C++/Objective-C.
Snippet to enable the language server:
require'lspconfig'.sourcekit.setup{}
Default values:
cmd
:
{ "sourcekit-lsp" }
filetypes
:
{ "swift", "c", "cpp", "objective-c", "objective-cpp" }
root_dir
:
root_pattern("Package.swift", ".git")
https://github.com/sourcery-ai/sourcery
Refactor Python instantly using the power of AI.
It requires the initializationOptions param to be populated as shown below and will respond with the list of ServerCapabilities that it supports.
init_options = { --- The Sourcery token for authenticating the user. --- This is retrieved from the Sourcery website and must be --- provided by each user. The extension must provide a --- configuration option for the user to provide this value. token = <YOUR_TOKEN>
--- The extension's name and version as defined by the extension.
extension_version = 'vim.lsp'
--- The editor's name and version as defined by the editor.
editor_version = 'vim'
}
Snippet to enable the language server:
require'lspconfig'.sourcery.setup{}
Default values:
cmd
:
{ "sourcery", "lsp" }
filetypes
:
{ "python" }
init_options
:
{
editor_version = "vim",
extension_version = "vim.lsp"
}
root_dir
:
see source file
single_file_support
:
true
https://github.com/luizcorreia/spectral-language-server
A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v2 & v3.
spectral-language-server
can be installed via npm
:
npm i -g spectral-language-server
See vscode-spectral for configuration options.
Snippet to enable the language server:
require'lspconfig'.spectral.setup{}
Default values:
cmd
:
{ "spectral-language-server", "--stdio" }
filetypes
:
{ "yaml", "json", "yml" }
root_dir
:
see source file
settings
:
{
enable = true,
run = "onType",
validateLanguages = { "yaml", "json", "yml" }
}
single_file_support
:
true
https://github.com/joe-re/sql-language-server
This LSP can be installed via npm
. Find further instructions on manual installation of the sql-language-server at joe-re/sql-language-server.
Snippet to enable the language server:
require'lspconfig'.sqlls.setup{}
Default values:
cmd
:
{ "sql-language-server", "up", "--method", "stdio" }
filetypes
:
{ "sql", "mysql" }
root_dir
:
see source file
settings
:
{}
https://github.com/lighttiger2505/sqls
require'lspconfig'.sqls.setup{
cmd = {"path/to/command", "-config", "path/to/config.yml"};
...
}
Sqls can be installed via go get github.com/lighttiger2505/sqls
. Instructions for compiling Sqls from the source can be found at lighttiger2505/sqls.
Snippet to enable the language server:
require'lspconfig'.sqls.setup{}
Default values:
cmd
:
{ "sqls" }
filetypes
:
{ "sql", "mysql" }
root_dir
:
see source file
settings
:
{}
single_file_support
:
true
https://github.com/soutaro/steep
steep
is a static type checker for Ruby.
You need Steepfile
to make it work. Generate it with steep init
.
Snippet to enable the language server:
require'lspconfig'.steep.setup{}
Default values:
cmd
:
{ "steep", "langserver" }
filetypes
:
{ "ruby", "eruby" }
root_dir
:
root_pattern("Steepfile", ".git")
https://github.com/bmatcuk/stylelint-lsp
stylelint-lsp
can be installed via npm
:
npm i -g stylelint-lsp
Can be configured by passing a settings.stylelintplus
object to stylelint_lsp.setup
:
require'lspconfig'.stylelint_lsp.setup{
settings = {
stylelintplus = {
-- see available options in stylelint-lsp documentation
}
}
}
Snippet to enable the language server:
require'lspconfig'.stylelint_lsp.setup{}
Default values:
cmd
:
{ "stylelint-lsp", "--stdio" }
filetypes
:
{ "css", "less", "scss", "sugarss", "vue", "wxss", "javascript", "javascriptreact", "typescript", "typescriptreact" }
root_dir
:
root_pattern('.stylelintrc', 'package.json')
settings
:
{}
https://github.com/sumneko/lua-language-server
Lua language server.
lua-language-server
can be installed by following the instructions here.
The default cmd
assumes that the lua-language-server
binary can be found in $PATH
.
If you primarily use lua-language-server
for Neovim, and want to provide completions,
analysis, and location handling for plugins on runtime path, you can use the following
settings.
Note: that these settings will meaningfully increase the time until lua-language-server
can service
initial requests (completion, location) upon starting as well as time to first diagnostics.
Completion results will include a workspace indexing progress message until the server has finished indexing.
require'lspconfig'.sumneko_lua.setup {
settings = {
Lua = {
runtime = {
-- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim)
version = 'LuaJIT',
},
diagnostics = {
-- Get the language server to recognize the `vim` global
globals = {'vim'},
},
workspace = {
-- Make the server aware of Neovim runtime files
library = vim.api.nvim_get_runtime_file("", true),
},
-- Do not send telemetry data containing a randomized but unique identifier
telemetry = {
enable = false,
},
},
},
}
See lua-language-server
's documentation for an explanation of the above fields:
Snippet to enable the language server:
require'lspconfig'.sumneko_lua.setup{}
Default values:
cmd
:
{ "lua-language-server" }
filetypes
:
{ "lua" }
log_level
:
2
root_dir
:
root_pattern(".luarc.json", ".luacheckrc", ".stylua.toml", "selene.toml", ".git")
settings
:
{
Lua = {
telemetry = {
enable = false
}
}
}
single_file_support
:
true
https://github.com/sveltejs/language-tools/tree/master/packages/language-server
svelte-language-server
can be installed via npm
:
npm install -g svelte-language-server
Snippet to enable the language server:
require'lspconfig'.svelte.setup{}
Default values:
cmd
:
{ "svelteserver", "--stdio" }
filetypes
:
{ "svelte" }
root_dir
:
root_pattern("package.json", ".git")
https://github.com/dalance/svls
Language server for verilog and SystemVerilog
svls
can be installed via cargo
:
cargo install svls
Snippet to enable the language server:
require'lspconfig'.svls.setup{}
Default values:
cmd
:
{ "svls" }
filetypes
:
{ "verilog", "systemverilog" }
root_dir
:
util.find_git_ancestor
https://github.com/tailwindlabs/tailwindcss-intellisense
Tailwind CSS Language Server can be installed via npm:
npm install -g @tailwindcss/language-server
Snippet to enable the language server:
require'lspconfig'.tailwindcss.setup{}
Default values:
cmd
:
{ "tailwindcss-language-server", "--stdio" }
filetypes
:
{ "aspnetcorerazor", "astro", "astro-markdown", "blade", "django-html", "htmldjango", "edge", "eelixir", "ejs", "erb", "eruby", "gohtml", "haml", "handlebars", "hbs", "html", "html-eex", "heex", "jade", "leaf", "liquid", "markdown", "mdx", "mustache", "njk", "nunjucks", "php", "razor", "slim", "twig", "css", "less", "postcss", "sass", "scss", "stylus", "sugarss", "javascript", "javascriptreact", "reason", "rescript", "typescript", "typescriptreact", "vue", "svelte" }
init_options
:
{
userLanguages = {
eelixir = "html-eex",
eruby = "erb"
}
}
on_new_config
:
see source file
root_dir
:
root_pattern('tailwind.config.js', 'tailwind.config.ts', 'postcss.config.js', 'postcss.config.ts', 'package.json', 'node_modules', '.git')
settings
:
{
tailwindCSS = {
classAttributes = { "class", "className", "classList", "ngClass" },
lint = {
cssConflict = "warning",
invalidApply = "error",
invalidConfigPath = "error",
invalidScreen = "error",
invalidTailwindDirective = "error",
invalidVariant = "error",
recommendedVariantOrder = "warning"
},
validate = true
}
}
https://taplo.tamasfe.dev/lsp/
Language server for Taplo, a TOML toolkit.
taplo-cli
can be installed via cargo
:
cargo install --locked taplo-cli
Snippet to enable the language server:
require'lspconfig'.taplo.setup{}
Default values:
cmd
:
{ "taplo", "lsp", "stdio" }
filetypes
:
{ "toml" }
root_dir
:
root_pattern("*.toml", ".git")
single_file_support
:
true
https://github.com/teal-language/teal-language-server
Install with:
luarocks install --dev teal-language-server
Snippet to enable the language server:
require'lspconfig'.teal_ls.setup{}
Default values:
cmd
:
{ "teal-language-server" }
filetypes
:
{ "teal" }
root_dir
:
root_pattern("tlconfig.lua", ".git")
https://github.com/juliosueiras/terraform-lsp
Terraform language server Download a released binary from https://github.com/juliosueiras/terraform-lsp/releases.
From https://github.com/hashicorp/terraform-ls#terraform-ls-vs-terraform-lsp:
Both HashiCorp and the maintainer of terraform-lsp expressed interest in collaborating on a language server and are working towards a long-term goal of a single stable and feature-complete implementation.
For the time being both projects continue to exist, giving users the choice:
-
terraform-ls
providing- overall stability (by relying only on public APIs)
- compatibility with any provider and any Terraform >=0.12.0 currently less features
- due to project being younger and relying on public APIs which may not offer the same functionality yet
-
terraform-lsp
providing- currently more features
- compatibility with a single particular Terraform (0.12.20 at time of writing)
- configs designed for other 0.12 versions may work, but interpretation may be inaccurate
- less stability (due to reliance on Terraform's own internal packages)
Snippet to enable the language server:
require'lspconfig'.terraform_lsp.setup{}
Default values:
cmd
:
{ "terraform-lsp" }
filetypes
:
{ "terraform", "hcl" }
root_dir
:
root_pattern(".terraform", ".git")
https://github.com/hashicorp/terraform-ls
Terraform language server Download a released binary from https://github.com/hashicorp/terraform-ls/releases.
From https://github.com/hashicorp/terraform-ls#terraform-ls-vs-terraform-lsp:
Both HashiCorp and the maintainer of terraform-lsp expressed interest in collaborating on a language server and are working towards a long-term goal of a single stable and feature-complete implementation.
For the time being both projects continue to exist, giving users the choice:
-
terraform-ls
providing- overall stability (by relying only on public APIs)
- compatibility with any provider and any Terraform >=0.12.0 currently less features
- due to project being younger and relying on public APIs which may not offer the same functionality yet
-
terraform-lsp
providing- currently more features
- compatibility with a single particular Terraform (0.12.20 at time of writing)
- configs designed for other 0.12 versions may work, but interpretation may be inaccurate
- less stability (due to reliance on Terraform's own internal packages)
Snippet to enable the language server:
require'lspconfig'.terraformls.setup{}
Default values:
cmd
:
{ "terraform-ls", "serve" }
filetypes
:
{ "terraform" }
root_dir
:
root_pattern(".terraform", ".git")
https://github.com/latex-lsp/texlab
A completion engine built from scratch for (La)TeX.
See https://github.com/latex-lsp/texlab/blob/master/docs/options.md for configuration options.
Snippet to enable the language server:
require'lspconfig'.texlab.setup{}
Commands:
- TexlabBuild: Build the current buffer
- TexlabForward: Forward search from current position
Default values:
cmd
:
{ "texlab" }
filetypes
:
{ "tex", "bib" }
root_dir
:
see source file
settings
:
{
texlab = {
auxDirectory = ".",
bibtexFormatter = "texlab",
build = {
args = { "-pdf", "-interaction=nonstopmode", "-synctex=1", "%f" },
executable = "latexmk",
forwardSearchAfter = false,
onSave = false
},
chktex = {
onEdit = false,
onOpenAndSave = false
},
diagnosticsDelay = 300,
formatterLineLength = 80,
forwardSearch = {
args = {}
},
latexFormatter = "latexindent",
latexindent = {
modifyLineBreaks = false
}
}
}
single_file_support
:
true
https://github.com/terraform-linters/tflint
A pluggable Terraform linter that can act as lsp server. Installation instructions can be found in https://github.com/terraform-linters/tflint#installation.
Snippet to enable the language server:
require'lspconfig'.tflint.setup{}
Default values:
cmd
:
{ "tflint", "--langserver" }
filetypes
:
{ "terraform" }
root_dir
:
root_pattern(".terraform", ".git", ".tflint.hcl")
https://github.com/Shopify/shopify-cli
theme-check-language-server
is bundled with shopify-cli
or it can also be installed via
https://github.com/Shopify/theme-check#installation
NOTE:
If installed via Homebrew, cmd
must be set to 'theme-check-liquid-server'
require lspconfig.theme_check.setup {
cmd = { 'theme-check-liquid-server' }
}
Snippet to enable the language server:
require'lspconfig'.theme_check.setup{}
Default values:
cmd
:
{ "theme-check-language-server", "--stdio" }
filetypes
:
{ "liquid" }
root_dir
:
see source file
settings
:
{}
https://github.com/theia-ide/typescript-language-server
typescript-language-server
depends on typescript
. Both packages can be installed via npm
:
npm install -g typescript typescript-language-server
To configure type language server, add a
tsconfig.json
or
jsconfig.json
to the root of your
project.
Here's an example that disables type checking in JavaScript files.
{
"compilerOptions": {
"module": "commonjs",
"target": "es6",
"checkJs": false
},
"exclude": [
"node_modules"
]
}
Snippet to enable the language server:
require'lspconfig'.tsserver.setup{}
Default values:
cmd
:
{ "typescript-language-server", "--stdio" }
filetypes
:
{ "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" }
init_options
:
{
hostInfo = "neovim"
}
root_dir
:
root_pattern("package.json", "tsconfig.json", "jsconfig.json", ".git")
https://github.com/ruby/typeprof
typeprof
is the built-in analysis and LSP tool for Ruby 3.1+.
Snippet to enable the language server:
require'lspconfig'.typeprof.setup{}
Default values:
cmd
:
{ "typeprof", "--lsp", "--stdio" }
filetypes
:
{ "ruby", "eruby" }
root_dir
:
root_pattern("Gemfile", ".git")
https://github.com/Prince781/vala-language-server
Snippet to enable the language server:
require'lspconfig'.vala_ls.setup{}
Default values:
cmd
:
{ "vala-language-server" }
filetypes
:
{ "vala", "genie" }
root_dir
:
root_pattern("meson.build", ".git")
single_file_support
:
true
https://github.com/nickbattle/vdmj
The VDMJ language server can be installed by cloning the VDMJ repository and
running mvn clean install
.
Various options are provided to configure the language server (see below). In particular:
annotation_paths
is a list of folders and/or jar file paths for annotations that should be used with the language server;- any value of
debugger_port
less than zero will disable the debugger; note that if a non-zero value is used, only one instance of the server can be active at a time.
More settings for VDMJ can be changed in a file called vdmj.properties
under
root_dir/.vscode
. For a description of the available settings, see
Section 7 of the VDMJ User Guide.
Note: proof obligations and combinatorial testing are not currently supported by neovim.
Snippet to enable the language server:
require'lspconfig'.vdmj.setup{}
Default values:
cmd
:
Generated from the options given
filetypes
:
{ "vdmsl", "vdmpp", "vdmrt" }
options
:
{
annotation_paths = {},
debugger_port = -1,
high_precision = false,
java = "$JAVA_HOME/bin/java",
java_opts = { "-Xmx3000m", "-Xss1m" },
logfile = "path.join(vim.fn.stdpath 'cache', 'vdm-lsp.log')",
mavenrepo = "$HOME/.m2/repository/com/fujitsu",
version = "The latest version installed in `mavenrepo`"
}
root_dir
:
util.find_git_ancestor(fname) or find_vscode_ancestor(fname)
https://github.com/chipsalliance/verible
A linter and formatter for verilog and SystemVerilog files.
Release binaries can be downloaded from here and placed in a directory on PATH.
See https://github.com/chipsalliance/verible/tree/master/verilog/tools/ls/README.md for options.
Snippet to enable the language server:
require'lspconfig'.verible.setup{}
Default values:
cmd
:
{ "verible-verilog-ls" }
filetypes
:
{ "systemverilog", "verilog" }
root_dir
:
see source file
https://github.com/iamcco/vim-language-server
You can install vim-language-server via npm:
npm install -g vim-language-server
Snippet to enable the language server:
require'lspconfig'.vimls.setup{}
Default values:
cmd
:
{ "vim-language-server", "--stdio" }
filetypes
:
{ "vim" }
init_options
:
{
diagnostic = {
enable = true
},
indexes = {
count = 3,
gap = 100,
projectRootPatterns = { "runtime", "nvim", ".git", "autoload", "plugin" },
runtimepath = true
},
isNeovim = true,
iskeyword = "@,48-57,_,192-255,-#",
runtimepath = "",
suggest = {
fromRuntimepath = true,
fromVimruntime = true
},
vimruntime = ""
}
root_dir
:
see source file
single_file_support
:
true
V language server.
v-language-server
can be installed by following the instructions here.
**Snippet to enable the language server:**
```lua
require'lspconfig'.vls.setup{}
Default values:
cmd
:
{ "vls" }
filetypes
:
{ "vlang" }
root_dir
:
root_pattern("v.mod", ".git")
https://github.com/johnsoncodehk/volar/tree/master/packages/vue-language-server
Volar language server for Vue
Volar can be installed via npm:
npm install -g @volar/vue-language-server
Volar by default supports Vue 3 projects. Vue 2 projects need additional configuration.
Take Over Mode
Volar can serve as a language server for both Vue and TypeScript via Take Over Mode.
To enable Take Over Mode, override the default filetypes in setup{}
as follows:
require'lspconfig'.volar.setup{
filetypes = {'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'vue', 'json'}
}
Overriding the default TypeScript Server used by Volar
The default config looks for TS in the local node_modules
. This can lead to issues
e.g. when working on a monorepo. The alternatives are:
- use a global TypeScript Server installation
require'lspconfig'.volar.setup{
init_options = {
typescript = {
serverPath = '/path/to/.npm/lib/node_modules/typescript/lib/tsserverlib.js'
-- Alternative location if installed as root:
-- serverPath = '/usr/local/lib/node_modules/typescript/lib/tsserverlibrary.js'
}
}
}
- use a local server and fall back to a global TypeScript Server installation
local util = require 'lspconfig.util'
local function get_typescript_server_path(root_dir)
local global_ts = '/home/[yourusernamehere]/.npm/lib/node_modules/typescript/lib/tsserverlibrary.js'
-- Alternative location if installed as root:
-- local global_ts = '/usr/local/lib/node_modules/typescript/lib/tsserverlibrary.js'
local found_ts = ''
local function check_dir(path)
found_ts = util.path.join(path, 'node_modules', 'typescript', 'lib', 'tsserverlibrary.js')
if util.path.exists(found_ts) then
return path
end
end
if util.search_ancestors(root_dir, check_dir) then
return found_ts
else
return global_ts
end
end
require'lspconfig'.volar.setup{
on_new_config = function(new_config, new_root_dir)
new_config.init_options.typescript.serverPath = get_typescript_server_path(new_root_dir)
end,
}
Snippet to enable the language server:
require'lspconfig'.volar.setup{}
Default values:
cmd
:
{ "vue-language-server", "--stdio" }
filetypes
:
{ "vue" }
init_options
:
{
documentFeatures = {
documentColor = false,
documentFormatting = {
defaultPrintWidth = 100
},
documentSymbol = true,
foldingRange = true,
linkedEditingRange = true,
selectionRange = true
},
languageFeatures = {
callHierarchy = true,
codeAction = true,
codeLens = true,
completion = {
defaultAttrNameCase = "kebabCase",
defaultTagNameCase = "both"
},
definition = true,
diagnostics = true,
documentHighlight = true,
documentLink = true,
hover = true,
implementation = true,
references = true,
rename = true,
renameFileRefactoring = true,
schemaRequestService = true,
semanticTokens = false,
signatureHelp = true,
typeDefinition = true
},
typescript = {
serverPath = ""
}
}
on_new_config
:
see source file
root_dir
:
see source file
https://github.com/vuejs/vetur/tree/master/server
Vue language server(vls)
vue-language-server
can be installed via npm
:
npm install -g vls
Snippet to enable the language server:
require'lspconfig'.vuels.setup{}
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 yarn
:
yarn global add yaml-language-server
To use a schema for validation, there are two options:
- Add a modeline to the file. A modeline is a comment of the form:
# yaml-language-server: $schema=<urlToTheSchema|relativeFilePath|absoluteFilePath}>
where the relative filepath is the path relative to the open yaml file, and the absolute filepath is the filepath relative to the filesystem root ('/' on unix systems)
- Associated a schema url, relative , or absolute (to root of project, not to filesystem root) path to
the a glob pattern relative to the detected project root. Check
:LspInfo
to determine the resolved project root.
require('lspconfig').yamlls.setup {
... -- other configuration for setup {}
settings = {
yaml = {
... -- other settings. note this overrides the lspconfig defaults.
schemas = {
["https://json.schemastore.org/github-workflow.json"] = "/.github/workflows/*"
["../path/relative/to/file.yml"] = "/.github/workflows/*"
["/path/from/root/of/project"] = "/.github/workflows/*"
},
},
}
}
Currently, kubernetes is special-cased in yammls, see the following upstream issues:
To override a schema to use a specific k8s schema version (for example, to use 1.18):
require('lspconfig').yamlls.setup {
... -- other configuration for setup {}
settings = {
yaml = {
... -- other settings. note this overrides the lspconfig defaults.
schemas = {
["https://raw.githubusercontent.com/instrumenta/kubernetes-json-schema/master/v1.18.0-standalone-strict/all.json"] = "/*.k8s.yaml",
... -- other schemas
},
},
}
}
Snippet to enable the language server:
require'lspconfig'.yamlls.setup{}
Default values:
cmd
:
{ "yaml-language-server", "--stdio" }
filetypes
:
{ "yaml", "yaml.docker-compose" }
root_dir
:
util.find_git_ancestor
settings
:
{
redhat = {
telemetry = {
enabled = false
}
}
}
single_file_support
:
true
https://github.com/artempyanykh/zeta-note
Markdown LSP server for easy note-taking with cross-references and diagnostics.
Binaries can be downloaded from https://github.com/artempyanykh/zeta-note/releases
**Snippet to enable the language server:**
```lua
require'lspconfig'.zeta_note.setup{}
Default values:
cmd
:
{ "zeta-note" }
filetypes
:
{ "markdown" }
root_dir
:
root_pattern(".zeta.toml")
github.com/mickael-menu/zk
A plain text note-taking assistant
Snippet to enable the language server:
require'lspconfig'.zk.setup{}
Commands:
- ZkIndex: Index
- ZkNew: ZkNew
Default values:
cmd
:
{ "zk", "lsp" }
filetypes
:
{ "markdown" }
root_dir
:
root_pattern(".zk")
https://github.com/zigtools/zls
Zig LSP implementation + Zig Language Server
Snippet to enable the language server:
require'lspconfig'.zls.setup{}
Default values:
cmd
:
{ "zls" }
filetypes
:
{ "zig", "zir" }
root_dir
:
util.root_pattern("zls.json", ".git")
single_file_support
:
true
vim:ft=markdown