Dynamic Meta Info

[TurtleP]

Heya,

So, I'm the developer of LÖVE Potion. I gave it some thought to add a meta file for some of its functionality. However, I am unsure of what to do for a few functions. Here's an example:

---@module 'love'
local love

---@meta

---@alias ctr_screen_2d
---| 'top'    Top 3DS Screen
---| 'bottom' Bottom 3DS Screen

---@alias ctr_screen_3d
---| 'left'   (Top) Left 3DS Screen
---| 'right'  (Top) Right 3DS Screen
---| 'bottom' Bottom 3DS Screen

---@alias hac_screen
---| 'default' Main screen

---@alias cafe_screen
---| 'tv'      TV screen
---| 'gamepad' Gamepad screen

---@param screen ctr_screen_3d
function love.draw(screen)
end

The problem is that this function is different for many reasons in its parameter. In this case, a 3DS would only have 'left', 'right', or 'bottom' by default since stereoscopic 3d is enabled by default. However, if it isn't, then it would pass 'top' or 'bottom'. This also is a bit more complicated because I have to also add values for the Switch (and Wii U!) where all screen aliases are different. I do have a way to check the current console, love._console_name, but afaik with this being a meta file, I can't really use that. Is there a way to have end-users configure the data on their end to give them the proper hintings?

[C3pa]

The closest thing that comes to my mind would be to define all the other possible argument aliases as overloads to the function:

---@param screen ctr_screen_3d
---@overload fun(screen : ctr_screen_2d)
---@overload fun(screen : hac_screen)
---@overload fun(screen : cafe_screen)
function love.draw(screen) end

-- or you can define a union type using |
---@param ctr_screen_2d|screen ctr_screen_3d|hac_screen|cafe_screen
function love.draw(screen) end

Then to really see which works best for you I'd recommend trying both and seeing for yourself which gives you the best results.

[carsakiller]

Interesting, I have the same problem for CC:Tweaked, where it implements its own print and os library. Duplicate definitions were also appearing for me and I have been trying to find a way to only have mine show. I had never thought to nil a function, though.

It appears to even work! However, it looks like it only works within this file. Once I go to another file and try to access print, it is the default print.

I do agree that there should be some way to overwrite the default definitions - I am just not sure how it can be done. What if two overwriting definitions exist for the same function? I think this should probably be an issue so we can try and find a solution 🙂.

[TurtleP]

Yeah that's definitely something that is relevant to the issue @C3pa mentioned. We should comment our concerns there.

I think for now, I might just have to copy the love2d docs and edit them myself for LÖVE Potion, which sucks.

[C3pa]

Oh, yeah I forgot you can include a settings file for your code editor and disable the loading of certain files. I think you can use that to disable some definitions that come with LÖVE in your use case. https://github.com/sumneko/lua-language-server/wiki/Configuration-File

[TurtleP]

Issue with that, is it's just specific functions, not entire files that I need to deal with.

[C3pa]

On the topic of duplicate definitions, we've got a setting to disable certain built-in definitions:
https://github.com/LuaLS/lua-language-server/wiki/Settings#runtime