---@aliases don't work in v3.x as they did in v2.6.8

[C3pa]

Describe the bug
In v3.x fields defined in ---@alias with '' get converted to string literals (inside ""). That wasn't the behavior of the older versions.

To Reproduce
Steps to reproduce the behavior, use the following code:

local ngx = {}

ngx.DEBUG  = 8
ngx.INFO   = 7
ngx.NOTICE = 6
ngx.WARN   = 5
ngx.ERR    = 4
ngx.CRIT   = 3
ngx.ALERT  = 2
ngx.EMERG  = 1
ngx.STDERR = 0

--- NGINX log level constants
--- https://github.com/openresty/lua-nginx-module/#nginx-log-level-constants
---@alias ngx.log.level
---| 'ngx.DEBUG'  # debug
---| 'ngx.INFO'   # info
---| 'ngx.NOTICE' # notice
---| 'ngx.WARN'   # warning
---| 'ngx.ERR'    # error
---| 'ngx.ALERT'  # alert
---| 'ngx.CRIT'   # critical
---| 'ngx.EMERG'  # emergency
---| 'ngx.STDERR' # standard error
---@param level ngx.log.level
---@param ... string|number|'nil'|'ngx.null'
function ngx.log(level, ...) end

ngx.log

2. Start typing (
3. See the error

Expected behavior
The expected behavior is the behavior from v2.6.8. The alias entries enclosed in single '' shouldn't be converted to string literals (enclosed with "").

Screenshots

• v3.0.2:

• The autocomplete suggestion.

• What the autocomplete expands to.

• v2.6.8:

• The autocomplete suggestion.

• What the autocomplete expands to.

Environment:

• OS: Windows
• Client: VSCode

Additional context
If there is a reason why this is changed, could you instruct me on how to achieve the same result with a different approach?

[sumneko]

see #980
Dose not support this behavior after 3.X

[C3pa]

Such a shame. This allowed providing autocomplete for functions with enumeration constants in a separate table. That also means that there are some ---@meta files here, that don't work anymore. Actually, that was the place I took the above example from.

[sumneko]

The new syntax will be used to implement this function in the plan:

---@alias ngx.log.level
---| `ngx.DEBUG`  # debug
---| `ngx.INFO`   # info
---| `ngx.NOTICE` # notice

[C3pa]

Nice. Also, it does make sense to treat the values inside '' or "" as strings. Another benefit is that moving to `` quotes won't be hard to update in the existing code.

[C3pa]

Thanks for responding quickly. Your project is so good!

[sumneko]

Have supported, need to update meta files

[flrgh]

Thanks @sumneko! I am trying to update the OpenResty annotations for this now and running into a hiccup. Right now completion support isn't working how I expect.

Can you tell me if I'm doing something wrong here?

---@class ns
local ns = {}

ns.A = 1 ---@class ns.A
ns.B = 2 ---@class ns.B

---@alias ClassEnum
---| `ns.A`
---| `ns.B`


---@param e ClassEnum
local function foo(e)
  print(e)
  return e
end

foo(ns.A)

---@alias IntEnum
---| 1
---| 2


---@param e IntEnum
local function bar(e)
  print(e)
  return e
end

hover works as expected for foo:

However, foo receives no special completion results. If I explicitly request completion within the editor I get the default/global types:

Observe bar receives the proper completion results:

service.log

neovim-lsp.log

[C3pa]

Hi @flrgh!

According to the commit that implements this feature, it is now supposed to be written as:

---@type `CONST.X` | `CONST.Y`
local x
if x == -- suggest `CONST.X` and `CONST.Y` here

So, a new local table with the constants needs to be constructed and then used as a parameter to functions that accept those.

[sumneko]

@flrgh this feature dose not include in v3.2.5, please checkout master

[C3pa]

Thanks for implementing this!