LuaLS / LuaLS/lua-language-server
Request: Support `@field` in both enum and table definitions.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Request: Allow adding a field type to tables and enum definitions using the @field annotation.
This is useful for generating meta files from C code where there is no Lua table literal to copy.
See current behaviour below:
@class
✅ Using @field
---@class Foo
---@field myField 5
Foo = {}
✅ Using literal code
---@class Foo
Foo = {
myField = 5,
}
✅ Using type annotation
---@class Foo
Foo = {
---@type 5
myField = nil,
}
@enum
❌ Using field
---@enum Foo
---@field myField 5
Foo = {}
Error: The field must be defined after the class.Lua Diagnostics.(doc-field-no-class)
✅ Using literal code
---@enum Foo
Foo = {
myField = 5,
}
✅ Using type annotation
---@enum Foo
Foo = {
---@type 5
myField = nil,
}
Untyped table
❌ Using field
---@field myField 5
Foo = {}
Error: The field must be defined after the class.Lua Diagnostics.(doc-field-no-class)
✅ Using literal code
Foo = {
myField = 5,
}
✅ Using type annotation
Foo = {
---@type 5
myField = nil,
}
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
Beginne damit, die mit der Diagnose doc-field-no-class verbundene Verarbeitung von @field nachzuverfolgen; das Issue enthält Lua-Beispiele für @class, @enum und untypisierte Tabellen. Als erledigt gilt, wenn @field-Definitionen für Enum- und Tabellendefinitionen wie in den Beispielen ohne diese Diagnose funktionieren, während das bestehende Verhalten für Klassen weiterhin unterstützt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- devtools
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100