LuaLS / LuaLS/lua-language-server
Best way to implement something like an abstract base class?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
I'm working on a framework where users of it implement a kind of module that mixes their provided logic with some optional event handlers.
Here is a simple example
-- provided by framework
---@class Base
---@field OnClick fun(self: Base, x: number, y: number)
local base = {}
---@generic T: Base
---@param name `T`
---@return T
function New(name)
return setmetatable({}, {__index = base})
end
-- usage of framework by user
---@class MyImpl: Base
local foo = New("MyImpl")
function foo:OnClick(x, y) -- x and y are inferred as any instead of number :(
end
function foo:myHelperFunction()
end
So I expect the user to implement OnClick and fill it with their logic. My goal here is that the user automatically gets the correct types on the parameters for foo:OnClick. Here in this simple example it's just two numbers, but my real app has like > 10 such methods and some of these take complex types as parameters.
With the code above it doesn't know anything about the parameters in OnClick and shows them as any. Maybe I got something wrong with the generics, but even without all the fancy generic stuff (just @return base on New) it's the same problem.
The only work-around I found was to not use @class on the user-defined class and not define a generic, this makes the parameters on the OnCLick function definition correct! However, it now triggers injected-field on all user-defined values not defined in the base class like the myHelperFunction method :(
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das annotierte Lua-Beispiel aus Issue #2453 reproduzieren und untersuchen, wie der Language Server mit generischen Rückgabewerten, geerbten Methoden und vom Benutzer hinzugefügten Feldern umgeht. Als abgeschlossen gilt die Aufgabe, wenn überschriebene OnClick-Parameter als number inferiert werden, während benutzerdefinierte Methoden wie myHelperFunction keine Diagnosen zu injizierten Feldern erzeugen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- developer-experience, devtools
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100