SpaceVim/docs/layers/language-server-protocol.md

title	description
SpaceVim language server protocol layer	This layers provides language server protocol for vim and neovim

Available Layers >> lsp

• Description
• Features
• Install
  • Install language server
• Configuration
• Key bindings

Description

This layers adds extensive support for language-server-protocol, This layer is a heavy wallpaper of LanguageClient-neovim (an old fork), The upstream is rewritten by rust.

we also include vim-lsp, which is wrote in pure vim script.

the neovim team is going to implement the build-in LSP support, the PR is neovim#6856. and the author of this PR create another plugin tjdevries/nvim-langserver-shim

SpaceVim should works well in different version of vim/neovim, so in the features, the logic of this layer should be:

if has('nvim')
  " use neovim build-in lsp
elseif has('python3')
  " use LanguageClient-neovim
else
  " use vim-lsp
endif

Features

• Asynchronous calls
• Code completion (provided by autocomplet layer)
• Lint on the fly
• Rename symbol
• Hover/Get identifer info.
• Goto definition.
• Goto reference locations.
• Workspace/Document symbols query.
• Formatting.
• Code Action/Fix.

Note: All these features dependent on the implementation of the language server, please check the list of Language Servers

Install

To use this configuration layer, update custom configuration file with:

[[layers]]
  name = "lsp"

Install language server

Bash

npm i -g bash-language-server

JavaScript:

npm install -g javascript-typescript-langserver

Python:

pip install --user python-language-server

julia:

The LanguageServer package must be installed in Julia (0.6 or greater), i.e.

julia> Pkg.clone("https://github.com/JuliaEditorSupport/LanguageServer.jl")

With new package system in Julia 0.7 and above, we have a package mode in Julia REPL. in REPL, hit ] to enter the package management mode, then add LanguageServer to install the package.

PureScript

npm install -g purescript-language-server

Vue:

npm install vue-language-server -g

Configuration

To enable lsp support for a specified filetype, you may need to load this layer with filtypes option, for example:

[[layers]]
  name = "lsp"
  filetypes = [
    "rust",
    "javascript"
  ]

default language server commands:

language	server command
javascript	['javascript-typescript-stdio']
sh	['bash-language-server', 'start']
typescript	['typescript-language-server', '--stdio']
haskell	['hie', '--lsp']
c	['clangd']
cpp	['clangd']
html	['html-languageserver', '--stdio']
objc	['clangd']
objcpp	['clangd']
dart	['dart_language_server']
go	['go-langserver', '-mode', 'stdio']
rust	['rustup', 'run', 'nightly', 'rls']
python	['pyls']
php	['php', 'path/to/bin/php-language-server.php']
julia	['julia', '--startup-file=no', '--history-file=no', '-e', 'using LanguageServer; server = LanguageServer.LanguageServerInstance(STDIN, STDOUT, false); server.runlinter = true; run(server);']
purescript	['purescript-language-server', '--stdio']
vue	['vls']

To override the server command, you may need to use override_cmd option:

[[layers]]
  name = "lsp"
  filetypes = [
    "rust",
    "javascript"
  ]
  [layers.override_cmd]
    rust = ["rustup", "run", "nightly", "rls"]

Key bindings

Key Binding	Description
K / SPC l d	show document
SPC l e	rename symbol