LuaLS / LuaLS/lua-language-server

Suggestion: Make `@param;@return` available as code action

Abierto
#2,517 0 comentarios 3 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

One really nice feature of the lua-lsp is that by typing --- above a function, we get the @param;@return suggestions which auto-inserts function annotation.

Would it be possible to make this feature available via code action as well? Right now, it takes a bit of repetitive work to get the annotations inserted. When at the function head: up, -. -, -, enter. By using a code action, this could be reduced to one hotkey (and depending on your editor, maybe one extra enter).

Another benefit would be that making this available as code action would increase the discoverability of this feature. For a while, I didn't know that this very useful feature even existed. By being a code action, it would be far easier to discover for new users.

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 rastreando las sugerencias existentes activadas por --- que insertan anotaciones @param y @return, y luego inspecciona dónde expone el servidor de lenguaje las acciones de código. Se considera terminado cuando la misma inserción de anotaciones está disponible mediante una acción de código y sigue siendo detectable en el encabezado de una función.

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

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 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.