ignore varargs

if a function only has varargs and has `---@overload`, the varargs will be ignored

resolve #1641

Author: sumneko

changelog.md

@@ -36,6 +36,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.
   * `redundant-return-value`
   * `return-type-mismatch`
 * `CHG` workspace-symbol: supports chain fields based on global variables and types. try `io.open` or `iolib.open`
+* `CHG` [#1641] if a function only has varargs and has `---@overload`, the varargs will be ignored
 * `FIX` [#1567]
 * `FIX` [#1593]
 * `FIX` [#1595]
@@ -59,6 +60,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.
 [#1608]: https://github.com/sumneko/lua-language-server/issues/1608
 [#1626]: https://github.com/sumneko/lua-language-server/issues/1626
 [#1637]: https://github.com/sumneko/lua-language-server/issues/1637
+[#1641]: https://github.com/sumneko/lua-language-server/issues/1641
 [#1642]: https://github.com/sumneko/lua-language-server/issues/1642
 
 ## 3.5.6

script/core/completion/completion.lua

@@ -315,7 +315,7 @@ local function checkLocal(state, word, position, results)
                 return orders[a] < orders[b]
             end)
             for _, def in ipairs(defs) do
-                if def.type == 'function'
+                if (def.type == 'function' and not vm.isVarargFunctionWithOverloads(def))
                 or def.type == 'doc.type.function' then
                     local funcLabel = name .. getParams(def, false)
                     buildFunction(results, source, def, false, {
@@ -490,7 +490,7 @@ end
 local function checkFieldThen(state, name, src, word, startPos, position, parent, oop, results)
     local value = vm.getObjectFunctionValue(src) or src
     local kind = define.CompletionItemKind.Field
-    if value.type == 'function'
+    if (value.type == 'function' and not vm.isVarargFunctionWithOverloads(value))
     or value.type == 'doc.type.function' then
         if oop then
             kind = define.CompletionItemKind.Method
@@ -572,9 +572,11 @@ local function checkFieldOfRefs(refs, state, word, startPos, position, parent, o
             local value = vm.getObjectFunctionValue(src) or src
             if value.type == 'function'
             or value.type == 'doc.type.function' then
-                funcLabel = name .. getParams(value, oop)
-                fields[funcLabel] = src
-                count = count + 1
+                if not vm.isVarargFunctionWithOverloads(value) then
+                    funcLabel = name .. getParams(value, oop)
+                    fields[funcLabel] = src
+                    count = count + 1
+                end
                 if value.type == 'function' and value.bindDocs then
                     for _, doc in ipairs(value.bindDocs) do
                         if doc.type == 'doc.overload' then

script/core/hover/init.lua

@@ -60,8 +60,12 @@ local function getHover(source)
             if guide.isOOP(def) then
                 oop = true
             end
-            if def.type == 'function'
-            or def.type == 'doc.type.function' then
+            if  def.type == 'function'
+            and not vm.isVarargFunctionWithOverloads(def) then
+                hasFunc = true
+                addHover(def, true, oop)
+            end
+            if def.type == 'doc.type.function' then
                 hasFunc = true
                 addHover(def, true, oop)
             end

script/core/signature.lua

@@ -137,7 +137,7 @@ local function makeSignatures(text, call, pos)
     node = node:getData 'originNode' or node
     local mark = {}
     for src in node:eachObject() do
-        if src.type == 'function'
+        if (src.type == 'function' and not vm.isVarargFunctionWithOverloads(src))
         or src.type == 'doc.type.function' then
             if not mark[src] then
                 mark[src] = true

script/vm/doc.lua

@@ -112,6 +112,13 @@ local function getDeprecated(value)
             end
         end
     end
+    if value.type == 'function' then
+        local doc = getDeprecated(value.parent)
+        if doc then
+            value._deprecated = doc
+            return doc
+        end
+    end
     value._deprecated = false
     return nil
 end

script/vm/function.lua

@@ -218,7 +218,7 @@ function vm.getMatchedFunctions(func, args, mark)
     local funcs = {}
     local node = vm.compileNode(func)
     for n in node:eachObject() do
-        if n.type == 'function'
+        if (n.type == 'function' and not vm.isVarargFunctionWithOverloads(n))
         or n.type == 'doc.type.function' then
             funcs[#funcs+1] = n
         end
@@ -243,3 +243,26 @@ function vm.getMatchedFunctions(func, args, mark)
         return matched
     end
 end
+
+---@param func table
+---@return boolean
+function vm.isVarargFunctionWithOverloads(func)
+    if func.type ~= 'function' then
+        return false
+    end
+    if not func.args then
+        return false
+    end
+    if func.args[1].type ~= '...' then
+        return false
+    end
+    if not func.bindDocs then
+        return false
+    end
+    for _, doc in ipairs(func.bindDocs) do
+        if doc.type == 'doc.overload' then
+            return true
+        end
+    end
+    return false
+end

test/completion/common.lua

@@ -3847,3 +3847,60 @@ print(t2.A.<??>)
         kind     = define.CompletionItemKind.Field,
     },
 }
+
+TEST [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+local function fff(...)
+end
+
+fff<??>
+]]
+{
+    {
+        label    = 'fff(x)',
+        kind     = define.CompletionItemKind.Function,
+    },
+    {
+        label    = 'fff(x, y)',
+        kind     = define.CompletionItemKind.Function,
+    },
+}
+
+TEST [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+function fff(...)
+end
+
+fff<??>
+]]
+{
+    {
+        label    = 'fff(x)',
+        kind     = define.CompletionItemKind.Function,
+    },
+    {
+        label    = 'fff(x, y)',
+        kind     = define.CompletionItemKind.Function,
+    },
+}
+
+TEST [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+function t.fff(...)
+end
+
+t.fff<??>
+]]
+{
+    {
+        label    = 'fff(x)',
+        kind     = define.CompletionItemKind.Function,
+    },
+    {
+        label    = 'fff(x, y)',
+        kind     = define.CompletionItemKind.Function,
+    },
+}

test/crossfile/hover.lua

@@ -1606,3 +1606,41 @@ someType:
     | "#" -- description
 ```]]
 }
+
+TEST { { path = 'a.lua', content = [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+local function <?f?>(...)
+end
+]] },
+hover = [[
+```lua
+function f(x: number)
+```
+
+---
+
+```lua
+function f(x: number, y: number)
+```]]
+}
+
+TEST { { path = 'a.lua', content = [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+local function f(...)
+end
+
+<?f?>
+]] },
+hover = [[
+```lua
+function f(x: number)
+```
+
+---
+
+```lua
+function f(x: number, y: number)
+```]]
+}

test/signature/init.lua

@@ -316,3 +316,16 @@ X({}, <??>)
 {
 'function X(a: { x: number, y: number, z: number }, <!b: string!>)'
 }
+
+TEST [[
+---@overload fun(x: number)
+---@overload fun(x: number, y: number)
+local function f(...)
+end
+
+f(<??>)
+]]
+{
+'function f(<!x: number!>)',
+'function f(<!x: number!>, y: number)',
+}