LuaLS / LuaLS/lua-language-server

`---@cast` annotation doesn't respect scope rules

Offen
#2,761 3 Kommentare 0 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

### How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

### Which OS are you using?

Windows

### What is the issue affecting?

Type Checking

### Expected Behaviour

The `---@cast` annotation should respect Lua scoping rules.

### Actual Behaviour

Let's consider:
```lua
--- @class foo
--- @field a number

--- @class bar
--- @field b string

--- @type { [integer]: foo|bar }
local array = {}

for i, instance in ipairs(array) do
if instance.a then
-- First if block
--- @cast instance foo
end

if instance.b then
-- Second if block
end
end
```
In the first if block, we cast the `instance` to the `foo` type. When hovering over the `instance` variable in the second if block we can see its type is `foo`. It would be expected for its type to be `bar` since the `---@cast` happened in different scope.
![image](https://github.com/user-attachments/assets/8385fc37-2144-45d0-ab4f-71fbc76c578d)

### Reproduction steps

1. Copy-paste the given example code into your text editor.
2. Hover over the `instance` variable in the second if block.
3. See the error in the popup.

### 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, das Problem mit dem bereitgestellten Lua-Beispiel in der Visual Studio Code-Erweiterung zu reproduzieren, und untersuche, wie die Typprüfung die Gültigkeitsbereiche der beiden if-Blöcke behandelt. Als erledigt gilt die Aufgabe, wenn der Cast zu foo nur innerhalb des ersten Blocks gilt, während die Instanz im zweiten Block den passenden inferierten Typ statt foo behält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

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