[Feature Request] Better enum support

[cryogeen]

At the moment when u define an enum like this in 1 file (ill refer to this as EnumFile.lua)

---@enum MyEnum
local myEnum = {
    entry1 = 1
}

return myEnum

and you require it in another file (main.lua)

---@type MyEnum
local myEnum = require("EnumFile.lua")

local enumEntry = myEnum.entry1 -- error

what i expect it to do instead with something like ---@type is to return the enum object (the table with the entries), not any entry within the enum. if this is intended behaviour then i think the enum system is kind of bad.

i do have a solution, which doesnt work but is my feature request

when u ---@type a variable, and u want to set the type to the Enum object itself (not any entry of the enum) then add something like [] at the end of the type (if its an enum) to signal it being an enum object, and without [] it just being an entry within the enum

here is an example

---@type MyEnum[]
local myEnum = require("EnumFile.lua")

---@type MyEnum
local enumEntry = myEnum.entry1

[tomlau10]

I believe you mis-used @enum, it is for creating a type to represent the enum entries, such that for example you can specify it in @param of a function:

---@enum MyEnum
local MyEnum = {
    a = 1,
    b = 2,
    c = 3,
}

---@param p MyEnum
local function test(p) end

test(MyEnum.a)  --> ok
test(1)         --> ok
test(4)         --> Cannot assign `integer` to parameter `MyEnum`.
test(MyEnum.d)  --> Undefined field `d`.

---

If you want to set the type to the Enum object itself, you need to use @class.
And you can annotate the same table with @enum and @class at the same time like this:

---@enum MyEnum
local MyEnum = {    ---@class MyEnum.*
    a = 1,
    b = 2,
    c = 3,
}

---@type MyEnum.*
local myEnum = require("EnumFile.lua")
print(myEnum.a) --> ok
print(myEnum.d) --> Undefined field `d`.

[cryogeen]

Oh i see, this will work for what im trying to do. Thank you.

Solution: Create a class with the same enum name just with any character after it. (like * or .)