add meta data for each add_snippets call

DOC.md

@@ -2315,6 +2315,19 @@ require("luasnip.loaders").edit_snippet_files {
   end
 }
 ```
+* `target_snippet`: `table:snippet` If you have config option `store_meta_data`
+    set to true, then passing a target snippet to the edit function will jump
+    the cursor to the location where the target snippet is declared.
+    Currently, this only works for snippets that have been loaded through
+    `loaders.from_lua`. NOTE: the edit function only uses props that are
+    returned from `ls.get_context()` so you can either supply a full snip or
+    the stripped down variant returned from `get_context`.
+```lua
+require("luasnip.loaders").edit_snippet_files({
+  target_snippet = my_snippet,
+})
+```
+
 
 One comfortable way to call this function is registering it as a command:
 ```vim

doc/luasnip.txt

@@ -1,4 +1,4 @@
-*luasnip.txt*           For NVIM v0.8.0           Last change: 2023 January 08
+*luasnip.txt*           For NVIM v0.8.0           Last change: 2023 January 11
 
 ==============================================================================
 Table of Contents                                  *luasnip-table-of-contents*
@@ -2267,6 +2267,20 @@ there are multiple) the associated file to edit.
         end
         }
     <
+- `target_snippet`: `table:snippet` If you have config option `store_meta_data`
+    set to true, then passing a target snippet to the edit function will jump the
+    cursor to the location where the target snippet is declared. Currently, this
+    only works for snippets that have been loaded through `loaders.from_lua`. NOTE:
+    the edit function only uses props that are returned from `ls.get_context()` so
+    you can either supply a full snip or the stripped down variant returned from
+    `get_context`.
+
+
+>
+    require("luasnip.loaders").edit_snippet_files({
+      target_snippet = my_snippet,
+    })
+<
 
 
 One comfortable way to call this function is registering it as a command:

lua/luasnip/config.lua

@@ -24,6 +24,18 @@ local defaults = {
 	region_check_events = "User None",
 	delete_check_events = "User None",
 	store_selection_keys = nil, -- Supossed to be the same as the expand shortcut
+
+	-- TODO: generates a function which, given a filename produces the metadata
+	-- that shall badded to snippets loaded by one of the loaders.
+	--
+	-- @params table:
+	--        may contain: filename
+	--        ...
+	store_meta_data = false, -- For each snippet, eg. source path.
+	store_meta_data2 = function(opts)
+		return {}
+	end,
+
 	ext_opts = {
 		[types.textNode] = {
 			active = { hl_group = "LuasnipTextNodeActive" },

lua/luasnip/extras/init.lua

@@ -113,6 +113,31 @@ local function match(index, _match, _then, _else)
 	return F(func, index)
 end
 
+-- TODO: MOVE TO OWN MODULE
+local function jump_to_snip(snip)
+	local meta_data =
+		require("luasnip.session.snippet_collection").get_meta_data_by_snip_id(
+			snip.id
+		)
+	local source = meta_data.source
+	if source then
+		vim.cmd("edit " .. source)
+		if snip.name then
+			local feed_str = vim.api.nvim_replace_termcodes(
+				"/" .. snip.name .. "<CR>",
+				true,
+				true,
+				true
+			)
+			vim.fn.feedkeys(feed_str, "n")
+		end
+	else
+		print(
+			"No source found for id: " .. snip.id .. " with name: " .. snip.name
+		)
+	end
+end
+
 return {
 	lambda = lambda,
 	match = match,
@@ -161,4 +186,6 @@ return {
 	--alias
 	l = lambda,
 	m = match,
+
+	jump_to_snip = jump_to_snip,
 }

lua/luasnip/init.lua

@@ -63,24 +63,66 @@ local function default_snip_info(snip)
 	}
 end
 
-local function available(snip_info)
+---Retrieve available snippets
+---@param snip_info function: takes a snip and returns whatever props you want
+---         from the snippet
+---
+---@param opts: May contain:
+---         scope <nil|string("buf","everything")|table(filetypes)
+---           buf: returns snippets for current buffers filetypes
+---           everything: returns all loaded snippets
+---           table: allows you to filter snippet subsets by filetype(s)
+---         include_autosnippets bool
+---
+---@return table: the resulting table of ft snip mappings after fitlers have
+--          been applied
+local function available(snip_info, opts)
+	opts = opts or {}
+	opts.scope = opts.scope or "buf"
+	opts.include_autosnippets = opts.include_autosnippets or true
 	snip_info = snip_info or default_snip_info
-
-	local fts = util.get_snippet_filetypes()
 	local res = {}
-	for _, ft in ipairs(fts) do
-		res[ft] = {}
-		for _, snip in ipairs(get_snippets(ft)) do
+
+	local function validate_and_append_to_res(ft, t_snips)
+		for _, snip in ipairs(t_snips) do
 			if not snip.invalidated then
 				table.insert(res[ft], snip_info(snip))
 			end
 		end
-		for _, snip in ipairs(get_snippets(ft, { type = "autosnippets" })) do
-			if not snip.invalidated then
-				table.insert(res[ft], snip_info(snip))
+	end
+
+	local function filter_all_snippets(t_snips)
+		for ft, snips in pairs(t_snips) do
+			if
+				opts.scope == "everything" or vim.tbl_contains(opts.scope, ft)
+			then
+				if not res[ft] then
+					res[ft] = {}
+				end
+				validate_and_append_to_res(ft, snips)
 			end
 		end
 	end
+
+	if opts.scope == "buf" then
+		local fts = util.get_snippet_filetypes()
+		for _, ft in ipairs(fts) do
+			res[ft] = {}
+			validate_and_append_to_res(ft, get_snippets(ft))
+			if opts.include_autosnippets then
+				validate_and_append_to_res(
+					ft,
+					get_snippets(ft, { type = "autosnippets" })
+				)
+			end
+		end
+	elseif opts.scope == "everything" or type(opts.scope) == "table" then
+		filter_all_snippets(get_snippets())
+		if opts.include_autosnippets then
+			filter_all_snippets(get_snippets(nil, { type = "autosnippets" }))
+		end
+	end
+
 	return res
 end
 

lua/luasnip/loaders/from_lua.lua

@@ -28,6 +28,7 @@ local util = require("luasnip.util.util")
 local str_util = require("luasnip.util.str")
 local ls = require("luasnip")
 local log = require("luasnip.util.log").new("lua-loader")
+local session = require("luasnip.session")
 
 local M = {}
 
@@ -83,6 +84,9 @@ local function load_files(ft, files, add_opts)
 			ft,
 			file_snippets,
 			vim.tbl_extend("keep", {
+				-- TODO: redo `source` here by passing the entire meta-table
+				-- metadata =
+				source = file,
 				type = "snippets",
 				key = "__snippets_" .. file,
 				-- prevent refresh here, will be done outside loop.
@@ -93,6 +97,7 @@ local function load_files(ft, files, add_opts)
 			ft,
 			file_autosnippets,
 			vim.tbl_extend("keep", {
+				source = file,
 				type = "autosnippets",
 				key = "__autosnippets_" .. file,
 				-- prevent refresh here, will be done outside loop.

lua/luasnip/session/snippet_collection.lua

@@ -1,3 +1,5 @@
+local session = require("luasnip.session")
+
 -- store snippets by some key.
 -- also ordered by filetype, eg.
 -- {
@@ -128,6 +130,33 @@ local by_id = setmetatable({}, {
 	__mode = "v",
 })
 
+-- If `add_snippets` opts.source and config.store_meta_data then each call to
+-- add snippets stores the source file and potentially other meta data in this
+-- table which then each snippet points to so that one can `jump-to-snip`
+-- by calling `loaders.edit_snippet_files({ target_snippet = snip_context_x })`
+local snippets_meta_data = {}
+local snip_id_to_meta_map = {}
+
+local function initialize_snippet_meta_data(opts)
+	-- If we use two funcs one for module and one for each snip then the following
+	-- block would obviously have to be modified to work with that
+	--
+	-- config.store_snippets_data = {
+	--     get_module_module_data = function(opts) return { source = opts.source },
+	--     for_each_snippet = function(ft, snip, opts) ... end
+	-- }
+
+	-- func / table
+	if type(session.config.store_meta_data) == "function" then
+		-- NOTE: use function is still a bit wip
+		table.insert(snippets_meta_data, session.config.store_meta_data(opts))
+
+	-- if bool
+	elseif session.config.store_meta_data then
+		table.insert(snippets_meta_data, { source = opts.source })
+	end
+end
+
 -- ft: any filetype, optional.
 function M.clear_snippets(ft)
 	if ft then
@@ -239,7 +268,14 @@ end
 local current_id = 0
 -- snippets like {ft1={<snippets>}, ft2={<snippets>}}, opts should be properly
 -- initialized with default values.
+--
+-- opts.source = path to snip module which is assigned in
+-- `from_lua.load`
 function M.add_snippets(snippets, opts)
+	if session.config.store_meta_data then
+		initialize_snippet_meta_data(opts)
+	end
+
 	for ft, ft_snippets in pairs(snippets) do
 		local ft_table = by_ft[opts.type][ft]
 
@@ -270,6 +306,14 @@ function M.add_snippets(snippets, opts)
 			table.insert(by_prio[snip.snippetType][snip.priority][ft], snip)
 			table.insert(by_ft[snip.snippetType][ft], snip)
 			by_id[snip.id] = snip
+
+			if session.config.store_meta_data then
+				snip_id_to_meta_map[snip.id] = #snippets_meta_data
+				-- TODO: (wip) following line would store single snippet specific data
+				--      we are not sure yet how this would be done but I leave it here
+				--      for reference
+				-- snippets_meta_data[#snippets_meta_data].snippet_specific[snip.id] = session.config.store_meta_data.each_snippet(ft, snip, opts)
+			end
 		end
 	end
 
@@ -311,4 +355,8 @@ function M.get_id_snippet(id)
 	return by_id[id]
 end
 
+function M.get_meta_data_by_snip_id(id)
+	return snippets_meta_data[snip_id_to_meta_map[id]]
+end
+
 return M