Merge remote-tracking branch 'upstream/master' into config--add-custom-repository-support-for-addonManager

Author: fesily

changelog.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
+* `FIX` Improve type narrow with **literal alias type** during completion and signature help
+* `NEW` Setting: `Lua.type.inferTableSize`: A Small Table array can be infered
 * `NEW` Add custom repository support for addonManager. New configuration setting: `Lua.addonManager.repository_branch` and `Lua.addonManager.repository_path`
 
 ## 3.12.0

script/config/template.lua

@@ -403,6 +403,7 @@ local template = {
     ['Lua.type.weakNilCheck']               = Type.Boolean >> false,
     ['Lua.type.inferParamType']             = Type.Boolean >> false,
     ['Lua.type.checkTableShape']            = Type.Boolean >> false,
+    ['Lua.type.inferTableSize']             = Type.Integer >> 10,
     ['Lua.doc.privateName']                 = Type.Array(Type.String),
     ['Lua.doc.protectedName']               = Type.Array(Type.String),
     ['Lua.doc.packageName']                 = Type.Array(Type.String),

script/core/signature.lua

@@ -114,7 +114,13 @@ local function isEventNotMatch(call, src)
     end
     local eventLiteral = event.extends.types[1] and guide.getLiteral(event.extends.types[1])
     if eventLiteral == nil then
-        return false
+        -- extra checking when function param is not pure literal
+        -- eg: it maybe an alias type with literal values
+        local eventMap = vm.getLiterals(event.extends.types[1])
+        if not eventMap then
+            return false
+        end
+        return not eventMap[literal]
     end
     return eventLiteral ~= literal
 end

script/vm/compiler.lua

@@ -962,6 +962,26 @@ local function compileCallArgNode(arg, call, callNode, fixIndex, myIndex)
     local function dealDocFunc(n)
         local myEvent
         if n.args[eventIndex] then
+            if eventMap and myIndex > eventIndex then
+                -- if call param has literal types, then also check if function def param has literal types
+                -- 1. has no literal values => not enough info, thus allowed by default
+                -- 2. has literal values and >= 1 matches call param's literal types => allowed
+                -- 3. has literal values but none matches call param's literal types => filtered
+                local myEventMap = vm.getLiterals(n.args[eventIndex])
+                if myEventMap then
+                    local found = false
+                    for k in pairs(eventMap) do
+                        if myEventMap[k] then
+                            -- there is a matching literal
+                            found = true
+                            break
+                        end
+                    end
+                    if not found then
+                        return
+                    end
+                end
+            end
             local argNode = vm.compileNode(n.args[eventIndex])
             myEvent = argNode:get(1)
         end

script/vm/type.lua

@@ -615,6 +615,7 @@ end
 ---@return vm.node?
 function vm.getTableValue(uri, tnode, knode, inversion)
     local result = vm.createNode()
+    local inferSize = config.get(uri, "Lua.type.inferTableSize")
     for tn in tnode:eachObject() do
         if tn.type == 'doc.type.table' then
             for _, field in ipairs(tn.fields) do
@@ -657,7 +658,7 @@ function vm.getTableValue(uri, tnode, knode, inversion)
                 end
                 if  field.type == 'tableexp'
                 and field.value
-                and field.tindex == 1 then
+                and field.tindex <= inferSize then
                     if inversion then
                         if vm.isSubType(uri, 'integer', knode) then
                             result:merge(vm.compileNode(field.value))

test/completion/common.lua

@@ -3138,6 +3138,44 @@ emit.on(emit, 'won', <??>)
     }
 }
 
+TEST [[
+--- @alias event.AAA "AAA"
+--- @alias event.BBB "BBB"
+
+--- @class Emit
+--- @field on fun(self: Emit, eventName: string, cb: function)
+--- @field on fun(self: Emit, eventName: event.AAA, cb: fun(i: integer))
+--- @field on fun(self: Emit, eventName: event.BBB, cb: fun(s: string))
+local emit = {}
+
+emit:on('AAA', <??>)
+]]
+{
+    [1] = {
+        label    = 'fun(i: integer)',
+        kind     = define.CompletionItemKind.Function,
+    }
+}
+
+TEST [[
+--- @alias event.AAA "AAA"
+--- @alias event.BBB "BBB"
+
+--- @class Emit
+--- @field on fun(self: Emit, eventName: string, cb: function)
+--- @field on fun(self: Emit, eventName: event.AAA, cb: fun(i: integer))
+--- @field on fun(self: Emit, eventName: event.BBB, cb: fun(s: string))
+local emit = {}
+
+emit:on('BBB', <??>)
+]]
+{
+    [1] = {
+        label    = 'fun(s: string)',
+        kind     = define.CompletionItemKind.Function,
+    }
+}
+
 TEST [[
 local function f()
     local inferCache

test/signature/init.lua

@@ -373,6 +373,40 @@ t:event("onTimer", <??>)
 '(method) (ev: "onTimer", <!t: integer!>)',
 }
 
+TEST [[
+---@alias event.onChat "onChat"
+---@alias event.onTimer "onTimer"
+
+---@class A
+---@field event fun(self: self, ev: event.onChat, c: string)
+---@field event fun(self: self, ev: event.onTimer, t: integer)
+
+---@type A
+local t
+
+t:event("onChat", <??>)
+]]
+{
+'(method) (ev: "onChat", <!c: string!>)',
+}
+
+TEST [[
+---@alias event.onChat "onChat"
+---@alias event.onTimer "onTimer"
+
+---@class A
+---@field event fun(self: self, ev: event.onChat, c: string)
+---@field event fun(self: self, ev: event.onTimer, t: integer)
+
+---@type A
+local t
+
+t:event("onTimer", <??>)
+]]
+{
+'(method) (ev: "onTimer", <!t: integer!>)',
+}
+
 local config = require 'config'
 config.set(nil, "Lua.type.inferParamType", true)