LuaLS / LuaLS/lua-language-server
Annotations in inline comments do not recognize others on the same line
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
### How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
### Which OS are you using?
Linux
### What is the issue affecting?
Annotations, Type Checking
### Expected Behaviour
Placing multiple annotations in inline comments like so works fine: the generics are interpreted correctly.
```lua
--[[@generic C]]
--[[@param any C]]
--[[@return C]]
local function exampleGeneric(any) return any end
```
So one would expect grouping them together on the same line (like this) would also work:
```lua
--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
### Actual Behaviour
In the previous example, the generic seems to be defined, but doesn't carry over properly to the other two annotations. Similarly, adding a line break between the first and second annotation like this
```lua
--[[@generic C]]
--[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
allows the generic to be recognized by the second annotation, but not the third. This behavior is also visible in other annotations that require others to be nearby, such as with classes and fields, and aliases.
### Reproduction steps
1. Open VSCode
2. Paste either of the following examples into an empty lua file:
```lua
--[[@class amazingClass]] --[[@field field1 string]] --[[@field field2 number]]
```
```lua
--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
### Additional Notes
While I realize there is little practical use for some of these cases, such as the class definition (as it starts to take up a lot of horizontal space really quickly when defining new fields), this is especially useful when creating a plugin that allows for inline annotation definitions like the following:
```lua
local width: integer, height: integer = screen.width, screen.height
local logo: love.Image = textures["logo.png"]
```
which generates inline comments like so in order to preserve syntax coloring, as well as line numbers during runtime:
```lua
local width --[[@type integer ]], height --[[@type integer ]] = screen.width, screen.height
local logo --[[@type love.Image ]] = textures["logo.png"]
```
### Log File
_No response_
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
Reproduza o problema no VSCode usando os exemplos de anotações inline de Lua do relatório e, em seguida, compare anotações divididas entre várias linhas com várias anotações em uma única linha. Rastreie como o language server associa anotações relacionadas, como genéricos, parâmetros, retornos, classes, campos e aliases; considera-se concluído quando as anotações na mesma linha são interpretadas de forma consistente com as anotações em linhas separadas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- lua
- Domínio
- devtools
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100