LuaLS / LuaLS/lua-language-server

@overload does not cooperate with @alias

Offen
#1,793 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement feat/LuaCats Annotations
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?

Annotations, Diagnostics/Syntax Checking

Expected Behaviour

When I define an @alias, an @overload command should be able to use it.

Actual Behaviour

I receive the error:

`fun` expected. Lua Syntax Check.(luadoc-miss-fun-after-overload)
Reproduction steps
---@alias what fun():"ok"

---@class huh
---@overload what
local huh = {}

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 der Verarbeitung der Lua-Dokumentationsannotationen für @alias und @overload und verwende dabei die Reproduktion im Issue als ersten auszuführenden Fall. Verfolge, warum @overload die Diagnose luadoc-miss-fun-after-overload erzeugt. Als erledigt gilt die Änderung, wenn der alias-basierte Overload ohne diese Diagnose akzeptiert wird und die bestehende Overload-Syntax weiterhin gültig bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 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.