how to annotate named enum references

[flrgh]

The current OpenResty ngx annotations are a good example of this problem:

https://github.com/sumneko/lua-language-server/blob/5d5a79fd52c2898bb3e238e750347d8ed9f4da6a/meta/3rd/OpenResty/library/ngx.lua#L4089-L4091

So there's a global ngx object with a function ngx.log() that takes a log level as its first parameter. The log levels are all integers that are defined as "constant" values on the ngx table (i.e. ngx.DEBUG, ngx.INFO, and so on), such that the convention is to call the function like so:

ngx.log(ngx.INFO, "something happened!")

I'd like to annotation this function so that the log level constants are returned as tab completion items:

ngx.log({Tab} -> yields `ngx.INFO`, `ngx.DEBUG`, etc

You can see how I've attempted to annotate things here:

https://github.com/sumneko/lua-language-server/blob/5d5a79fd52c2898bb3e238e750347d8ed9f4da6a/meta/3rd/OpenResty/library/ngx.lua#L146-L167

However, the completion items come back as strings:

Here's the RPC response from the server:

{
  id = 156,
  jsonrpc = "2.0",
  result = {
    isIncomplete = false,
    items = { {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.DEBUG'",
        sortText = "0001"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.INFO'",
        sortText = "0002"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.NOTICE'",
        sortText = "0003"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.WARN'",
        sortText = "0004"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.ERR'",
        sortText = "0005"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.ALERT'",
        sortText = "0006"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.CRIT'",
        sortText = "0007"
      }, {
        insertTextFormat = 2,
        kind = 20,
        label = "'ngx.EMERG'",
        sortText = "0008"
      } }
  }
}

I've tried all sorts of permutations for this, and I can't seem to make it work. Either I get back strings or I get no completion results at all.

object name/reference: "unknown alias ngx.DEBUG"

---@param level ngx.DEBUG|ngx.INFO
function ngx.log(level, ...) end

alias: no results

ngx.DEBUG = 1 ---@alias ngx.DEBUG integer
ngx.INFO = 2 ---@alias ngx.INFO integer

---@param level ngx.DEBUG|ngx.INFO
function ngx.log(level, ...) end

class: no results

---@class log_level : integer

---@type log_level
ngx.DEBUG =1

---@param level log_level
function ngx.log(level, ...) end

quoted alias: results are strings instead of names/references

ngx.DEBUG = 1 ---@alias ngx.DEBUG integer
ngx.INFO = 2 ---@alias ngx.INFO integer

---@param level 'ngx.DEBUG'|'ngx.INFO'
function ngx.log(level, ...) end

[flrgh]

Ah, I have discovered there is already an existing ticket opened for exactly this same use-case :)

#1061

Seems like I'll be able to use backticks for this in a future release?

[C3pa]

Yes, the feature described in #1061 was implemented.