My program is configured in Lua: How can I be a good citizen for LuaLS?

[tchoutri]

Hi, my project confer is configured in lua, with most APIs defined in the host language (Haskell) and injected in the Lua runtime.

Considering that the Lua runtime used by LuaLS is not going to be the one embedded in my program, there's bound to be a mismatch between what they can see at runtime. How may I inform LuaLS that such and such identifiers are of a certain type, or a table with certain expected fields?
I have some flexibility on the Haskell-side Lua API framework, but this is my first time working with Lua and a custom runtime, so I may require some explanations that are obvious to others.

I can also accept that LuaLS is best used for self-contained Lua codebases where modules refer their explicit dependencies on the file-system. I'll just move to a different mean of producing documentation statically.

---

Thanks a lot for the project by the way, it was really useful to me when I was using Neovim, and now I'm finding myself in a position where I am the one providing a Lua API. ❤️

[CppCXY]

You can make the LSP recognize these definitions by creating a meta file. like:

--xxx.d.lua
---@meta

---@class Test
local Test = {}

--- Markdown description
---@param aaa string
---@return string
function Test:example(aaa)
    return "example"
end

[tchoutri]

Thanks! Where would this file be located on the end-user's system? How would the end-users make their LuaLS aware of it?

[CppCXY]

And where would this file be located on the end-user's system?

Anywhere the language server can recognize — for example, inside the project itself or in locations pointed to by "workspace.library" in .luarc.json. You can refer to the configuration documentation for details.

[tchoutri]

@CppCXY Got it, thank you. :)