LuaLS / LuaLS/lua-language-server
[Feature Request] @alias hover description / search for description
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
It would be really nice, to have a popup, when hovering over a `@alias`.
```
---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device
---@param side DeviceSide
local function checkSide(side) end
```
**Hover description**
eg:
```
checkSide("left")
```
when hovering over "left", display a popup with the text: `The left side of the device`
**Search for description**
When beginning to type:
```
checkSide(left side
```
it would be great, if the IntelliSense would show the entry `"left" -- The left side of the device`
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece rastreando como o servidor de linguagem lida com declarações @alias, informações de hover e sugestões de pesquisa do IntelliSense. Reproduza o exemplo DeviceSide e siga os caminhos existentes para passar o mouse sobre "left" e pesquisar por "left side". Está concluído quando tanto o pop-up de hover quanto a sugestão baseada em descrição funcionarem para entradas de alias.
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
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100