Skip to content

Generics don't expand alias types/don't work with other parameters #2355

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
checkraisefold opened this issue Oct 1, 2023 · 3 comments
Open

Comments

@checkraisefold
Copy link

checkraisefold commented Oct 1, 2023

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Type Checking

Expected Behaviour

With a code sample like this:

---@alias TestFunction fun(abc: string): integer

---@generic T
---@param name `T`
---@param func T
local function testSecond(name, func) end

testSecond("TestFunction", function(abc) end)

I would expect abc to have a type of string, and the function to be type checked and require a return.

Actual Behaviour

Instead, abc has the any type and the function requires no return.
I further tested with a different code sample:

---@alias TestFunction fun(abc: string): integer

---@generic T
---@param name `T`
---@return T
local function testSecond(name, func) return function(abc) end end

local cool = testSecond("TestFunction", function(abc) end)
cool()

This shows no warnings and does not require me to pass any arguments to cool(), which is incorrect. Hovering over cool provides a type of 'TestFunction' and does not show the full expanded type of the alias, unlike other variables with a type of an alias. That rings the same with this code sample I also tested:

---@alias TestFunction fun(abc: string): integer

---@generic T
---@param name `T`
---@param func fun(cool: T)
local function testSecond(name, func) end

testSecond("TestFunction", function(abc) end)

where hovering over abc provides me with a 'TestFunction' unexpanded type.
However, correct behavior is seen with the following code sample using the base string type;

---@alias TestFunction fun(abc: string): integer

---@generic T
---@param name `T`
---@param func fun(cool: T)
---@return T
local function testSecond(name, func) end

local cool = testSecond("string", function(abc) abc.cool = "hi" end)
local testfind = cool:find("test")

Autocomplete is provided for :find() and abc.cool = "hi" throws the correct warning for field injection.
And most confusing of all, this code sample behaves in line with expected behavior, and the alias is fully expanded.

---@alias TestFunction fun(abc: string): integer

---@generic T
---@param name `T`
---@param func fun(cool: T)
---@return T
local function testSecond(name, func) end

local cool = testSecond("TestFunction",
    ---@param abc TestFunction
    function(abc)
        abc()
    end
)

This also doesn't work, which I kind of expected. (no warnings)
image

Reproduction steps

  1. Paste code into project with Lua LSP on, see issue

Additional Notes

No response

Log File

No response

@checkraisefold
Copy link
Author

The title is most likely incorrect, by the way. not sure the exact issue going on here

@checkraisefold
Copy link
Author

I checked another test case with a class instead of an alias. It seems like generic capture parameters flat out don't work in anything other than an @return; they won't work with successive @parameters trying to use the generic type. They show in VSCode as the correct type (see the ---@param func fun(cool: T) example) but don't actually narrow to the type in question.

@mycroftjr
Copy link

see #1861

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants