vim-lsp-settings

Auto configurations for Language Server for vim-lsp

Introduction

Language Servers is not easily to install. Visual Studio Code provide easy way to install/update Language Server and Language Server Client. This plugin provide same feature on Vim.

Installation instruction

For vim-plug plugin manager:

Plug 'prabirshrestha/async.vim'
Plug 'prabirshrestha/vim-lsp'
Plug 'mattn/vim-lsp-settings'

You need to install both vim-lsp and its accompanying plugins and vim-lsp-settings.

If you want to use autocompletion plugin, you can use followings.

asyncomplete.vim

Plug 'prabirshrestha/asyncomplete.vim'
Plug 'prabirshrestha/asyncomplete-lsp.vim'

deoplete.nvim

Plug 'Shougo/deoplete.nvim'
Plug 'lighttiger2505/deoplete-vim-lsp'

Notice

If you use plugin manager that is merging plugins (ex. dein), Please setting stop merging work(ex. dein / merged = 0) or set g:lsp_settings_servers_dir option to a different directory from the vim-lsp's default.

reason:

Servers are installed in ./servers directory at the caching area in default. But when rebuild the cache, any merging plugin manager erases old cached files(include ./servers and server execute files) before install. You can change the directory to install servers by set g:lsp_settings_servers_dir option in full path.

Usage

While editing a file with a supported filetype:

:LspInstallServer

Currently, no way to uninstall/update server. Run this command again, newer version will be installed.

Supported Languages

Notes

clangd (C/C++)

There is a Linux OS/version that does not run locally installed clangd due to zlib version mismatch. If you want to use clangd, please install clangd on your system.

rls (Rust)

If you install rls already, you can use rls without configurations. But if you not installed rls yet, you can install it by following this instruction.

gql-language-server (GraphQL)

To use gql-language-server, .gqlconfig have to be located on the top of project directory. And schema must be pointed to the schema file correctly.

{
  schema: {
    files: 'path/to/schema.graphql'
  }
}

Finally, you have to install @playlyfe/gql into your project.

$ npm install @playlyfe/gql --save-dev

Configurations

Most of configurations are not required.

If you install clangd already, you can use clangd for C/C++ without configurations. But if you install clang with named clangd-6.0, you can replace executable like below:

let g:lsp_settings = {
\  'clangd': {'cmd': ['clangd-6.0']},
\  'efm-langserver': {'disabled': v:false}
\}

Or put .vim-lsp-settings/settings.json on your project root directory.

{
  "clangd": {
    "cmd": ["clangd-6.0"]
  },
  "efm-langserver": {
    "disabled": false
  }
}

To edit project local settings.json, do :LspSettingsLocalEdit.

Overridable keys are:

• cmd (List ex: ['clangd-6.0', '-enable-snippets'])
• initialization_options (Dictionary)
• whitelist (List)
• blacklist (List)
• config (Dictionary)
• workspace_config (Dictionary)
• disabled (Boolean)
• root_uri (String)
• root_uri_patterns (List)

If you install ruby but not solargraph, you can install solargraph with following command.

If you have some Language Servers and want to use specified the server:

let g:lsp_settings_perl = 'slp'
let g:lsp_settings_typescript = ['typescript-language-server', 'eslint-language-server']

When the servers are specifed in a list, these will be started at all.

If you want to disable Language Server:

let g:lsp_settings = {
\  'perl-languageserver': {
\    'disabled': 1,
\   }
\}

License

MIT

Author

Yasuhiro Matsumoto (a.k.a. mattn)