Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamcco/vim-language-server
VImScript language server, LSP for vim script
https://github.com/iamcco/vim-language-server
autocomplete lsp neovim vim viml vimscript
Last synced: 4 months ago
JSON representation
VImScript language server, LSP for vim script
- Host: GitHub
- URL: https://github.com/iamcco/vim-language-server
- Owner: iamcco
- Created: 2019-04-20T15:57:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T06:55:04.000Z (12 months ago)
- Last Synced: 2024-01-09T13:34:10.179Z (5 months ago)
- Topics: autocomplete, lsp, neovim, vim, viml, vimscript
- Language: JavaScript
- Homepage:
- Size: 930 KB
- Stars: 472
- Watchers: 10
- Forks: 16
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Lists
- awesome-stars - vim-language-server
- awesome-stars - iamcco/vim-language-server - VImScript language server, LSP for vim script (JavaScript)
- awesome-stars - iamcco/vim-language-server - VImScript language server, LSP for vim script (JavaScript)
- awesome-lsp-servers - Vimscript
- awesome-stars - iamcco/vim-language-server - VImScript language server, LSP for vim script (JavaScript)
README
# VimScript Language Server
[](https://github.com/iamcco/vim-language-server/actions?query=workflow%3ACI)
[](https://www.npmjs.com/package/vim-language-server)
> language server for VimScript
**Features:**
- auto completion
- function signature help
- hover document
- go to definition
- go to references
- document symbols
- document highlight
- folding range
- select range
- rename
- snippets
- diagnostic
## Install
**For yarn**
```sh
yarn global add vim-language-server
```
**For npm**
```sh
npm install -g vim-language-server
```
**For coc.nvim user** install coc extension:
```vim
:CocInstall coc-vimlsp
```
**For vim-easycomplete user** install lsp server via `:InstallLspServer vim` and config nothing:
```vim
:InstallLspServer vim
```
## Config
for document highlight
```vim
let g:markdown_fenced_languages = [
\ 'vim',
\ 'help'
\]
```
lsp client config example with coc.nvim
- Using node ipc
```jsonc
"languageserver": {
"vimls": {
"module": "/path/to/vim-language-server/bin/index.js",
"args": ["--node-ipc"],
"initializationOptions": {
"isNeovim": true, // is neovim, default false
"iskeyword": "@,48-57,_,192-255,-#", // vim iskeyword option
"vimruntime": "", // $VIMRUNTIME option
"runtimepath": "", // vim runtime path separate by `,`
"diagnostic": {
"enable": true
},
"indexes": {
"runtimepath": true, // if index runtimepath's vim files this will effect the suggest
"gap": 100, // index time gap between next file
"count": 3, // count of files index at the same time
"projectRootPatterns" : ["strange-root-pattern", ".git", "autoload", "plugin"] // Names of files used as the mark of project root. If empty, the default value [".git", "autoload", "plugin"] will be used
},
"suggest": {
"fromVimruntime": true, // completionItems from vimruntime's vim files
"fromRuntimepath": false // completionItems from runtimepath's vim files, if this is true that fromVimruntime is true
}
},
"filetypes": [ "vim" ],
}
}
```
- Using stdio
```jsonc
"languageserver": {
"vimls": {
"command": "vim-language-server",
"args": ["--stdio"],
"initializationOptions": {
"isNeovim": true, // is neovim, default false
"iskeyword": "@,48-57,_,192-255,-#", // vim iskeyword option
"vimruntime": "", // $VIMRUNTIME option
"runtimepath": "", // vim runtime path separate by `,`
"diagnostic": {
"enable": true
},
"indexes": {
"runtimepath": true, // if index runtimepath's vim files this will effect the suggest
"gap": 100, // index time gap between next file
"count": 3, // count of files index at the same time
"projectRootPatterns" : ["strange-root-pattern", ".git", "autoload", "plugin"] // Names of files used as the mark of project root. If empty, the default value [".git", "autoload", "plugin"] will be used
},
"suggest": {
"fromVimruntime": true, // completionItems from vimruntime's vim files
"fromRuntimepath": false // completionItems from runtimepath's vim files, if this is true that fromVimruntime is true
}
},
"filetypes": [ "vim" ]
}
}
```
**Note**:
- if you set `isNeovim: true`, command like `fixdel` in vimrc which neovim does not support will report error.
- if you want to speed up index, change `gap` to smaller and `count` to greater, this will cause high CPU usage for some time
- if you don't want to index vim's runtimepath files, set `runtimepath` to `false` and you will not get any suggest from those files.
## Usage
> The screen record is using coc.nvim as LSP client.
**Auto complete and function signature help**:
**Hover document**:
**Go to definition and references**:
**Document symbols**:
**Document highlight**:
**Folding range and selection range**:
**Rename**:
**Snippets and diagnostic**:
## References
- [vim-vimlparser](https://github.com/vim-jp/vim-vimlparser)
- [neco-vim](https://github.com/Shougo/neco-vim)
## Similar project
- [vimscript-language-server](https://github.com/google/vimscript-language-server)
### Buy Me A Coffee ☕️
