LuaLS / LuaLS/lua-language-server

Ability to mark default constructor names for resolving return type

未關閉
#2,331 0 則留言 2 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Lua
星號
4.4k
分支
442
PR 合併指標
30 天內沒有已合併 PR

描述

Hi!

A request to infer return value for default returns when calling a defined constructor function. EmmyLua supports this using a setting:
![image](https://github.com/LuaLS/lua-language-server/assets/4696942/662ffc29-e3ab-40e2-8592-4ff8d546a5ce)

Here it can infer that calling e.g. `:new()` on items marked with the `---@class` annotation will be returning an instance of that class.

This is especially useful when constructing classes using metatables in a generic class system, adding interfaces or inheritance functionality but still be able to denote the return type of calling the constructor method.

Example:

```
#class.lua

local definitions = {}

local Class = {}
function Class.class(name)
local definitions = {}

local def = definitions[name]
if not def then
def = {}
def.__class_name = class_name

def.new = function(self, ...)
local instance = {}

if instance.construct then
instance:construct(...)
end

return instance
end

setmetatable(instance, def)

def[class_name] = def
end

return class_definition
end
```

Example of using the class creation method
```
#my_class.lua

local Class = require "path/class"

local MyClass = Class("MyClass")
function MyClass:construct()
self._member = 0
end
```

Example of instantiating an instance of the class and showing the issue:
```
#example.lua

local MyClass = require "path/my_class"
local instance = MyClass:new() -- this line cannot find the function new() or deduce the return/type of "instance"
```

Here the instance of class return value from the `new()` function cannot be inferred and I haven't found a way to annotate this using luadocs with generics, alias, overload or other methods. This issue is somewhat related to #449 but I feel this warrants a retake on the proposed solution unless I am missing something?

A different way could be to allow explicit descriptors of the `@field` annotation to specify return value types in class definitions e.g.

![image](https://github.com/LuaLS/lua-language-server/assets/4696942/093f448d-18f3-472c-a275-a69be639593b)

The return values of functions defined in fields from a set metatable cannot have it's return type defined however it seems.

![image](https://github.com/LuaLS/lua-language-server/assets/4696942/688f56f3-1700-474f-86da-a889f2055446)

![image](https://github.com/LuaLS/lua-language-server/assets/4696942/4f94b87c-bacc-429f-b588-e9730515beca)

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

Start with the class.lua and example.lua scenarios in the issue, focusing on how the `---@class` annotation and `new()` call are resolved. Review the related discussion in issue #449 and the described `@field` alternative before choosing an approach. Done should include inferred constructor availability and the correct instance return type for the example.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
devtools
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。