Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativenull/vim-lspclient
A highly experimental lsp client for vim. Written in vim9script.
https://github.com/creativenull/vim-lspclient
vim vim-plugin vim9 vim9-script
Last synced: 4 months ago
JSON representation
A highly experimental lsp client for vim. Written in vim9script.
- Host: GitHub
- URL: https://github.com/creativenull/vim-lspclient
- Owner: creativenull
- License: mit
- Created: 2022-07-28T21:22:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-01T15:53:36.000Z (over 2 years ago)
- Last Synced: 2024-10-04T15:29:23.342Z (4 months ago)
- Topics: vim, vim-plugin, vim9, vim9-script
- Language: Vim Script
- Homepage:
- Size: 156 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vim9 - creativenull/vim-lspclient
README
# vim-lspclient (WIP)
A highly experimental LSP client for VIM using the builtin [LSP channel mode](https://vimhelp.org/channel.txt.html#language-server-protocol).
Written in `vim9script`.
## Motivation
I just wanted to try out the new `vim9script` language, at the same time, wanted to challenge myself on building something
different/unique besides just building web applications.
At this moment, this plugin is just a toy project for me to play around with LSP and what features I could possibly
implement/contribute to different plugins that already do something similar.
The aim for this LSP client is to be:
+ Portable: use as much of built-in VIM features as possible, write any custom wrappers in case a feature is needed.
+ Efficient: find ways to display important info and make it easy for the users to access this info.
+ Aesthetics: make displaying info as aesthetically pleasing as possible but still out of the way of distractions if needed.
+ Performance: not really a high aim for now, but eventually will get there in small increments.
## What works
Ref: [LSP Specification v3.17](https://microsoft.github.io/language-server-protocol/specifications/specification-current)
+ Server Initialization (`initialize` and `initialized`)
+ Server Shutdown (`shutdown` and `exit`)
+ Dynamic Registration Capability
+ `workspace/didChangeConfiguration`
+ Document updates
+ `textDocument/didOpen`
+ `textDocument/didChange`
+ `textDocument/didClose`
+ `textDocument/willSave`
+ `textDocument/didSave`
+ Language features
+ `textDocument/publishDiagnostics`
+ `textDocument/declaration`
+ `textDocument/definition`
+ `textDocument/typeDefinition`
+ `textDocument/implementation`
+ `textDocument/references`
+ `textDocument/documentHighlight`
+ `textDocument/hover`
+ `textDocument/codeLens` (WIP)
+ `codeLens/resolve` (WIP)
+ Workspace features
+ `workspace/configuration`
+ `workspace/didChangeConfiguration`
+ `workspace/workspaceFolders` (WIP)
+ Window features
+ `window/showMessageRequest` (WIP)
+ `window/showMessage`
+ `window/logMessage`
+ `window/workDoneProgress/create` (WIP)
+ `window/workDoneProgress/cancel` (WIP)
## Installation
### Requirements
The following version and features are required, these can also be checked with `:LSPClientCheckHealth`:
+ [VIM v8.2.4758](https://github.com/vim/vim/tree/v8.2.4758) and up or [VIM 9](https://github.com/vim/vim/tree/v9.0.0000) and up is required.
+ `+channel`
+ `+job`
+ `+timers`
+ `+popupwin`
### Install via plugin manager
```vim
Plug 'creativenull/vim-lspclient'
```
### Install without plugin manager
```
git clone https://github.com/creativenull/vim-lspclient.git ~/.vim/pack/creativenull/start/vim-lspclient
```
## Setup
### Keymaps
```vim
" Example keymaps
nmap lgd (lspclient_definition)
nmap lge (lspclient_declaration)
nmap lgt (lspclient_type_definition)
nmap lgi (lspclient_implementation)
nmap lr (lspclient_references)
nmap lro (lspclient_reference_next)
nmap lri (lspclient_reference_prev)
nmap li (lspclient_document_highlight)
nmap ld (lspclient_diagnostics)
nmap ldo (lspclient_diagnostic_next)
nmap ldi (lspclient_diagnostic_prev)
nmap lw (lspclient_diagnostic_hover)
nmap lh (lspclient_hover)
```
### Enable Debug Logs
Check logs with `:LSPClientLog` or `vim +LSPClientLog` (in terminal)
```vim
let g:lspclient_debug = 1
```
### LSP Servers Setup Examples
#### tsserver (js/ts)
Must have `typescript-language-server` installed globally with `npm i -g typescript-language-server`.
```vim
let s:tsserver = {}
let s:tsserver.name = 'tsserver'
let s:tsserver.cmd = ['typescript-language-server', '--stdio']
let s:tsserver.filetypes = ['typescript', 'typescriptreact', 'javascript', 'javascriptreact']
let s:tsserver.initOptions = { 'hostInfo': 'VIM 9' }
let s:tsserver.markers = ['tsconfig.json', 'jsconfig.json', 'package.json']
call lspclient#Create(s:tsserver)
```
#### volar (vue >= 3)
Must have `vue-language-server` installed globally with `npm i -g @volar/vue-language-server`
```vim
let s:volar = {}
let s:volar.name = 'volar'
let s:volar.cmd = ['vue-language-server', '--stdio']
let s:volar.filetypes = ['vue']
let s:volar.markers = ['package.json', 'vite.config.js', 'vite.config.ts']
" https://github.com/johnsoncodehk/volar/blob/d27d989355adc2aa3f9c6260226bd3167e3fac97/packages/shared/src/types.ts
let s:volar.initOptions = {
\ 'typescript': {
\ 'serverPath': lspclient#fs#GetProjectRoot('node_modules/typescript/lib/tsserverlibrary.js'),
\ },
\ 'documentFeatures': {
\ 'allowedLanguageIds': ['html', 'css', 'vue', 'typescript'],
\ 'selectionRange': v:true,
\ 'foldingRange': v:true,
\ 'linkedEditingRange': v:true,
\ 'documentSymbol': v:true,
\ 'documentColor': v:true,
\ 'documentFormatting': v:true,
\ },
\ 'languageFeatures': {
\ 'references': v:true,
\ 'implementation': v:true,
\ 'definition': v:true,
\ 'typeDefinition': v:true,
\ 'callHierarchy': v:true,
\ 'hover': v:true,
\ 'rename': v:true,
\ 'renameFileRefactoring': v:true,
\ 'signatrueHelp': v:true,
\ 'completion': {
\ 'defaultTagNameCase': 'both',
\ 'defaultAttrNameCase': 'kebabCase',
\ 'getDocumentNameCasesRequest': v:true,
\ 'getDocumentSelectionRequest': v:true,
\ },
\ 'documentHighlight': v:true,
\ 'documentLink': v:true,
\ 'workspaceSymbol': v:true,
\ 'codeLens': v:true,
\ 'semanticTokens': v:true,
\ 'codeAction': v:true,
\ 'inlayHints': v:false,
\ 'diagnostics': v:true,
\ 'schemaRequestService': v:true,
\ },
\ }
call lspclient#Create(s:volar)
```
#### deno (js/ts)
Must have `deno` installed globally.
```vim
let s:denols = {}
let s:denols.name = 'denols'
let s:denols.cmd = ['deno', 'lsp']
let s:denols.filetypes = ['typescript', 'typescriptreact', 'javascript', 'javascriptreact']
let s:denols.settings = { 'enable': v:true, 'unstable': v:true }
let s:denols.markers = ['deno.json', 'deno.jsonc']
call lspclient#Create(s:denols)
```
#### Rust
Must have `rust-analyzer` installed globally.
```vim
let s:rust_analyzer = {}
let s:rust_analyzer.name = 'rust_analyzer'
let s:rust_analyzer.cmd = ['rust-analyzer']
let s:rust_analyzer.filetypes = ['rust']
let s:rust_analyzer.markers = ['Cargo.toml']
call lspclient#Create(s:rust_analyzer)
```
#### Go
Must have `gopls` installed globally.
```vim
let s:gopls = {}
let s:gopls.name = 'gopls'
let s:gopls.cmd = ['gopls']
let s:gopls.filetypes = ['go', 'gomod']
let s:gopls.markers = ['go.mod']
call lspclient#Create(s:gopls)
```