LuaLS / LuaLS/lua-language-server
Inconsistent Go To Definition Behavior
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?
Windows
What is the issue affecting?
Type Checking
Expected Behaviour
Consider the following code:
---@class A
---@field t table<string, number>
---@field s string
---@class B
---@field a A
---@type B
local b = {
a = {
t = { x = 1 },
s = 'hi',
}
}
When you ctrl+click (or Go To Definition) on a inside the declaration of variable b, the cursor moves to ---@field a A in the type definition of class B. That's useful behavior. Similarly, when you do the same on s inside the nested a declaration, it goes to --@field s string in class A as expected.
When you click on t however (in t = { x = 1 }, it takes you to the builtin.lua meta file and places the cursor on the definition for tables @class table<K, V>: { [K]: V }. Not only is that behavior not consistent with the above, but it's also completely useless.
Another example (and probably different issue) is if you move the variable declaration to another file, like this:
File 1:
---@class A
---@field t table<string, number>
---@field s string
---@class B
---@field a A
File 2:
---@type B
local b = {
a = {
t = { x = 1 },
s = 'hi',
}
}
Now going to the definition of t still takes you to builtin.lua, but going to the definition of a, or s does nothing at all. I assume it's because it's treating their "definition" as the same line where they are declared in File 2.
Ideally I would like Go to Definition to do something useful inside table declarations and take me to the type annotation. But if that's not possible it should at least be consistent. In my opinion it should never take you to builtin.lua if there's another more suitable definition.
I think this worked fine in a previous version. I only started to see this behavior in the last few months.
Actual Behaviour
See above.
Reproduction steps
See above.
Additional Notes
No response
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 con gli snippet Lua nell’issue e riproduci Go To Definition nell’estensione Visual Studio Code su Windows, confrontando le dichiarazioni inline e tra file. Traccia il motivo per cui il campo t viene risolto in builtin.lua, mentre a e s vengono risolti diversamente. Il lavoro è completato quando la navigazione ai campi delle tabelle raggiunge coerentemente l’annotazione di tipo pertinente o evita la definizione della tabella builtin, con copertura di regressione per entrambi gli esempi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- devtools
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100