LuaLS / LuaLS/lua-language-server

Multiple return values for fields

Aperta
#2,357 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feat/LuaCats Annotations
Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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

### Expected Behaviour

The ability to define multiple return values for a field annotation.

### Actual Behaviour

Any non-identifier symbol following a type is treated as a comment or a break.

### Reproduction steps

1. Create a field with a comma separated return type.
2. See that anything following the comma is treated as a comment.

### Additional Notes

```lua
---@class Color
---@field [string] Color,string
Color = {}
```
`,string` is highlighted as a comment.
```lua
---@class Color
---@field [string] Color, string
Color = {}
```
`,` is highlighted as a symbol, ` string` is highlighted as a comment.

---
An example of fields with multiple return types are the named color lookups in the Tabletop Simulator API:
https://api.tabletopsimulator.com/color/#colorblue

```lua
local color, name = Color.Blue
print(color) -- Color: Blue { r = 0.118, g = 0.53, b = 1, a = 1 }
print(name) -- Blue

local color, name = Color.Red
print(color) -- Color: Red { r = 0.856, g = 0.1, b = 0.094, a = 1 }
print(name) -- Red
```

### Log File

_No response_

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

Inizia riproducendo il comportamento del parser delle annotazioni con gli snippet Lua forniti, concentrandoti su come vengono tokenizzati i tipi separati da virgole dopo una dichiarazione @field. Il lavoro è completo quando più tipi restituiti, come Color,string, vengono riconosciuti come tipi di annotazione invece di trattare il resto come un commento; aggiungi o aggiorna la copertura se il repository contiene test rilevanti del parser.

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

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Bug
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.