LuaLS / LuaLS/lua-language-server

Inconsistent Go To Definition Behavior

Abierto
#2,839 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza con los fragmentos de Lua del issue y reproduce Go To Definition en la extensión de Visual Studio Code en Windows, comparando declaraciones inline y entre archivos. Sigue por qué el campo t se resuelve en builtin.lua, mientras que a y s se resuelven de forma diferente. Se considera terminado cuando la navegación a campos de tabla llega de forma coherente a la anotación de tipo relevante o evita la definición de la tabla builtin, con cobertura de regresión para ambos ejemplos.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.