LuaLS / LuaLS/lua-language-server

Infer the type of the returned expression from the return type declaration

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

还没有人认领这个 Issue。

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

描述

The situation:

---@class Test
---@field foo number

---@return Test
local function test()
    return {
        foo = 'this is not a number!',
    }
end

The code passes as valid when in reality the field is assigned a wrong type of value.

Right now the workaround is to do

---@class Test
---@field foo number

---@return Test
local function test()
    ---@type Test
    return {
        foo = 'this is not a number!',
    }
end

which to me feels like belaboring the obvious. Would be great if LuaLS assumed this automatically.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先,在本地 language-server 环境中复现 Lua 代码片段,并检查表类型推断期间如何处理返回类型声明。当声明的 Test 返回类型能够在没有额外 @type 注解的情况下诊断出分配给 foo 的错误字符串,同时现有解决方法仍然有效时,此更改即完成。

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

评估

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

把新 issue 发到你的邮箱

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