VSCode(LSP)'s snippet feature in vim/nvim.
- Nested placeholders
- You can define snippet like
console.log($1${2:, $1})$0
- You can define snippet like
- Nested snippet expansion
- You can expand snippet even if you already activated other snippet (it will be merged as one snippet)
- Load snippet from VSCode extension
- If you install VSCode extension via
Plug 'golang/vscode-go'
, vsnip will load those snippets.
- If you install VSCode extension via
- Support many LSP-client & completion-engine by vim-vsnip-integ
- LSP-client
- completion-engine
- Vim script interpolation
- You can use Vim script interpolation as
${VIM:...Vim script expression...}
.
- You can use Vim script interpolation as
- SnipMate-like syntax support
- Snippet files in SnipMate format with the extension
.snippets
can be load. - NOTE: Full compatibility is not guaranteed. It is intended to easily create user-defined snippets.
- Snippet files in SnipMate format with the extension
- Pure Vim script
- Well tested (neovim/0.4.4, vim/8.0.1567)
- Support VSCode snippet format
- Provide integration with many plugins
friendly-snippets - Set of preconfigured snippets for all kind of programming languages that integrates really well with vim-vsnip, so all users can benefit from them and not to worry about setting up snippets on their own.
You can use your favorite plugin managers to install this plugin.
Plug 'hrsh7th/vim-vsnip'
Plug 'hrsh7th/vim-vsnip-integ'
call dein#add('hrsh7th/vim-vsnip')
call dein#add('hrsh7th/vim-vsnip-integ')
NeoBundle 'hrsh7th/vim-vsnip'
NeoBundle 'hrsh7th/vim-vsnip-integ'
" NOTE: You can use other key to expand snippet.
" Expand
imap <expr> <C-j> vsnip#expandable() ? '<Plug>(vsnip-expand)' : '<C-j>'
smap <expr> <C-j> vsnip#expandable() ? '<Plug>(vsnip-expand)' : '<C-j>'
" Expand or jump
imap <expr> <C-l> vsnip#available(1) ? '<Plug>(vsnip-expand-or-jump)' : '<C-l>'
smap <expr> <C-l> vsnip#available(1) ? '<Plug>(vsnip-expand-or-jump)' : '<C-l>'
" Jump forward or backward
imap <expr> <Tab> vsnip#jumpable(1) ? '<Plug>(vsnip-jump-next)' : '<Tab>'
smap <expr> <Tab> vsnip#jumpable(1) ? '<Plug>(vsnip-jump-next)' : '<Tab>'
imap <expr> <S-Tab> vsnip#jumpable(-1) ? '<Plug>(vsnip-jump-prev)' : '<S-Tab>'
smap <expr> <S-Tab> vsnip#jumpable(-1) ? '<Plug>(vsnip-jump-prev)' : '<S-Tab>'
" Select or cut text to use as $TM_SELECTED_TEXT in the next snippet.
" See https://github.com/hrsh7th/vim-vsnip/pull/50
nmap s <Plug>(vsnip-select-text)
xmap s <Plug>(vsnip-select-text)
nmap S <Plug>(vsnip-cut-text)
xmap S <Plug>(vsnip-cut-text)
" If you want to use snippet for multiple filetypes, you can `g:vsnip_filetypes` for it.
let g:vsnip_filetypes = {}
let g:vsnip_filetypes.javascriptreact = ['javascript']
let g:vsnip_filetypes.typescriptreact = ['typescript']
Snippet file will store to g:vsnip_snippet_dir
per filetype.
- Open some file (example:
Sample.js
) - Invoke
:VsnipOpen
command. - Edit snippet.
{
"Class": {
"prefix": ["class"],
"body": [
"/**",
" * @author ${VIM:\\$USER}",
" */",
"class $1 ${2:extends ${3:Parent} }{",
"\tconstructor() {",
"\t\t$0",
"\t}",
"}"
],
"description": "Class definition template."
}
}
The snippet format was described in here or here.
You can insert the filename via fname\<Plug>(vsnip-expand)
.
{
"filename": {
"prefix": ["fname"],
"body": "$TM_FILENAME_BASE"
}
}
You can fill $TM_SELECTED_TEXT
by <Plug>(vsnip-select-text)
or <Plug>(vsnip-cut-text)
.
{
"log": {
"prefix": ["log"],
"body": "console.log(${1:$TM_SELECTED_TEXT});"
}
}
You can insert value by Vim script expression.
{
"user": {
"prefix": "username",
"body": "${VIM:\\$USER}"
}
}
You can insert UUID via python.
{
"uuid": {
"prefix": "uuid",
"body": [
"${VIM:system('python -c \"import uuid, sys;sys.stdout.write(str(uuid.uuid4()))\"')}"
]
}
}
NOTE: $VIM
is only in vsnip. So that makes to lost the snippet portability.
You can run npm run test
after install vim-themis.
- compute the
user-diff
...s:Session.flush_changes
- reflect the
user-diff
to snippet ast ...s:Snippet.follow
- reflect the
sync-diff
to buffer content ...s:Snippet.sync & s:Session.flush_changes