LuaLS / LuaLS/lua-language-server
overload type narrowing for returns
Nessuno ha ancora preso questa issue.
- 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?
Linux
What is the issue affecting?
Type Checking, Completion
Expected Behaviour
I am not sure this is a duplicate issue considering how common it probably is, but just to make sure.
Possibly a duplicate of https://github.com/LuaLS/lua-language-server/issues/1583.
This is similar to https://github.com/LuaLS/lua-language-server/issues/1146, but with returns instead of params.
It is a common pattern in Lua that on errors you might instead return a nil value to imply failure, along side an error message.
---@return table
---@overload fun(): nil, string
local function fetchX() end
local resource, fail = fetchX()
if not resource then
print(fail:sub(1, 3)) -- fail type here is expected to be "string"
end
Actual Behaviour
You get a warning on fail that it might possibly be nil. Because its type is string|nil.
---@return table
---@overload fun(): nil, string
local function fetchX() end
local resource, fail = fetchX()
if not resource then
print(fail:sub(1, 3) )-- fail type here is actually "string|nil"
end
Reproduction steps
- Copy the setup code
- follow along with the comments
Additional Notes
I believe narrowing down the types in this case is still possible? It seems to me like https://github.com/LuaLS/lua-language-server/issues/1583 was discussing the possibility of adding tuples, but shouldn't this be doable even without tuples support?
Log File
No response
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia riproducendo l'esempio di ritorno dell'overload nell'issue e analizza il comportamento del language server nel controllo dei tipi e nel completamento per il narrowing condizionale. Il payload non indica file o test del repository, quindi individua i punti di ingresso rilevanti per l'analisi degli overload e dei tipi di ritorno prima di apportare modifiche. Il lavoro è completato quando fail viene ristretto a string dopo aver verificato che resource è nil, senza l'avviso esistente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- devtools
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100