add meta data for each `add_snippets` call #719

molleweide · 2023-01-08T18:30:23Z

implements basis for adding meta data to snippets w/new config param.
improves available() to be a bit more versatile.
adds jump_to_snip() under extras

molleweide · 2023-01-08T19:05:33Z

It seems that the CI removed my additions to the doc/luasnip.txt file. 47a669d

L3MON4D3 · 2023-01-08T19:53:09Z

Ah, yeah add doc to DOC.md, doc/luasnip.txt is auto-generated from it 😅

molleweide · 2023-01-08T20:04:51Z

Ah, yeah add doc to DOC.md, doc/luasnip.txt is auto-generated from it 😅

fixed it

L3MON4D3 · 2023-01-08T20:24:16Z

Nice 👍

L3MON4D3 · 2023-01-08T20:45:11Z

lua/luasnip/config.lua

@@ -24,6 +24,7 @@ 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
+	store_meta_data = false, -- For each snippet, eg. source path.


I think I'd like this to be a table, which can accept keys to determine what is stored. Most capable would be just a function which receives all available data and creates the metadata for the snippet, but I think this is overdoing it, since we probably don't need much flexibility there.

Still, making this a table would somewhat future-proof it, like

metadata = {sourcefile=true, line=true, custom = somefn}

I think using a subtable is good idea. I don't understand your reasoning about the function but it makes sense to do this properly in case we come up with more use cases.

Nice, thanks!
My idea with the function was to allow complete customization of what is put into the metadata, essentially by calling a function like

function loader_metadata(filename, line) return {source=filename, source_line = line} end

in the loaders.

Since there isn't this much customization possible (I think), letting the user set some keys for what exactly should be stored in the metadata-table seems like a more straightforward, and easier to use simplification.

Ill try to making it into a func and see how it feels

Now, this is the only thing left to do.

How would one get the source line of the snippet in this function? Is there something builtin to luasnip already?

Oh, that's very hard to do for lua and vscode, I used it because I wanted an example for why more flexibility might be good.
I think we should not determine all lines up-front (except if it's trivial, like in the snipmate-loader), since only a tiny subset of this information will be useful, and it should, I think, be calculated on-demand

Maybe not very hard, non-trivial

Also, the location for where the meta data loader should be called is within the session.snippets_colletion right, so we need to local session = require("luasnip.session") and then pass along snippets and opts to store_meta_data().

I had in mind that add_snippets receives the complete metadata (which may be nil), and we make the config-option specific to the loaders

Maybe not very hard, non-trivial

Aight, for now my feed keys thingy works good nuff

Right! heuristics like that should do it for 99%

lua/luasnip/init.lua

lua/luasnip/loaders/init.lua

lua/luasnip/session/snippet_collection.lua

* upstream/master: Auto generate docs Auto generate docs docs(extras): add Snippet List feat(extras): added open_snippet_list

opts.scope allows one to either retrieve: 1. buf snips 2. snips by list of requested filetypes 3. all possible snips if scope == "everything" opts.include_autosnippets

molleweide · 2023-01-09T13:36:25Z

I undid my changes to the default_snip_info func now that I pulled your latest changes.
I added an opts param to the ls.available() func so that one can retrieve snippets with a little bit more flexibility.

Now you can either:

retrieve snips for buf
.... all snips
.... only a subset of filtypes if you pass opts.scope = { "ft1", "ft2" }

molleweide · 2023-01-09T15:36:53Z

Oh i realise that I merged master instead of rebasing. Ill have to look into how I can undo this later.

molleweide · 2023-01-09T16:41:50Z

i created a base for using a user function when loading meta data. check it out and tell me what you think.

molleweide · 2023-01-09T17:01:15Z

Also feel free (not important...) to try my picker that I linked to under the issue discussion. it shows you how I use all of the features in the available() func.

L3MON4D3 · 2023-01-10T14:36:55Z

I undid my changes to the default_snip_info func now that I pulled your latest changes.

I added an opts param to the ls.available() func so that one can retrieve snippets with a little bit more flexibility.

Now you can either:

retrieve snips for buf

.... all snips

.... only a subset of filtypes if you pass opts.scope = { "ft1", "ft2" }

I think we can use get_snippets for this usecase? (Don't really want to tack more onto available, we kind of messed up its design by having it take an optional argument directly, and not in an opts-table🤦)

L3MON4D3 · 2023-01-10T14:37:43Z

I'll take a look at the other changes later😅

molleweide · 2023-01-10T15:01:15Z

I'll take a look at the other changes later😅

Aight no stress!

molleweide · 2023-01-10T15:03:14Z

I think we can use get_snippets for this usecase? (Don't really want to tack more onto available, we kind of messed up its design by having it take an optional argument directly, and not in an opts-table🤦)

Cool yeah im down for whatever. I'll wait untill you've had a closer look and then I modify it accordingly.

L3MON4D3 · 2023-01-10T16:41:41Z

lua/luasnip/extras/init.lua

@@ -113,6 +113,30 @@ local function match(index, _match, _then, _else)
 	return F(func, index)
 end

+local function jump_to_snip(snip)


I think this deserves its own module, then we can cleanly provide different heuristics for finding the correct snippet (after making that configurable ofc :D)
For example, finding in snipmate/lua/vscode could be made more precise by writing it specifically for that type of snippet

ok. i'll move this into its own module.

L3MON4D3 · 2023-01-10T16:45:37Z

lua/luasnip/init.lua

@@ -63,24 +63,66 @@ local function default_snip_info(snip)
 	}
 end

-local function available(snip_info)


Okay afaict this can also be achieved with either the old available (scope=buf) or get_snippets (everything else). Even though this design is nice, separate functions are backward compatible, so I think we should stick with that

quick note: my addition should be backwards compatible.
I'll get back with another reply later.

Allright, so I think I understand what you mean but could you tell me a bit more specifically what you'd like me to do. Is my modification worth keeping in a modified state or should we scrap it completely?

My idea was that it made sense to put the logic in available so that one could filter all possible combinations via snip_info but I am also down with splitting it up somehow.

True, of course it is backward compatible 🤦
What I don't like about this is that there's no good reason for snip_info to not be a part of opts, except staying backward compatible.

I think we'll have to scrap it :/
An alternative would be to expose it in addition to available (and implement available using it), but all of its functionality can be covered better by get_snippets (since get_snippets can access the implementation of snippet_collection)

An alternative would be to expose it in addition to available (and implement available using it), but all of its functionality can be covered better by get_snippets (since get_snippets can access the implementation of snippet_collection)

Yeah this makes sense. I'll try to add a new successor func that only uses the opts param. I'm thinking about calling it filter_snippets(opts) or retrieve_snippets(opts).

L3MON4D3 · 2023-01-10T16:56:53Z

lua/luasnip/session/snippet_collection.lua

+local snippets_meta_data = {}
+local snip_id_to_meta_map = {}
+
+local function initialize_snippet_meta_data(opts)


Okay, I think this mechanism is good, but we need to split it up a bit:

config generates a function which, given a filename produces the metadata that shall be added to snippets loaded by one of the loaders. We should not pass the filename directly, but wrap it in a table like {filename=<the filename>}, since we can then add more arguments and the function will stay comfortable to use (no need to write a handler like function(_, _, _, theOneArgINeed) ... end)

this function is used in loaders to generate the metadata for the snippets (no ifs or something like that, we can just call the function. This is flexible enough to probably not require any changes, except if new parameters are added)

add_snippets receives metadata-table, which is associated with the snippets added in this call, unconditionally

Ok, I have to ponder your reply and come back later with a revised version.

Looking forward to it :D
If you have any questions or other ideas, go ahead, I'd love to find something better (especially the association of snippet with its metadata is a bit annoying, since we have to do that id-redirection. Can't think of a better way though :/)

Cool, yeah I cant really come up with something better either atm.
Let's optimize it later and I'll stick to the id mapping for now.

L3MON4D3 · 2023-03-13T09:57:27Z

Hey!
I just found out about debug.getinfo, we could use this to accurately get the lines a snippet is defined on (for lua!!!).
With this, and snipmate working nicely (ie. we can get the lines the snippet is defined on), I have to admit that snippet-specific metadata is probably the way to go, and wouldn't mind just setting snippet.metadata (though I'd still like an API through snippet_collection, that would allow us to replace this later on)

Are you still interested in working on this? No worries if not, I'd be up for getting this done

L3MON4D3 · 2023-03-16T11:02:53Z

Was feeling a bit too motivated the last few days, couldn't resist doing some work on this 😅
Check #826, I'd love to hear your thoughts :D

molleweide · 2023-03-18T11:24:47Z

Hey mate!!
Wow, I gotta checkout what you've done. I haven't spent a lot of time on this since we last spoke - i just haven't had time + plus too many macos issues with vim so there has been some other fires ive had to try to put out 🙄 (i have to migrate over to linux asap)
I'll look at what you did and see if I can come with some valid feedback. I'm really excited to hear that you got something good working. :)
If I can get back on track I would sure love to help out a bit more but atm I have a bit of a hurdle to get past.

edit

Dude, you added the feature where one can jump to the source from within an opened snippet - that is pretty damn cool.

L3MON4D3 · 2023-03-18T14:22:02Z

I haven't spent a lot of time on this since we last spoke - i just haven't had time + plus too many macos issues with vim so there has been some other fires ive had to try to put out 🙄 (i have to migrate over to linux asap)

Phuh, that's rough😅

I'll look at what you did and see if I can come with some valid feedback. I'm really excited to hear that you got something good working. :)

👍👍

If I can get back on track I would sure love to help out a bit more but atm I have a bit of a hurdle to get past.

Take your time, I don't have much to do right now, so plenty of opportunity to work on this :)

Dude, you added the feature where one can jump to the source from within an opened snippet - that is pretty damn cool.

Yeah! Really happy that worked out so well :D

molleweide · 2023-03-18T16:57:48Z

Yeah! Really happy that worked out so well :D

Has it already improved your workflow?

L3MON4D3 · 2023-03-18T20:05:12Z

Nah xD
But it was fun to write!
And it feels like such a nice addition, I'm sure it'll come in handy sometimes

leiserfg · 2023-03-18T20:47:46Z

But it was fun to write!

Reminds me that after all the work in LuaSnip, I have just like 5 custom snippets 😄

L3MON4D3 · 2023-03-18T22:09:24Z

Reminds me that after all the work in LuaSnip, I have just like 5 custom snippets 😄

😆😆
You're just using friendly-snippets, right? I guess that +lsp covers almost anything one would practically need, most snippets beyond that are just eye(/finger?/brain? :D)-candy

molleweide · 2023-03-19T09:00:01Z

But it was fun to write!

lol

L3MON4D3 · 2023-05-01T20:46:20Z

I've finally merged #826, closing this as well.
Sorry we couldn't use your work :/

molleweide added 6 commits January 7, 2023 15:29

feat: snip id to source file.

8b1e74f

feat: edit snip by id

59f5014

feat: hacky move cursor to snippet location

00c00e5

chore: clean up edit specific snip

0a719dd

feat(config): store meta data

db9f79a

feat(meta_data): point each snippet to meta data table

c4a887b

molleweide changed the title ~~meta data~~ add meta data for each add_snippets call Jan 8, 2023

chore(meta_data): update docs

038a2ef

molleweide force-pushed the molleweide branch from 6249735 to 038a2ef Compare January 8, 2023 20:03

L3MON4D3 reviewed Jan 8, 2023

View reviewed changes

lua/luasnip/init.lua Outdated Show resolved Hide resolved

L3MON4D3 reviewed Jan 8, 2023

View reviewed changes

lua/luasnip/loaders/init.lua Outdated Show resolved Hide resolved

L3MON4D3 reviewed Jan 8, 2023

View reviewed changes

lua/luasnip/session/snippet_collection.lua Outdated Show resolved Hide resolved

molleweide added 2 commits January 9, 2023 02:26

Merge remote-tracking branch 'upstream/master' into molleweide

6bc0139

* upstream/master: Auto generate docs Auto generate docs docs(extras): add Snippet List feat(extras): added open_snippet_list

chore: undo modifications to default_snip_info

5986dff

molleweide force-pushed the molleweide branch from 15bf79f to b17f65c Compare January 9, 2023 08:55

feat(ls.available): add opts param.

4b3836f

opts.scope allows one to either retrieve: 1. buf snips 2. snips by list of requested filetypes 3. all possible snips if scope == "everything" opts.include_autosnippets

molleweide force-pushed the molleweide branch from f99426b to 4b3836f Compare January 9, 2023 13:35

fix(metadata): adds fn get meta by snip id

f8567eb

molleweide force-pushed the molleweide branch from d2f92f3 to f8567eb Compare January 9, 2023 14:01

refactor(jumptosnip): moves the fn to extras

7a5eb78

molleweide force-pushed the molleweide branch from 67c8b0e to 7a5eb78 Compare January 9, 2023 14:07

molleweide force-pushed the molleweide branch from 9c28233 to 7094c68 Compare January 9, 2023 16:39

feat(store_meta_data): improve handling in add_snippets

dff85f0

molleweide force-pushed the molleweide branch from 8dc3983 to dff85f0 Compare January 9, 2023 16:46

L3MON4D3 reviewed Jan 10, 2023

View reviewed changes

wip: redoing metadata

74d80e5

molleweide force-pushed the molleweide branch from d629fc2 to 74d80e5 Compare January 11, 2023 06:41

molleweide added 2 commits January 11, 2023 06:42

Auto generate docs

5c101f1

Format with stylua

0f0dfb4

L3MON4D3 mentioned this pull request Mar 16, 2023

Generate source for loaded snippets. #826

Merged

2 tasks

L3MON4D3 closed this May 1, 2023

add meta data for each add_snippets call #719

add meta data for each add_snippets call #719

Conversation

molleweide commented Jan 8, 2023 • edited Loading

molleweide commented Jan 8, 2023

L3MON4D3 commented Jan 8, 2023

molleweide commented Jan 8, 2023

L3MON4D3 commented Jan 8, 2023

Choose a reason for hiding this comment

molleweide Jan 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

molleweide commented Jan 9, 2023 • edited Loading

molleweide commented Jan 9, 2023

molleweide commented Jan 9, 2023

molleweide commented Jan 9, 2023 • edited Loading

L3MON4D3 commented Jan 10, 2023

L3MON4D3 commented Jan 10, 2023

molleweide commented Jan 10, 2023

molleweide commented Jan 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

L3MON4D3 Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

molleweide Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

molleweide Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

molleweide Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

L3MON4D3 commented Mar 13, 2023

L3MON4D3 commented Mar 16, 2023

molleweide commented Mar 18, 2023 • edited Loading

edit

L3MON4D3 commented Mar 18, 2023 • edited Loading

molleweide commented Mar 18, 2023

L3MON4D3 commented Mar 18, 2023

leiserfg commented Mar 18, 2023

L3MON4D3 commented Mar 18, 2023

molleweide commented Mar 19, 2023

L3MON4D3 commented May 1, 2023

add meta data for each `add_snippets` call #719

add meta data for each `add_snippets` call #719

molleweide commented Jan 8, 2023 •

edited

Loading

molleweide Jan 8, 2023 •

edited

Loading

molleweide commented Jan 9, 2023 •

edited

Loading

molleweide commented Jan 9, 2023 •

edited

Loading

L3MON4D3 Jan 10, 2023 •

edited

Loading

molleweide Jan 10, 2023 •

edited

Loading

molleweide Jan 10, 2023 •

edited

Loading

molleweide Jan 10, 2023 •

edited

Loading

molleweide commented Mar 18, 2023 •

edited

Loading

L3MON4D3 commented Mar 18, 2023 •

edited

Loading