Merge pull request #3251 from f-ell/fix/signature-tuple-parameters

fix: incorrect generation of function signatures with tuple parameters

Author: sumneko

changelog.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
+* `FIX` Incorrect generation of function signatures with tuple-parameters
 * `NEW` Doc output now contains file paths for `@alias` and `@enum` types
 * `FIX` Typos in a few error messages.
 * `FIX` Incorrect inject-field message for extra table field in exact class

script/core/signature.lua

@@ -63,7 +63,11 @@ local function makeOneSignature(source, oop, index)
         : gsub('%b{}', function (str)
             return ('_'):rep(#str)
         end)
-        : gsub('[%[%]%(%)]', '_')
+        : gsub ('%b[]', function (str)
+            return ('_'):rep(#str)
+        end)
+        : gsub('[%(%)]', '_')
+
     for start, finish in converted:gmatch '%s*()[^,]+()' do
         i = i + 1
         params[i] = {

test/signature/init.lua

@@ -234,6 +234,39 @@ end)(<??>)
 ]]
 {'function (<!a: any!>, b: any)'}
 
+TEST [[
+---@param a [any, any]
+---@param b any
+function X(a, b) end
+
+X({ 1, 2 }, <?3?>)
+]]
+{
+'function X(a: [any, any], <!b: any!>)'
+}
+
+TEST [[
+---@param a any
+---@param b [any, any]
+---@param c any
+function X(a, b, c) end
+
+X(1, { 2, 3 }<??>, 4)
+]]
+{
+'function X(a: any, <!b: [any, any]!>, c: any)'
+}
+
+TEST [[
+---@param a [table<any>, {[1]:any,[2]:any}]
+function X(a) end
+
+X({ { 1 }, { 2, 3 } }<??>)
+]]
+{
+'function X(<!a: [table<any>, { [1]: any, [2]: any }]!>)'
+}
+
 TEST [[
 ---@overload fun()
 ---@overload fun(a:number)