LuaLS metafile? Do we need one?

[cg-223]

https://luals.github.io/wiki/definition-files/
We should probably make one of these. Proper support for LuaLS (especially in areas intended for outside developer use/general api stuff) would be very helpful.

We could also potentially make one for "general" things. It would be fairly simple to produce a simple global table and pass that to LuaLS instead of forcing it to scan the entire workspace to know what _G might look like.

Considering LuaLS can already mostly identify and autocomplete with relative ease, performance is a worry and having things documented inside the editor (to the extent of luals support) would be much healthier for developers.

[WilsontheWolf]

Actually last night I ended up just pointing luals to my SMODS folder and it just kinda worked. I didn't notice any performance issues but also my machine is pretty beefy. I'm not sure if it's worth us maintaining a separate file for luals definitions when it works fine with just the source code, especially with how often we adjust stuff. It may be nice to go through adding comments to stuff so it is picked up by luals though.

[GauntletGames-2086]

It'll work for now, but it won't work for everything. Annotations will only pick up if the function is declared directly (i.e. not inside a table).

foo = {}
---@param x integer
---This'll pick up as a annotation for a function
function foo.bar(x) end

foo = {
    ---@param x integer
    ---This will not
    bar = function(x) end
}

For most functions it's fine but anything defined within classes will not work (without help at least).

[cg-223]

I'm aware you can do that, but that doesn't work so well when you want Balatro source, other mods, etc, especially on low-end systems. And it's not perfect either, for example it can't interpret what you're doing with a function argument (e.g. calculate args in a SMODS.Center call) without prewritten help. Comments above functions would be a bare minimum for in-ide support.

[GauntletGames-2086]

I'm of the opinion that it's not high priority (especially since updates are constant, managing this right now would be difficult and painful) but having one available on release would be great.

[GauntletGames-2086]

ehh got nothing else to do, might as well. relevant PR: #399