c53bc48033
* Breaking change fix in luasnip `parse_snippet` Co-authored-by: Agustin Romero <agustin.romero@mercadolibre.com>
116 lines
3.7 KiB
Lua
116 lines
3.7 KiB
Lua
local notify = require("neogen.utilities.helpers").notify
|
|
local conf = require("neogen.config").get()
|
|
|
|
---
|
|
--- To use a snippet engine, pass the option into neogen setup:
|
|
--- >
|
|
--- require('neogen').setup({
|
|
--- snippet_engine = "luasnip",
|
|
--- ...
|
|
--- })
|
|
--- <
|
|
--- Some snippet engines come out of the box bundled with neogen:
|
|
--- - `"luasnip"` (https://github.com/L3MON4D3/LuaSnip)
|
|
--- - `"snippy"` (https://github.com/dcampos/nvim-snippy)
|
|
---
|
|
--- If you want to customize the placeholders, you can use `placeholders_text` option:
|
|
--- >
|
|
--- require('neogen').setup({
|
|
--- placeholders_text = {
|
|
--- ['description'] = "[description]",
|
|
--- }
|
|
--- })
|
|
--- <
|
|
---
|
|
--- # Add support for snippet engines~
|
|
---
|
|
--- To add support to a snippet engine, go to `lua/neogen/snippet.lua`.
|
|
--- There's a table called `snippet.engines` that holds functions that will be called
|
|
--- depending of the snippet engine
|
|
---
|
|
--- Those functions have this signature:
|
|
--- `snippet_engine_name = function (snip, pos)` where
|
|
--- - `snip` is a lsp styled snippet (in table format)
|
|
--- - `pos` is a { row , col } table for placing the snippet
|
|
---@tag neogen-snippet-integration
|
|
---@toc_entry Use popular snippet engines
|
|
local snippet = {}
|
|
snippet.engines = {}
|
|
|
|
--- Converts a template to a lsp-compatible snippet
|
|
---@param template string[] the generated annotations to parse
|
|
---@param marks table generated marks for the annotations
|
|
---@param pos table a tuple of row,col
|
|
---@return table resulting snippet lines
|
|
---@private
|
|
snippet.to_snippet = function(template, marks, pos)
|
|
local offset, ph = {}, {}
|
|
for i, m in ipairs(marks) do
|
|
local r, col = m.row - pos[1] + 1, m.col
|
|
ph[i] = (m.text and conf.enable_placeholders) and string.format("${%d:%s}", i, m.text) or "$" .. i
|
|
if offset[r] then
|
|
offset[r] = offset[r] + ph[i - 1]:len() + 1
|
|
else
|
|
offset[r] = 0
|
|
end
|
|
local pre = template[r]:sub(1, col + offset[r])
|
|
template[r] = pre .. ph[i] .. template[r]:sub(col + 1 + offset[r])
|
|
end
|
|
return template
|
|
end
|
|
|
|
--- Expand snippet for luasnip engine
|
|
---@param snip string the snippet to expand
|
|
---@param pos table a tuple of row, col
|
|
---@private
|
|
snippet.engines.luasnip = function(snip, pos)
|
|
local ok, ls = pcall(require, "luasnip")
|
|
if not ok then
|
|
notify("Luasnip not found, aborting...", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
|
|
local types = require("luasnip.util.types")
|
|
|
|
-- Append a new line to create the snippet
|
|
vim.fn.append(pos[1], "")
|
|
|
|
-- Convert the snippet to string
|
|
local _snip = table.concat(snip, "\n")
|
|
|
|
ls.snip_expand(
|
|
|
|
ls.s("", ls.parser.parse_snippet(nil, _snip,{trim_empty = false, dedent = false}), {
|
|
|
|
child_ext_opts = {
|
|
-- for highlighting the placeholders
|
|
[types.insertNode] = {
|
|
-- when outside placeholder, but in snippet
|
|
passive = { hl_group = conf.placeholders_hl },
|
|
},
|
|
},
|
|
-- prevent mixing styles
|
|
merge_child_ext_opts = true,
|
|
}),
|
|
{ pos = pos }
|
|
)
|
|
end
|
|
|
|
--- Expand snippet for snippy engine
|
|
---@param snip string the snippet to expand
|
|
---@param pos table a tuple of row, col
|
|
---@private
|
|
snippet.engines.snippy = function (snip, pos)
|
|
local ok, snippy = pcall(require, "snippy")
|
|
if not ok then
|
|
notify("Snippy not found, aborting...", vim.log.levels.ERROR)
|
|
return
|
|
end
|
|
local row, _ = unpack(pos)
|
|
vim.api.nvim_buf_set_lines(0, row, row, true, {''}) -- snippy will change `row`
|
|
vim.api.nvim_win_set_cursor(0, {row + 1, 0}) -- `snip` already has indent so we should ignore `col`
|
|
snippy.expand_snippet({body = snip})
|
|
end
|
|
|
|
return snippet
|