LuaLS / LuaLS/lua-language-server

feature request: markdown field support in aliases

Aperta
#2,259 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

La issue non indica file né test. Inizia tracciando il parsing degli alias e confrontalo con la gestione esistente del Markdown di argomenti/dati descritta nel report; il lavoro è completato quando il Markdown nelle descrizioni degli alias viene renderizzato in modo coerente con le descrizioni degli argomenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.