LuaLS / LuaLS/lua-language-server

Unexpected repeated alias expanding 类型别名错误地重复展开

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

Nadie ha tomado este issue todavía.

bug
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?

Hover

Expected Behaviour

hover.expandAliasfalse时,如下标注
Set hover.expandAlias to false, and do annotations like this:

---while `hover.expandAlias` is `false`
---@alias T string | [T, T]

当鼠标置于[T, T]中的任意一个T时,应为(alias) T 展开为 string | [T, T]
When the mouse is placed on one T of [T, T], it should be expanded to (alias) T 展开为 string | [T, T]

Actual Behaviour

如图所示
As is seen:
image

对于任何一个出现了多于一次递归引用的别名,都会这样
For any alias that has more than one recursive reference, this will be the case:
image

单次递归引用,或者是简单得没有意义的别名,则不会发生
A single recursive reference, or a simply meaningless alias, will not be with glitches:
image
image

此外,若hover.expandAliastrue,展开的效果非常惊悚
In addition, if hover. extpandAlias is set to true, the effect is very frightening:
image

Reproduction steps
---while `hover.expandAlias` is `true`
---@alias S string | [S] | [S, S]


---while `hover.expandAlias` is `false`
---@alias T string | [T, T]


---while `hover.expandAlias` is `false`
---@alias U string | {msg: U} | {err: U}


---while `hover.expandAlias` is `false`
---@alias V string | V[]


---while `hover.expandAlias` is `false`
---@alias W {[string]: W} | W[]
Additional Notes

我查阅了一下代码,做出一种猜想:

getInfer时的compileNode错误地使用了先前已缓存的节点(其并未标记这是一个不应该展开的别名),在_eraseAlias发挥效用前就展开了这个别名,并没有经过hover.expandAlias的判断,未在_drop集合中附上标注。这也是在单次使用递归时不会触发 bug 但两次使用递归就会触发的原因。

I looked up the code and made a guess:

When using getInfer, the compileNode mistakenly used a previously cached node which was not marked as an alias that should not be expanded. Without going through the judgment of hover.expandAlias, it expanded the alias before _eraseAlias takes into effect, which failed in marking in _drop set. This is the reason why it will not cause glitch when using recursion once, but only when using recursion twice.

作为本仓库的贡献者之一,我非常乐意协助这个 bug 的修复。但这个 bug 似乎太底层,有点超出我力所能及的范围了。故我提交本次 Issue,抛砖引玉一下。

As one of the contributors to this repository, I am more than happy to assist in fixing this glitch. But this glitch seems too fundamental for me to fix. So I am here to submit this issue for further discussion.

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

Comienza con getInfer y _eraseAlias en script/vm/infer.lua y, después, inspecciona compileNode en script/vm/compiler.lua, tal como se identifica en el informe. Reproduce el comportamiento del hover con los alias recursivos S, T, U, V y W mientras alternas hover.expandAlias. Se considera terminado cuando los alias recursivos ya no se expanden repetidamente y la salida del hover coincide con la expansión única esperada.

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
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.