LuaLS / LuaLS/lua-language-server

Annotations in inline comments do not recognize others on the same line

Open
#3,350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### 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_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in VSCode using the inline Lua annotation examples from the report, then compare annotations split across lines with multiple annotations on one line. Trace how the language server associates related annotations such as generics, parameters, returns, classes, fields, and aliases; done means same-line annotations are interpreted consistently with separate-line annotations.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.