LuaLS / LuaLS/lua-language-server

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

未关闭
#2,355 3 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,在使用 LuaLS 的 Visual Studio Code Extension 中重现这些示例,重点关注泛型参数和 aliased function types 的类型检查。比较使用 TestFunction 的情况与使用基础 string 类型的情况。完成的标准是:别名能够一致地展开,回调参数能够获得预期类型,并且无效调用或缺少返回值时会产生警告。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。