LuaLS / LuaLS/lua-language-server

Request to allow mutiline `@type` values

Open
#2,200 2 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Sometimes, a `@type` value can be very long, i.e.

```lua
---@type {filepath: string?, type: 'unknown'|'binary'|'stock'|'path', loader: function}
```

Of course, while I could clean-up the above by replacing `type` with its own alias, I still think it would be nice to be able to do this:

```lua
---@type {
--- filepath: string?,
--- type: 'unknown'|'binary'|'stock'|'path',
--- loader: function
---}
```

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

The issue provides no file or test entry point. Start by locating the annotation handling for @type values, then add coverage for the shown multiline form and confirm that its structured type is parsed the same way as the single-line form.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.