Repository files navigation

AsyncLanguage Server Protocol plugin for vim8 and neovim.

Installvim-plug and then:

Plug'prabirshrestha/vim-lsp'

Performance

Certain bottlenecks in Vim script have been implemented in lua. If you would like to take advantage of these performance gainsuse vim compiled with lua or neovim v0.4.0+

ifexecutable('pylsp')" pip install python-lsp-serverauUserlsp_setupcalllsp#register_server({\'name':'pylsp',\'cmd': {server_info->['pylsp']},\'allowlist': ['python'],\})endiffunction!s:on_lsp_buffer_enabled()abortsetlocalomnifunc=lsp#completesetlocalsigncolumn=yesifexists('+tagfunc') |setlocaltagfunc=lsp#tagfunc |endifnmap<buffer>gd<plug>(lsp-definition)nmap<buffer>gs<plug>(lsp-document-symbol-search)nmap<buffer>gS<plug>(lsp-workspace-symbol-search)nmap<buffer>gr<plug>(lsp-references)nmap<buffer>gi<plug>(lsp-implementation)nmap<buffer>gt<plug>(lsp-type-definition)nmap<buffer><leader>rn<plug>(lsp-rename)nmap<buffer>[g<plug>(lsp-previous-diagnostic)nmap<buffer>]g<plug>(lsp-next-diagnostic)nmap<buffer>K<plug>(lsp-hover)nnoremap<buffer><expr><c-f>lsp#scroll(+4)nnoremap<buffer><expr><c-d>lsp#scroll(-4)letg:lsp_format_sync_timeout=1000autocmd!BufWritePre*.rs,*.gocallexecute('LspDocumentFormatSync')" refer to doc to add more commandsendfunctionaugrouplsp_installau!" call s:on_lsp_buffer_enabled only for languages that has the server registered.autocmdUserlsp_buffer_enabledcalls:on_lsp_buffer_enabled()augroupEND

Refer tovim-lsp-settings on how to easily setup language servers using vim-lsp automatically.

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

Refer to docs on configuring omnifunc orasyncomplete.vim.

vim-lsp does not support snippets by default. If you want snippet integration, you will first have to install a third-party snippet plugin and a plugin that integrates it in vim-lsp.At the moment, you have following options:

1. vim-vsnip together withvim-vsnip-integ
2. UltiSnips together withvim-lsp-ultisnips
3. neosnippet.vim together withvim-lsp-neosnippet

For more information, refer to the readme and documentation of the respective plugins.

You can let the language server automatically handle folding for you. To enable this, you have to set'foldmethod','foldexpr' and (optionally)'foldtext':

setfoldmethod=expr\foldexpr=lsp#ui#vim#folding#foldexpr()\foldtext=lsp#ui#vim#folding#foldtext()

If you would like to disable folding globally, you can add this to your configuration:

letg:lsp_fold_enabled=0

Also see:h vim-lsp-folding.

vim-lsp supports the unofficial extension to the LSP protocol for semantic highlighting (microsoft/vscode-languageserver-node#367).This feature requires Neovim highlights, or Vim with thetextprop feature enabled.You will also need to link language server semantic scopes to Vim highlight groups.Refer to:h vim-lsp-semantic for more info.

Note:

• Some servers may only support partial commands.
• While it is possible to register multiple servers for the same filetype, some commands will pick only the first server that supports it. For example, it doesn't make sense for rename and format commands to be sent to multiple servers.

Document diagnostics (e.g. warnings, errors) are enabled by default, but if youpreferred to turn them off and use other plugins instead (likeNeomake orALE, setg:lsp_diagnostics_enabled to0:

letg:lsp_diagnostics_enabled=0" disable diagnostics support

Highlight references to the symbol under the cursor (enabled by default).You can disable it by adding

letg:lsp_document_highlight_enabled=0

to your configuration.

To change the style of the highlighting, you can set or link thelspReferencehighlight group, e.g.:

highlight lspReference ctermfg=red guifg=red ctermbg=green guibg=green

In order to enable file logging setg:lsp_log_file.

letg:lsp_log_verbose=1letg:lsp_log_file=expand('~/vim-lsp.log')" for asyncomplete.vim logletg:asyncomplete_log_file=expand('~/asyncomplete.log')

You can get detailed status on your servers using:CheckHealth with a plugin on vim:

if!has('nvim') | Plug'rhysd/vim-healthcheck' |endifCheckHealth

vim-themis is used for testing. To runintegration testsgoplsexecutable must be in path.

• Prabir Shrestha (author, maintainer)
• mattn (maintainer)
• hrsh7th (maintainer)
• Thomas Faingnaert (maintainer)
• rhysd (maintainer)

Support us with a monthly donation and help us continue our activities. [Become a backer]

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]