1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# Snippets <Badge type="info"><a href="./reference#snippets">Go to default configuration</a></Badge>
Blink uses the `vim.snippet` API by default for expanding and navigating snippets. The built-in `snippets` source will load [friendly-snippets](https://github.com/rafamadriz/friendly-snippets), if available, and load any snippets found at `~/.config/nvim/snippets/`. For use with Luasnip, see the [Luasnip section](#luasnip).
## Custom snippets
By default, the `snippets` source will check `~/.config/nvim/snippets` for your custom snippets, but you may add additional folders via `sources.providers.snippets.opts.search_paths`. Currently, only VSCode style snippets are supported, but you may look into [Luasnip](https://github.com/L3MON4D3/LuaSnip) if you'd like more advanced functionality.
[Chris Grieser](https://github.com/chrisgrieser) has made a great introduction to writing custom snippets [in the nvim-scissors repo](https://github.com/chrisgrieser/nvim-scissors?tab=readme-ov-file#cookbook--faq). Here's an example, using the linux/mac path for the neovim configuration:
```jsonc
// ~/.config/nvim/snippets/package.json
{
"name": "personal-snippets",
"contributes": {
"snippets": [
{ "language": "lua", "path": "./lua.json" }
]
}
}
```
```jsonc
// ~/.config/nvim/snippets/lua.json
{
"foo": {
"prefix": "foo",
"body": [
"local ${1:foo} = ${2:bar}",
"return ${3:baz}"
],
}
}
```
## Luasnip
```lua
{
'saghen/blink.cmp',
version = '*',
-- !Important! Make sure you're using the latest release of LuaSnip
-- `main` does not work at the moment
dependencies = { 'L3MON4D3/LuaSnip', version = 'v2.*' },
opts = {
snippets = { preset = 'luasnip' },
-- ensure you have the `snippets` source (enabled by default)
sources = {
default = { 'lsp', 'path', 'snippets', 'buffer' },
},
}
}
```
## `mini.snippets`
```lua
{
'saghen/blink.cmp',
dependencies = 'echasnovski/mini.snippets',
opts = {
snippets = { preset = 'mini_snippets' },
-- ensure you have the `snippets` source (enabled by default)
sources = {
default = { 'lsp', 'path', 'snippets', 'buffer' },
},
}
}
```
## Disable all snippets
```lua
sources.transform_items = function(_, items)
return vim.tbl_filter(function(item)
return item.kind ~= require('blink.cmp.types').CompletionItemKind.Snippet
end, items)
end
```
When setting up your capabilities with `lspconfig`, add the following:
```lua
capabilities = require('blink.cmp').get_lsp_capabilities({
textDocument = { completion = { completionItem = { snippetSupport = false } } },
})
```
Some LSPs may ignore the `snippetSupport` field, in which case, you need to set LSP specific options while setting them up. Some examples:
```lua
-- If you're using `opts = { ['rust-analyzer'] = { } }` in your lspconfig configuration, simply put these options in there instead
-- For `rust-analyzer`
lspconfig['rust-analyzer'].setup({
completion = {
capable = {
snippets = 'add_parenthesis'
}
}
})
-- For `lua_ls`
lspconfig.lua_ls.setup({
settings = {
Lua = {
completion = {
callSnippet = 'Disable',
keywordSnippet = 'Disable',
}
}
}
})
```
Please open a PR if you know of any other LSPs that require special configuration!
|
