[SOLVED] Lua Language Server type annotations for rxi/classic classes

[keharriso]

Hello, everyone! I've been having a lot of success with the tiny rxi/classic class library. I understand the Lua Language Server has class and type annotations, but I can't seem to make them work with the classic classes. Has anyone had success using a class library with type annotations?

[ravener]

I've been having the same issue, have you found a solution yet?

[keharriso]

Solution found!

Example:

Code: Select all

---@class Map
---@overload fun(cols: integer, rows: integer): Map
local Map = Object:extend()

function Map:new(cols, rows)
    -- initialize map
end

[gcmartijn]

I did never heard of Lua Language Server (LLS), very interesting.

At the moment I'm using Ldoc , to generate documentation for my code
https://github.com/lunarmodules/ldoc

I see that they use different annotations for example this is Ldoc

Code: Select all

---
-- @tparam triggerData triggerData
-- @tparam actionData actionData
-- @tparam table actionList
-- @tparam number actionListIndex
-- @tparam number actionId
-- @tparam function afterProcessActionListCallback
function ActionCamera:execute(
    triggerData,
    actionData,
    actionList,
    actionListIndex,
    actionId,
    afterProcessActionListCallback)

I'm wondering if LLS can generate written code into html like Ldoc?
For example like this https://stevedonovan.github.io/winapi/api.html

[gcmartijn]

Answer my own question: https://luals.github.io/wiki/export-docs/ it is possible to export to json and markdown.
I know that there are many tools to convert markdown into html, so I'm going give it a try thanks for sharing this !

[gcmartijn]

Hello, everyone! I've been having a lot of success with the tiny rxi/classic class library. I understand the Lua Language Server has class and type annotations, but I can't seem to make them work with the classic classes. Has anyone had success using a class library with type annotations?

How did you include love ?

[keharriso]

How did you include love ?

I think if you are using the LLS plugin by sumneko, you need to add this to your settings.json:

Code: Select all

    "Lua.workspace.library": [
        "${3rd}/love2d/library"
    ],

[gcmartijn]

Yes that works with

Code: Select all

"Lua.workspace.checkThirdParty": "Apply",