LuaLS / LuaLS/lua-language-server

table literals with descriptions

Open
#2,128 14 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

I expect something like this or something similar to this to work but it doesn't
also when I e.g. split it up onto multiple lines
```lua
---@field cat { ["name"]: string # the name of the cat, ["age"]: integer # the age of the cat }
```
everything is working fine without the descriptions

Contributor guide

Open the contributing guide

Research direction

Reproduce the reported LuaLS annotation with a table literal containing field descriptions, including the multiline form. Start by tracing how this annotation is parsed; done means both the shown single-line and multiline forms are accepted without breaking the existing form without descriptions.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.