8000 coq_nvim/docs/SNIPS.md at coq · dqminh/coq_nvim · GitHub
[go: up one dir, main page]
Skip to content

/

SNIPS.md

Latest commit

 

History

History
131 lines (79 loc) · 3.48 KB

SNIPS.md

File metadata and controls

131 lines (79 loc) · 3.48 KB
Raw

Snippets

There are two important hotkeys

  • coq_settings.keymap.jump_to_mark: jump to next edit region. (default <c-h>)

  • coq_settings.keymap.eval_snips: evaluate document / visual seleciton as snippets (unbound by default)

Pre-compiled snippets

coq.nvim comes with a ridiculous amount of snippets by default.

To disable: simply do not install coq.artifacts.

Custom snippets

Note: * is a special wildcard filetype.

Workflow

  1. :COQsnips edit -- edits snippet for current filetype

  2. <eval_snips> -- live repl to ensure snippet is what you want

  3. :COQsnips compile -- boom, you are good to do

Compilation

:COQsnips compile

coq.nvim requires you to compile the snippets before they can be loaded. This is to ensure zero snippet errors during runtime.

coq will only accept snippets with valid grammar, and has built-in repl to help you on that.

snip_load.img

Repl

You need to bound coq_settings.keymap.eval_snips to a key first.

ie. let g:coq_settings = { 'keymap.eval_snips': '<leader>j' }

Now entering <leader>j under normal mode will evaluate current document, and under visual mode will evaluate only the visual seleciton.

snip_parse.img

Grammar

User snippets must use the LSP grammar.

The LSP grammar is very similar to various VIM snip dialects, but has a formal specification.

Document format

The document format is extremely simple:

Basically a subset of neosnippet

comment ::= '#' .*
extends ::= 'extends' match (', ' match)*
snippet ::= snipstart ('\n' label)? ('\n' alias)* '\n' snipbody

snipstart ::= 'snippet' match
label     ::= 'abbr' body
alias     ::= 'alias' body
snipbody  ::= indent body ('\n' indent body)*

indent ::= (\s | \t)+
match  ::= [^\s]+
body   :: .*

  1. For <dirname>/<filename>.snip, the snippets' filetype is <filename>

  2. Doesn't matter what indentation is used, as long as it's consistent

  3. The syntax highlighter comes with error highlights

Note: _abbr_ is label only, does not affect suggestions, _alias_ is suggestion only, does not affect label

Example

# a comment

snippet snip
alias s
  snippet ${0:name}
  alias ${1:altname}
    ${2:snippet}

Where to put snippets

Inside all coq-user-snippets/ folders in your runtimepath. AKA first it will lookup where your init.vim is stored, then it will look inside each of your plugins.

$NVIM_HOME
|- ./init.vim
|- ./coq-user-snippets/*.snip

You can also set coq_settings.clients.snippets.user_path to load from a custom location.

There is a convenience command:

" <filetype> can be omitted if current document has a filetype
:COQsnips edit <filetype>

To edit snippets for a particular filetype.

The default path is normally under $NVIM_HOME/coq-user-snippets/, but if coq_settings.clients.snippets.user_path is set, that is used instead.

To see where snippets are currently stored, there is also

:COQsnips cd
:COQsnips ls

et al.

Set coq_settings.clients.snippets.warn to [] to disable warnings.

My personal snippets
0