Beta-testing 'mini.snippets'

[echasnovski]

Please leave your feedback about new mini.snippets module here. Feel free to either add new comment or positively upvote existing one.

Some things I am interested to find out (obviously, besides bugs):

• Does it work well out of the box with recommended "Quickstart" setup?
• Is configuration intuitive enough?
• Are default values of settings convenient for you?
• Is documentation and examples clear enough?

Thanks!

[231tr0n]

Yay!! Christmas present from the mini.nvim santa has dropped. As usual awesome work @echasnovski. I had few doubts

1. Are snippets populated in mini.completion? Because, I just tried it in a go file and snippets are not showing up.
2. Is running the below snippet enough to load snippets from the above plugin. Because, when I try to expand it using C-j, it prints out this error message.
   

	add("rafamadriz/friendly-snippets")
	require("mini.snippets").setup()

[echasnovski]

1. Are snippets populated in mini.completion? Because, I just tried it in a go file and snippets are not showing up.

No, not yet. I hope this to get resolved next (#886).

2. Is running the below snippet enough to load snippets from the above plugin

No, 'mini.snippets' by default doesn't load any snippets. This has to be done explicitly by the user (similar to 'mini.hipatterns'). The setup from Quickstart should work.

[231tr0n]

I more doubt, so I have snippet support enabled with gopls the language server for golang, Are there any mappings which this module provides to navigate between these ${1:} and ${n:}, etc.

	fmt.Println(${1:})

[echasnovski]

I more doubt, so I have snippet support enabled with gopls the language server for golang, Are there any mappings which this module provides to navigate between these ${1:} and ${n:}, etc.

Yes, <C-l> and <C-h>. Please, see this part of Overview.

[231tr0n]

One last ask, is it possible to provide an example on how to configure mini.snippets with rafamadriz/friendly-snippets in the docs.

[echasnovski]

One last ask, is it possible to provide an example on how to configure mini.snippets with rafamadriz/friendly-snippets in the docs.

There is. Quickstart.

[231tr0n]

One last ask, is it possible to provide an example on how to configure mini.snippets with rafamadriz/friendly-snippets in the docs.

There is. Quickstart.

So, basically gen_loader.from_lang() does the job of loading the snippets right?

[echasnovski]

One last ask, is it possible to provide an example on how to configure mini.snippets with rafamadriz/friendly-snippets in the docs.

There is. Quickstart.

So, basically gen_loader.from_lang() does the job of loading the snippets right?

Correct. The way it works is designed after 'rafamadriz/friendly-snippets'. Plus it is a reasonable way to organize per language snippets anyway.

[231tr0n]

Ok! I got it working but, C-h and C-l do not work or navigate for lsp completed snippets

[echasnovski]

Ok! I got it working but, C-h and C-l do not work or navigate for lsp completed snippets

Yes, they do not. Because #886 is still not resolved.

Edit: 'mini.snippets' is expected to be used with manual expansion (<C-j> by default): then it starts snippet session and <C-l> and <C-h> work. This makes it more self contained and not depend on (auto)completion framework, which I personally prefer.

During work on #886 I plan to provide a way to define 'mini.snippets' as default snippet expand/insert for snippets from LSP completions and have a way for 'mini.snippets' to provide its suggestions for 'mini.completion' (as a dummy LSP server). These are distinct features which come from the fact that 'mini.snippets' is both snippet manager (find/match snippet) and expand provider (start snippet session, jump between tabstops, etc.).

[231tr0n]

Ok! I got it working but, C-h and C-l do not work or navigate for lsp completed snippets

Yes, they do not. Because #886 is still not resolved.

Ohh ok my bad, did not think these two were dependent for working. Overall, the module looks great. I just tried writing basic boiler plate code and I write it bonkers fast now. Thank you once again @echasnovski .

[xzbdmw]

I find "c-n" does not work given the config, it delete all the chars before cursor pos, after I expand and then use "right" to move one char, "c-n" works.

local root = vim.fn.fnamemodify("./.repro", ":p")
-- set stdpaths to use .repro
for _, name in ipairs({ "config", "data", "state", "cache" }) do
    vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
end
-- bootstrap lazy
local lazypath = root .. "/plugins/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
    vim.fn.system({
        "git",
        "clone",
        "--filter=blob:none",
        "--single-branch",
        "https://github.com/folke/lazy.nvim.git",
        lazypath,
    })
end
vim.opt.runtimepath:prepend(lazypath)
-- install plugins
local plugins = {
    "folke/tokyonight.nvim",
    -- do not remove the colorscheme!
    {
        "echasnovski/mini.snippets",
        version = false,
        config = function()
            local gen_loader = require("mini.snippets").gen_loader
            require("mini.snippets").setup({
                snippets = {
                    -- Load custom file with global snippets first (adjust for Windows)
                    gen_loader.from_file("~/.config/nvim/snippets/global.json"),

                    -- Load snippets based on current language by reading files from
                    -- "snippets/" subdirectories from 'runtimepath' directories.
                    gen_loader.from_lang(),
                },
                -- Module mappings. Use `''` (empty string) to disable one.
                mappings = {
                    -- Expand snippet at cursor position. Created globally in Insert mode.
                    expand = "<C-7>",

                    -- Interact with default `expand.insert` session.
                    -- Created for the duration of active session(s)
                    jump_next = "<C-n>",
                    jump_prev = "<C-p>",
                    stop = "<C-c>",
                },

                -- Functions describing snippet expansion. If `nil`, default values
                -- are `MiniSnippets.default_<field>()`.
                expand = {
                    -- Resolve raw config snippets at context
                    prepare = nil,
                    -- Match resolved snippets at cursor position
                    match = nil,
                    -- Possibly choose among matched snippets
                    select = nil,
                    -- Insert selected snippet
                    insert = nil,
                },
            })
        end,
    },

    -- add any other pugins here
}

require("lazy").setup(plugins, {
    root = root .. "/plugins",
})
vim.cmd([[colorscheme tokyonight]])

global.json

{
	"Basic": {
		"prefix": "ba",
		"body": "T1=$1 T2=$2 T0=$0"
	},
}

iShot_2024-12-24_00.00.29.mp4

[echasnovski]

I find "c-n" does not work given the config, it delete all the chars before cursor pos, after I expand and then use "right" to move one char, "c-n" works.

Yeah, unfortunately, <C-n> and <C-p> are somewhat special because they are forced by built-in Insert completion. My suggestion would be to not use those keys, as 'mini.snippets' has to deal with built-in completion for tabstops with choices. I've spent too much time overcoming its quirks when it comes to handling some common cases when used with 'mini.completion' (there is a separate test set).

I'll take a closer look to try and tackle this case, but I have a feeling that this will just be a documented known limitation. Thanks for the feedback!