LuaLS / LuaLS/lua-language-server

`need-check-nil` doesn't recognize nil check propagation

Offen
#1,997 3 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

MacOS

What is the issue affecting?

Diagnostics/Syntax Checking

Expected Behaviour

Ideally, need-check-nil would infer a nil check has been completed if I've already done that nil check earlier as part of a larger check. Specifically, the statement if not (a and a.b) then will properly register as a nil check on a, but assigning the inner expression to a local var prevents LLS from detecting it as a nil check.

Actual Behaviour

LLS warns need-check-nil when a variable cannot possibly be nil, if the check was masked via another variable.

Reproduction steps
---@return table?
local function stuff()
    return nil
end

local item = stuff()
local x = item and item.x
if not x then -- Works: `if not (item and item.x) then`
   -- This includes case where `item` is `nil` 
else
    local subitem = item.key -- Error on `item` (need-check-nil)
end
Additional Notes

No response

Log File

No response

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

Beginne damit, die need-check-nil-Diagnose in der Visual Studio Code-Erweiterung anhand des Lua-Beispiels im Issue zu reproduzieren, und verfolge anschließend die Logik zur Weitergabe des nil-checks der Diagnose. Als erledigt gilt die Aufgabe, wenn das Beispiel bei item.key keine Warnung mehr ausgibt, obwohl die frühere Prüfung über x bereits ausschließt, dass item nil ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua, vscode
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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