Structure snippets in multiple files

[Felipe-9]

Previously i had a very (3000 lines long) snippets file for tex files and i wanted to organize so that it would be easier to manage and expand.

here is an example of a tree:

/Users/felipepinto/.config/nvim/lua
├── plugins
├── profiles
└── snippets
    ├── init.lua
    └── latex
        ├── G
        │   ├── G1.lua
        │   ├── G2.lua
        │   ├── G3.lua
        └── init.lua

every subfile would return a luatable of snippets, eg:

local ls = require("luasnip")
local s = ls.snippet     -- build snippets
local fmt = require("luasnip.extras.fmt").fmta -- formatting with [[]] and delimiters=<>
return {
  s({desc="desc",trig="trig"},fmt([[...]],{...})),
  ...
}

how to group everything and load without overwritting existing snippets?
if possible it would be ideal for snippets/init.lua to load snippets/latex/init.lua from which it load all the latex snippets.

im not sure if im doing it wright so far...

luasnip.lua has:

...
require("snippets.init")
...

snippets/init.lua is simply:

require('snippets.latex.init')

and snippets/latex/init.lua is:

local ls = require("luasnip")
local G = {
  require("snippets.latex.G.G1"),
  require("snippets.latex.G.G2"),
  require("snippets.latex.G.G3"),
}
ls.add_snippets("tex",G)

i dont get errors but my snippets also dont load

[iMagUdspEllr]

I'm having the same issue. I also can't figure out how to split snippets into multiple files. I was able to write functions that return snippets in separate files and then import them in other files. Unfortunately, the add_snippets function call overwrites other add_snippets function calls. So, only one instance of add_snippets seems to be kept for each file type. But, I think I either don't fully understand LuaSnip or Lua to know how to proceed.

[Felipe-9]

At some point i tried the exact same thing, each file would call ls.add_snippets("tex",...), no errors would appear, except, my snippets would be missing (the overriding thing appears). That is actually the reason as why there is a single snippets/latex/init.lua file, its the only one to call ls.add_snippets("tex",...) for tex files.

I still couldnt figure out how to add the snippets imported from the other files...i think it might be interpretting it wrong cause the snippets are inside their own object {...} and maybe we need to flatten it, but i dont know how to do this

[iMagUdspEllr]

I think what you're doing could be almost there. But, your code (in my eyes) means that you're defining a table G that is importing tables. The add_snippets function is meant to accept a table of snippets, not a table of tables of snippets. But, I tried to export only a single snippet and access just the snippet and that didn't work either.

I'm not sure why an imported snippet doesn't work.

[L3MON4D3]

Have you tried using the lua-loade? Check the doc, the files can be structure almost exactly as you desire and it hast some nice propertiesike hot reload and jumping to snippet-definition

[Felipe-9]

path on luasnip.lua

...
require("luasnip.loaders.from_lua").load({paths="~/.config/nvim/lua/snippets"})
...

set_loglevel

its a boomer but thats all i see really

on nesting directories

i was doing that just so that i would have control (tex.lua file to declare which files to include) i tough it would be the same as having the loader decide on the files...

if you are willing to make that configurable, i guess it could be a solution, but im not fully sure if its the problem, you see, i tried to compile all my files into a single (4000 lines) file (tex.lua) and imported my snippets both using ls.add_snippets("tex",...) and the loader, and at the start i saw some errors (on files like g10.lua) from snippets i made mistakes that after fixing my latex files would open without errors, but my snippets would still be missing... at this point i think there might be another problem that isnt communicating right between luasnip and completions or something of the sort

having errors on files tells me that lua compiled the snippet files, but still havent been able to add to snippets

[L3MON4D3]

Oh no, I think you're misunderstanding: ls.log.set_loglevel("info") has to be called in your luasnip-config, before the call to load is made (so that luasnip logs all the info-messages from the lua-loader).
You can then, after loading, in the interactive session, call ls.log.open() to view the log :)

[Felipe-9]

oh i see, in the config should that line be placed in a specific place? like at the very start or after calling ls.setup({...})? :)

like this?

return {
  "L3MON4D3/LuaSnip",
  -- follow latest release.
  -- version = "v2.*", -- Replace <CurrentMajor> by the latest released major (first number of latest release)
  -- install jsregexp (optional!).
  build = "make install_jsregexp",
  event = "InsertEnter",
  dependencies = {
    "saadparwaiz1/cmp_luasnip", -- for autocompletion
    "rafamadriz/friendly-snippets", -- useful snippets
  },
  config = function()
    local ls = require("luasnip")

    ls.log.set_loglevel('info')

    ls.setup({
      snip_env = {
        s = function (...)
          local snip = ls.s(...)
          table.insert(getfenv(2).ls_file_snippets, snip)
        end,
        parse = function (...)
          local snip = ls.parser.parse_snippet(...)
          table.insert(getfenv(2).ls_file_snippets, snip)
        end
      }
    })


    -- loads vscode style snippets from installed plugins (e.g. friendly-snippets)
    require("luasnip.loaders.from_vscode").lazy_load()
    require("luasnip.loaders.from_lua").load({path="~/.config/nvim/lua/snippets"})
    -- require("snippets.tex")

    vim.keymap.set({ "i" }, "<C-K>", function()
      ls.expand()
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-k>", function()
      if ls.expand_or_jumpable() then
        ls.expand_or_jump()
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-j>", function()
      if ls.jumpable(-1) then
        ls.jump(-1)
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-E>", function()
      if ls.choice_active() then
        ls.change_choice(1)
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-n>", function()
      if ls.choice_active() then
        ls.change_choice(1)
      end
    end)
  end,
}

[Felipe-9]

update

i tried putting it everywhere, dont see any difference when calling ls.log.open()

Also i noticed how my snippets were giving an error when they had multiple triggers, i noticed the issue #1061 and is ms the only easy way to add multiple triggers to snippets? is there any issue with efficiency if i refactor all my snippets to ms?

[L3MON4D3]

That sounds correct.. very weird, could you manually check whether the file at vim.fn.stdpath("log")/luasnip.log contains anything?

ms is pretty cool, prefer it if you want to give one snippet multiple triggers :) (it does not duplicate as much data)

[Felipe-9]

Hello! its been some time, i finnally found a solution for this.

the solutions i found whent on the path of adding sinppets using ls.add_snippets('tex',{...}) method.

The reason it wasnt working before is because we were inserting a table of tables instead of having a single table of snippets which was expected by the function.

so with the following loop we can join together tables and insert then into luasnip:

local snippet_tables = {
  require('snippets.latex.mysnipfile'),
  ...
}

local snippets = {}
for _,sniptable in ipairs(snippet_tables) do
  for _,snip in ipairs(sniptable) do
    table.insert(snippets,snip)
  end
end

ls.add_snippets('tex',snippets)

luasnip.lua

return {
  "L3MON4D3/LuaSnip",
  build = "make install_jsregexp",
  event = "InsertEnter",
  dependencies = {
    "saadparwaiz1/cmp_luasnip", -- for autocompletion
    "rafamadriz/friendly-snippets", -- useful snippets
  },
  config = function()
    local ls = require("luasnip")

    ls.log.set_loglevel("info")

    -- loads vscode style snippets from installed plugins (e.g. friendly-snippets)
    require("luasnip.loaders.from_vscode").lazy_load()
    require("snippets.init")

    vim.keymap.set({ "i" }, "<C-K>", function()
      ls.expand()
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-k>", function()
      if ls.expand_or_jumpable() then
        ls.expand_or_jump()
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-j>", function()
      if ls.jumpable(-1) then
        ls.jump(-1)
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-E>", function()
      if ls.choice_active() then
        ls.change_choice(1)
      end
    end, { silent = true })
    vim.keymap.set({ "i", "s" }, "<C-n>", function()
      if ls.choice_active() then
        ls.change_choice(1)
      end
    end)
  end,
}

snippets.init

require("snippets.latex.init")

snippets.latex.init

local ls = require'luasnip'

local snippet_tables = {
  require("snippets.latex.constants"),
  require("snippets.latex.math"),
  require("snippets.latex.mysnippets"),
  require("snippets.latex.tikz-pfg"),
  -- G
  require("snippets.latex.G.1"),
  require("snippets.latex.G.2"),
  require("snippets.latex.G.3"),
  require("snippets.latex.G.4"),
  require("snippets.latex.G.5"),
  require("snippets.latex.G.6"),
  require("snippets.latex.G.7"),
  require("snippets.latex.G.8"),
  require("snippets.latex.G.9"),
  -- Templates
  require("snippets.latex.templates.mainfile"),
  require("snippets.latex.templates.subfile"),
}

local snippets = {}
for _,sniptable in ipairs(snippet_tables) do
  for _,snip in ipairs(sniptable) do
    table.insert(snippets,snip)
  end
end

ls.add_snippets('tex',snippets)

[L3MON4D3]

Ah nice, I'm happy you found a solution that works for you :)