coc-snippets
v3.4.7
Snippets extension for coc.nvim
0/weekUpdated 9 months agoMITUnpacked: 317.9 KB
Published by chemzqm@gmail.com
npm install coc-snippetscoc-snippets
Snippets solution for coc.nvim
_Snippet preview requires neovim 0.4 or latest vim8_
It's capable of:
- Load UltiSnips snippets.
- Load snipmate snippets.
- Load VSCode snippets from coc.nvim extensions.
- Load VSCode snippets from custom directories.
- Load VSCode snippets from ${workspaceFolder}/.vscode.
- Load UltiSnips snippets from configured folder.
- Load massCode snippets from running massCode application (disabled by default).
- Create massCode snippets through the snippets.editMassCodeSnippets command.
- Provide snippets as completion items.
- Provide expand and expandOrJump keymaps for snippet.
- Provide snippets list for edit snippet.
- Provide snippets.editSnippets command for edit user snippets of current filetype.
Note: some features of ultisnips and snipmate format snippets not supported,
checkout Ultisnips features.
Why?
- Use same keys for jump placeholder.
- Nested snippet support.
- Always async, never slows you down.
- Preview snippet context in float window/popup.
- Improved match for complete items with TextEdit support.
- Edit snippets of current buffer by :CocList snippets.
Python support
Ultisnips provider needs pythonx support on (neo)vim, to check the feature exists,
try:
``vim`
:echo has('pythonx')
On neovim, run command:
`vim`
:checkhealth
If it is not installed, run:shell`
pip install pynvim
and make sure you have Python 3 provider for neovim installed.
On vim8, run command:
`vim`
:pyx print(1)
in your vim, if it throws, it means your vim is not compiled with python support
or the python dynamic lib required by vim is missing(or broken).
Note: some python code may require python feature that not supported by the
python interpreter used by vim, error will throw on that case.
~Error will be shown when pythonx with (neo)vim can't work, fix pythonx
support or disable ultisnips support by add
in your configuration file.~
Install
In your vim/neovim, run command:
`
:CocInstall coc-snippets
Examples
`vim
" Use
imap
" Use
vmap
" Use
let g:coc_snippet_next = '
" Use
let g:coc_snippet_prev = '
" Use
imap
" Use
xmap
`
Make used for trigger completion, completion confirm, snippet expand and jump like VSCode.
Note from coc.nvim 0.0.82, functions starts with coc#pum should be used for
custom completion of coc.nvim.
`vim
inoremap
\ coc#pum#visible() ? coc#_select_confirm() :
\ coc#expandableOrJumpable() ? "\
\ CheckBackspace() ? "\
\ coc#refresh()
function! CheckBackspace() abort
let col = col('.') - 1
return !col || getline('.')[col - 1] =~# '\s'
endfunction
let g:coc_snippet_next = '
`
Ultisnips features
Some ultisnips features are not supported:
- [x] Position check of trigger option, including b, w and i.extends
- [x] Execute vim, python and shell code in snippet.
- [x] , priority and clearsnippets command in snippet file.m
- [x] Visual placeholder.
- [x] Placeholder and variable transform.
- [x] Expression snippet.
- [x] Automatic trigger snippet.
- [x] Context snippets.
- [x] Support loading snipmate snippets.
- [x] Replacement String, (:h UltiSnips-replacement-string), requires latest coc.nvim.
- [x] Update python code block after change of placeholder.
- [ ] Execute shell code with custom shabang (will not support).
- [x] Option , trim all whitespaces from right side of snippet lines.t
- [x] Reformat snippet options, including , s.pre_expand
- [x] All snippet actions including , post_expand and jump (can't support).snip.expand_anon()
- [x] and other properties with UltiSnips actions.
Note: snip.expand_anon expand the snippet in async manner by use timerpre_expand
when used with and post_expand action, which means the state is
lost in your python script (should only happens on some rare cases).
Note: python regex in snippet are converted to javascript regex, however,
some regex patterns can't be supported by javascript, including
(?x) (?s) \Z (?(id/name)yes-pattern|no-pattern).
Functions
- coc#expandable() return 1 when can do snippet expand.coc#jumpable()
- return 1 when snippet activated and can jump to next placeholder.coc#expandableOrJumpable()
- return 1 when can do snippet expand or can jump
to next placeholder.
Key-mappings
Note you can't use noremap with key-mappings.
- Create new snippet with current selected text,
visual mode only.
- Expand snippet with current inserted text,
insert mode only.
- None block variant of.
- Expand snippet or jump to next placeholder
of current snippet when possible, insert mode only.
- None block variant of.
- Remove selected text and save tog:coc_selected_text
which will replace $VISUAL on next snippet expand.
Commands
- Use :CocList snippets to open snippets list used by current buffer, the last:CocCommand snippets.openSnippetFiles
used snippet item would be preselected.
- Use to choose and open a snippet file:CocCommand snippets.editSnippets
that used by current document.
- Use to edit user's ultisnips snippets of:CocCommand snippets.openOutput
current document filetype.
- Use to open output channel of snippets.:CocCommand snippets.addFiletypes
- Use to add additional filetypes of current
buffer.
Use b:coc_snippets_filetypes to add additional filetypes on buffer create.
Options
- snippets.priority: Completion source priority of snippets. Default: 90
- : Open command used for snippets.editSnippets command, use coc.preferences.jumpCommand by default. Default: ""
- : Trace level of snippets channel, used for textmate snippets only. Default: "error"
Valid options: ["error","verbose"]
- : List of minimatch patterns for filepath to exclude, support expand homedir and environment variables. Default: []
- : Enable load snippets from extensions. Default: true
- : List of directories that contains textmate/VSCode snippets to load. Default: []
- : Load code snippets in folder ${workspaceFolder}/.vscode Default: true
- : Configure filetypes to inherit with, ex: {"cpp": ["c"], "javascriptreact": ["javascript"]} Default: {}
- : Directory that contains custom user ultisnips snippets, use ultisnips in extension root of coc.nvim by default. Default: ""
- : Shortcut in completion menu. Default: "S"
- : Trigger characters for trigger snippets completion. Default: []
- : Disable snippets completion when syntax name matches one of disabled syntaxes. Default: []
- : Execute a snippet's context (if it exists) to check if the snippet should be shown in completion menu Default: false
- : Enable trigger auto trigger snippet after type character. Default: true
- : Enable load snippets from ultisnips folders. Default: true
- : Show prompt for user when python not supported on vim. Default: true
- : Trace verbose snippet information. Default: false
- : Directories that searched for ultisnips snippet files, could be directory as subfolder in $runtimepath or absolute paths. Default: ["UltiSnips"]
- : Enable load snippets from MassCode. Default: false
- : Http host of MassCode. Default: "localhost"
- : Http port of MassCode. Default: 3033
- : Trace verbose snippet information. Default: false
- : Load snipmate snippets from snippets directory in runtimepath. Default: true
- : Trace verbose snippet information. Default: false
- : Author name used for g:snips_author Default: ""F.A.Q
Q: How to add snippet filetypes on buffer create?
A: Use autocmd like: autocmd BufRead *.md let b:coc_snippets_filetypes = ['tex']
Q: How to trigger snippets completion when type special characters?
A: Use configuration like: "snippets.triggerCharacters": ["'"].
Q: How to check if a snippet successfully loaded?
A: Use command :CocCommand workspace.showOutput snippets
Q: Some ultisnips snippet not works as expected.
A: Reformat after change of placeholder feature can't be supported for now,
and some regex pattern can't be converted to javascript regex pattern, so the
snippet can be failed to load.
Q: Where to get snippets?
A: One solution is install honza/vim-snippets which is widely used.
To create snippets yourself:
- For Ultisnips, create ${filetype}.snippets in "snippets.ultisnips.directories"
- For snipmate snippets, create in snippets folderruntimepath
under your vim's .${filetype}.json
- For VSCode snippets, create in your "snippets.textmateSnippetsRoots".
Q: Get error message ModuleNotFoundError: No module named 'vimsnippets'
A: Make sure honza/vim-snippets in
your vim's &runtimepath.
Q: Do I need to install Ultisnips.
A: No! This extension is designed to work with or without Ultisnips, you can
still install Ultisnips, but this extension would not run any code or read
configuration from it.
Q: How to check jumpable or expandable at current position.
A: Use functions provided by coc.nvim: coc#expandable() coc#jumpable() and coc#expandableOrJumpable().
Q: How could I add custom UltiSnips snippets.
A: You can create snippet files in folder: $VIMCONFIG/coc/ultisnips, use:CocCommand snippets.editSnippets` to open user snippet of current
command
filetype.
Supporting
If you like this extension, consider supporting me on Patreon or PayPal:
License
MIT