How does folder with LUA scripts work?

[raffaem]

I'm reading the suggested A LuaSnip guide for LaTeX workflows.

I have created the file ~/.config/nvim/snippets/my-snippets/python.lua and I have put this inside of it:

require("luasnip").snippet(
	{ -- Table 1: snippet parameters
          trig="hi",
          dscr="An autotriggering snippet that expands 'hi' into 'Hello, world!'",
          regTrig=false,
          priority=100,
          snippetType="autosnippet"
	},
	{ -- Table 2: snippet nodes (don't worry about this for now---we'll cover nodes shortly)
          t("Hello, world!"), -- A single text node
	}
	-- Table 3, the advanced snippet options, is left blank.
)

In my init.lua I have:

require("luasnip.loaders.from_lua").load({paths = HOME .. "/.config/nvim/snippets/my-snippets"})

When I type "hi", nothing happens.

If I wrap the content of python.lua inside add_snippets:

local ls = require("luasnip")
ls.add_snippets("python", {
	require("luasnip").snippet(
	  { -- Table 1: snippet parameters
		trig="hi",
		dscr="An autotriggering snippet that expands 'hi' into 'Hello, world!'",
		regTrig=false,
		priority=100,
		snippetType="autosnippet"
	  },
	  { -- Table 2: snippet nodes (don't worry about this for now---we'll cover nodes shortly)
		t("Hello, world!"), -- A single text node
	  }
	  -- Table 3, the advanced snippet options, is left blank.
	),
})

Then it works correctly.

I don't understand why the guide didn't tell me to do so.

I also don't understand if "The file’s base name determines which Vim filetype the snippets apply to. For example, snippets inside the file tex.lua would apply to files with filetype=tex".

If that is the case, do I need to specify python as the first argument of add_snippets? isn't the filename sufficient to identify which filetype the snippet applies to?

[L3MON4D3]

Ah, that article omits one detail: you'll have to also return the defined snippets in that file

-- python.lua
return { require("luasnip").snippet(...) }

It also works with add_snippets since that's the function that actually adds snippets (and that file is run like any other lua-file, so calling that in there works, but defeats the purpose of the loader)

[ejmastnak]

Okay, here's a first iteration: https://www.ejmastnak.com/tutorials/vim-latex/luasnip.html#tldr-hello-world-example

@raffaem, since you inspired this perhaps you could test it and give your opinion? E.g. does the hello-world example work, did I miss some obvious detail again, is the example concise enough, etc

[L3MON4D3]

As far as I'm concerned, that's pretty good 👍
Nits/minor suggestions:

• in 2 the order is init.vim, init.lua, reversed in 4 (not sure if you care about stuff like this xD)
• 5: maybe "open a new neovim-instance" instead of opening a file since the file isn't necessary for this to work
• I feel like 6 and 7 (maybe even 5,6,7) could be collapsed into one point, "enter insert, type hi, expand -> hello world"

Oh, and really nice that you could get to that so quickly :)

[ejmastnak]

Nits/minor suggestions:

Thanks! I think all of these are fair points, just updated the guide.

Oh, and really nice that you could get to that so quickly :)

Haha otherwise I would probably forget and never get around to it :P

[raffaem]

@ejmastnak it is fair now. Thank you so much for your work.

Altough I still don't understand the format of the return statement.

Does it return a list (what LUA calls table) of snippets?

So I can return more than one snippet?

Maybe we should specify this :)

[ejmastnak]

@ejmastnak it is fair now. Thank you so much for your work.

Great, glad to hear.

Does it return a list (what LUA calls table) of snippets?
So I can return more than one snippet?

Yes, exactly, to return more than one snippet you return a Lua table/list of snippets (using only one return per file). For example:

-- Place this in ${HOME}/.config/nvim/LuaSnip/all.lua
return {
  -- A snippet that expands the trigger "hi" into the string "Hello, world!".
  require("luasnip").snippet(
    { trig = "hi" },
    { t("Hello, world!") }
  ),

  -- To return multiple snippets, use one `return` statement per snippet file
  -- and return a table of Lua snippets.
  require("luasnip").snippet(
    { trig = "foo" },
    { t("Another snippet.") }
  ),
}

I also just updated the blog post with the above two-snippet example.