LuaLS / LuaLS/lua-language-server

feature request: markdown field support in aliases

Offen
#2,259 0 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

Currently, when writing an alias such as:
```lua
---@alias fontmeta.alias.NameTableFormat
---| 0 # Always 0 for TrueType, OpenType accept it as well. See [OpenType Name Table Version 0](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-0).
---| 1 # Can only be 1 for OpenType. See [OpenType Name Table Version 1](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-1).
---| integer
```

The markdown of the description text (after the `#`) are not parsed as markdown:
![image](https://github.com/LuaLS/lua-language-server/assets/38175840/92be85a0-81d0-47c3-a260-66754d05b4d3)

Would be neat if the alias was parsed as multiple tags, similar to how it is done with arguments:
(the `data` argument)
![image](https://github.com/LuaLS/lua-language-server/assets/38175840/e6d5fab2-c1a1-41a6-aca0-638d51774a3c)

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

Das Issue nennt keine Dateien oder Tests. Beginne damit, das Parsen von Aliasen nachzuverfolgen, und vergleiche es mit der bestehenden Verarbeitung von Argument-/Daten-Markdown, die im Bericht beschrieben ist; abgeschlossen ist die Aufgabe, wenn Markdown in Alias-Beschreibungen konsistent mit Argument-Beschreibungen gerendert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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