Available Layers » lsp

• Description
• Features
• Install
  • Install language server
• Configuration
  • neovim(>=0.5.0)
  • vim or neovim(<0.5.0)
• Key bindings

Description

This layers adds extensive support for language-server-protocol. By default, this layer use following language server client implementations:

1. vim-lsp: for vim
2. LanguageClient-neovim: for neovim
3. built-in lsp: for neovim(>=0.5.0)

Features

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

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

Install

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

[[layers]]
  name = "lsp"

Install language server

Ada

After installing AdaCore’s GNAT Studio, add the directory containing ada_language_server to your PATH variable. For instance, if the GNAT Studio 2020 was installed, ada_language_server is present by default in /opt/GNAT/2020/libexec/gnatstudio/als.

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

css:

npm install -g vscode-css-languageserver-bin

ruby:

gem install solargraph

Elm:

npm install -g @elm-tooling/elm-language-server
npm install -g elm elm-test elm-format

vim

npm install -g vim-language-server

Configuration

neovim(>=0.5.0)

If you are using nvim(>=0.5.0). You need to use enabled_clients to specific the language servers. for example:

[[layers]]
    name = 'lsp'
    enabled_clients = ['vimls', 'clangd']

To override the command of client, you may need to use override_client_cmds option:

[[layers]]
  name = "lsp"
  enabled_clients = ['vimls', 'clangd']
  [layers.override_client_cmds]
    vimls = ["vim-language-server", "--stdio"]

vim or neovim(<0.5.0)

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

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

default language server commands:

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

if the checkers layer is not loaded, these key bindings will be added: