LuaLS / LuaLS/lua-language-server

Detect functions that never return (and @noreturn annotation)

Aperta
#1,881 4 commenti 5 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

Some functions, such as `error`, never return control to the caller. This can be used to prove that a value is not nil, for example:

```lua
function my_function(input)
local value = input.value or error('Missing value')
-- The following line would currently raise a "Needs nil check" warning
-- However, if it was nil at runtime, an error would have been raised and it would never get this far.
return value:sub(1, 3)
end
```

It's not just `error` that can cause this, however. A custom function could be written that never returns as well (the most obvious way is that the function unconditionally calls `error`, but there may be other ways involving coroutines or functions implemented in C). A `@noreturn` annotation could be used to indicate this, similar to `@nodiscard`.

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

Nell’issue non sono indicati né un file né un test. Inizia tracciando l’avviso del controllo di nil e la gestione esistente dell’annotazione @nodiscard, quindi determina come dovrebbero essere rappresentati i built-in che non restituiscono, le funzioni personalizzate e @noreturn; il lavoro è completato quando l’esempio non genera più l’avviso e il comportamento dell’annotazione è coperto.

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
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.