LuaLS / LuaLS/lua-language-server

Union table|class doesn't accept a generic table and only accepts a class instance (causing false missing-fields diagnostic)

Offen
#2,606 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### 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, Diagnostics/Syntax Checking

### Expected Behaviour

When a function is declared as accepting both `table` and a custom class type, it should accept getting passed a generic table.

### Actual Behaviour

LLS insists on a table matching the class being passed (with all the fields set) and reports the missing-fields diagnostic when passing a generic table.

### Reproduction steps

LLS definition file contains the following:
```lua
---@meta

---@class TestClass
---@field TestField number A test field in test class
TestClass = {}

-- TestFunction1
---@param generic_table_or_testclass_instance table|TestClass
function TestFunction1(generic_table_or_testclass_instance) end

-- TestFunction2
---@param generic_table table
---@param testclass_instance TestClass
---@overload fun(generic_table: table)
---@overload fun(testclass_instance: TestClass)
function TestFunction2(generic_table, testclass_instance) end

-- TestFunction3
---@param generic_table table
function TestFunction3(generic_table) end

-- TestFunction3
---@param testclass_instance TestClass
function TestFunction3(testclass_instance) end
```

And then a lua code file contains a call to either test function like
```lua
TestFunction1({1,2,3})
TestFunction2({1,2,3})
TestFunction3({1,2,3})
```
LLS reports `Missing required fields in type ``TestClass``: ``TestField`` Lua Diagnostics.(missing-fields)` for all 3 calls. Instead it should accept the table as input parameter for the 3 functions.

### Additional Notes

_No response_

### Log File

_No response_

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit Lua und den Typannotationen in der Reproduktion und verfolge dann den Typprüfpfad, der die Diagnose zu fehlenden Feldern für Union- und Overload-Parameter erzeugt. Als abgeschlossen gilt die Aufgabe, wenn generische Tabellen für alle drei Aufrufe akzeptiert werden, ohne TestClass.TestField als fehlend zu melden; im Issue werden keine Quelldateien oder Tests genannt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.