LuaLS / LuaLS/lua-language-server

@overload fun

Open
#1,769 1 comment 1 reaction 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

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?

Completion

Expected Behaviour

Parameter Code Completion does not work when the constructor is defined.
image

Actual Behaviour

Missing Code Completion for the overload

Reproduction steps

---@class ABC.Parameter
---@field public a number
---@field public b number

---@class ABC
---@overload fun(tParameters?:ABC.Parameter):ABC
local a = {}

---@param tParameters ABC.Parameter
function a:new(tParameters)
local o = {}
setmetatable(o, self)
self.__index = self
return o
end

---@type ABC
local a

a({})
a:new({})

Additional Notes

No response

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

Start with the Lua-language-server completion handling for the reproduced constructor and @overload declarations. Run the provided Lua snippet in the Visual Studio Code extension on Windows, then trace how parameter completion is resolved for a constructor defined with @overload. Done means completion works for both a({}) and a:new({}) as shown in the reproduction.

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.