LuaLS / LuaLS/lua-language-server

@constraint Annotation for types/aliases

Aperta
#1,896 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

I was working with Annotations for documenting my code and wanted to add a warning if the user used a function that didn't fall under a specific pattern (`"0x%x%x%x%x%x%x%x%x"`) and tried finding a workaround. I'm not 100% fluent with .lua and don't have the confidence to PR, so take my idea instead.

My idea for the annotation would be as follows:
```lua
--- @constraint con_color (string.find(T , "^0x%x%x%x%x%x%x%x%x$") or string.find(T , "^%x%x%x%x%x%x$"))
--- @alias color string
--- @param col1 color
--- @param col2 color
local function set_col(col1, col2)
...
end
```

Obviously syntax could use work, but the basic idea would be to add a constraint, and have `T` or whatever variable name be the entry. This way you can give a warning to users about unsupported string or a number being too low/high being used. If there is already something like this please enlighten me as I couldn't find anything

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 esaminando la gestione esistente delle annotazioni per @alias e @param nel language server, poiché l’issue non indica file o test specifici. Determina come una sintassi @constraint proposta potrebbe convalidare gli alias e produrre avvisi, quindi definisci la sintassi e il comportamento previsto prima dell’implementazione; il lavoro è completo quando i vincoli documentati funzionano per l’esempio del colore e i valori non validi vengono diagnosticati.

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

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.