LuaLS / LuaLS/lua-language-server

[Feature request]: Add ability to define enums without setting variable

Offen
#1,932 14 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
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?

NeoVim

Which OS are you using?

Linux

What is the issue affecting?

Annotations

Expected Behaviour

Enum fields are defined and shown when hovering over the variable they are assigned to.

Actual Behaviour

Not all enum fields are picked up. The fields that are picked up are displayed as unknown.

Reproduction steps

Not needed for a feature request.

Additional Notes

When using Neovim, the standard library that comes with it is defined in files which use any a lot. An issue that I have ran into when trying to define an enum for a table that looks like the following is that it just won't work.

Table I am trying to define (this is what is show when hovering):

vim.log.levels: {
    TRACE: integer = 0,
    DEBUG: integer = 1,
    INFO: integer = 2,
    WARN: integer = 3,
    ERROR: integer = 4,
    OFF: integer = 5,
}

I have tried a couple of ways to define an enum to cover this:

-- Method 1
---@enum LogLevels
---| '0'
---| '1'
---| '2'
---| '3'
---| '4'
---| '5'

-- Method 2
---@enum LogLevels
---| TRACE = '0'
---| DEBUG = '1'
---| INFO = '2'
---| WARN = '3'
---| ERROR = '4'
---| OFF = '5'

-- Method 3
---@enum LogLevels
---| TRACE: 0
---| DEBUG: 1
---| INFO: 2
---| WARN: 3
---| ERROR: 4
---| OFF: 5

-- Method 4
---@enum LogLevels
---| TRACE: integer = 0 # Trace level
---| DEBUG: integer = 1 # Debug level
---| INFO: integer = 2 # Info level
---| WARN: integer = 3 # Warn level
---| ERROR: integer = 4 # Error level
---| OFF: integer = 5 # Off level

And then, when trying to set the variable to the enum vim.log.levels, I have done a couple of things as well:

-- Method 1
---@type LogLevels
M.levels = vim.log.levels --[=[@as LogLevels]=]

-- Method 2
---@type LogLevels
local tmp_levels = vim.log.levels --[=[@as LogLevels]=]
---@type LogLevels
M.levels = tmp_levels

When doing any of these, if I hover over M.levels only 3 of the fields are shown:

(field) M.levels: LogLevels {
    ERROR: unknown,
    INFO: unknown,
    WARN: unknown,
}

I am aware that the following can be done to do something similar.
However, I would like to be able to add descriptions to fields and I would like to not see a table literal in the inlayhints.
Also, this won't work as a parameter type for a function because it would expect a table literal instead of an enum field.

This works for type declaration:

---@alias LogLevels { TRACE: 0, DEBUG: 1, INFO: 2, WARN: 3, ERROR: 4, OFF: 5 }

---@type LogLevels
M.levels = vim.log.levels
Log File

Not needed for a feature request.

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 damit, die Beispiele für enum-Deklarationen und -Zuweisungen in einem Neovim/Lua-language-server-Setup nachzustellen, und verfolge dann, wie @enum-Annotationen, Typzuweisungen und die Hover-Ausgabe verarbeitet werden. Als erledigt gilt die Aufgabe, wenn enums deklariert werden können, ohne einer Variable zugewiesen zu werden, benannte Felder und Beschreibungen beibehalten und als Typ von vim.log.levels und Funktionsparametern funktionieren.

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

Neue Issues direkt in Ihr Postfach

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