LuaLS / LuaLS/lua-language-server

An annotation for indicating that a function may error

Offen
#2,400 0 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

It would be pretty useful to have an indicator of whether the function may error (and thus needs to be handled with pcall or the like).

---@fallible
---@param bar string
---@return string bar
local function assert_is_foobar(bar)
    if bar ~= "foobar" then
        error("bar isn't equal to foobar")
    end
    return bar
end

I'm aware of #1881 but it doesn't fullfill the same purpose as @fallible, the main difference being the fact that @noreturn indicates that the function never returns while this indicates that the function could return an error

The LSP server could also potentially show the user a warning if they don't wrap a @fallible function in a pcall call

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie damit, zu prüfen, wie der Language Server derzeit die verwandte Annotation @noreturn behandelt und wie er die Verwendung von pcall analysiert. In der Issue werden weder Dateien noch Tests genannt, und das beabsichtigte Warnverhalten wird als optional beschrieben; daher müssen der Implementierungsumfang und die Abschlusskriterien vor dem Codieren geklärt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.