LuaLS / LuaLS/lua-language-server

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

Aberta
#2,517 0 comentários 3 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Lua
Estrelas
4.4k
Forks
442
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece rastreando as sugestões existentes acionadas por --- que inserem as anotações @param e @return, depois inspecione onde o servidor de linguagem expõe as ações de código. Está concluído quando a mesma inserção de anotações estiver disponível por meio de uma ação de código e continuar sendo descoberta no cabeçalho de uma função.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
lua
Domínio
devtools
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.