LuaLS / LuaLS/lua-language-server

Alias comments only show for strings and numbers

Abierto
#2,284 0 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

(Split from: https://github.com/LuaLS/lua-language-server/issues/2279)

Aliases have a feature where they can be multiline and you can write comments for different available values. However, this only works for string and numbers. For example in this code:

---@class TestClass

---@enum TestEnum
TestEnum = {
	TEST1 = 1,
	TEST2 = 2,
	TEST3 = 3,
}

---@alias TestAlias
---| 'TEST1' # TEST1 comment
---| 'TEST2' # TEST2 comment
---| 'TEST3' # TEST3 comment
---| TestClass # TestClass comment
---| TestEnum # TestEnum comment
---| TestEnum.TEST1 # TestEnum.TEST1 comment
---| 1 # TestNumber Comment

---@param test TestAlias
local function test(test)
end

test()

I get this
Screenshot_1

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

Reproduce el informe en LuaLS con el ejemplo de alias del issue y, a continuación, rastrea cómo se recopilan y muestran los comentarios de alias para valores de tipo string y numéricos. Comprueba el mismo comportamiento para TestClass, TestEnum y TestEnum.TEST1; se considera terminado cuando los comentarios aparecen para esos valores de alias igual que para strings y números.

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
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.