LuaLS / LuaLS/lua-language-server
@overload does not cooperate with @alias
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?
Windows
### What is the issue affecting?
Annotations, Diagnostics/Syntax Checking
### Expected Behaviour
When I define an @alias, an @overload command should be able to use it.
### Actual Behaviour
I receive the error:
```
`fun` expected. Lua Syntax Check.(luadoc-miss-fun-after-overload)
```
### Reproduction steps
```
---@alias what fun():"ok"
---@class huh
---@overload what
local huh = {}
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Lua documentation annotation handling for @alias and @overload, using the reproduction in the issue as the first case to run. Trace why @overload what produces the luadoc-miss-fun-after-overload diagnostic. Done means the alias-based overload is accepted without that diagnostic while existing overload syntax remains valid.
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
- 45/100