README: clarify that a snippet plugin is required (#439)

* README: clarify that a snippet plugin is required

* README: add to FAQ about snippet

* README: use snippet 'engine' nomenclature

* README: fix typo
This commit is contained in:
Bradley Mackey
2021-10-30 10:42:37 +01:00
committed by GitHub
parent ab7f368547
commit 437074a303

View File

@@ -74,6 +74,7 @@ lua <<EOF
cmp.setup({
snippet = {
-- REQUIRED - you must specify a snippet engine
expand = function(args)
vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
-- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
@@ -571,6 +572,23 @@ cmp.setup {
}
```
#### I don't use a snippet plugin.
At the moment, nvim-cmp requires a snippet engine to function correctly.
You need to specify one in `snippet`.
```lua
snippet = {
-- REQUIRED - you must specify a snippet engine
expand = function(args)
vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
-- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
-- vim.fn["UltiSnips#Anon"](args.body) -- For `ultisnips` users.
-- require'snippy'.expand_snippet(args.body) -- For `snippy` users.
end,
}
```
#### I dislike auto-completion