LuaLS / LuaLS/lua-language-server

Is it possible to implement support for this type of overload?

Open
#2,342 2 comments 1 reaction 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?

Windows

### What is the issue affecting?

Type Checking

### Expected Behaviour

![image](https://github.com/LuaLS/lua-language-server/assets/57856647/a57d90fe-d2ad-485e-96d2-b299cf9dfde6)

### Actual Behaviour

![image](https://github.com/LuaLS/lua-language-server/assets/57856647/0af575e7-ca71-4b31-8922-b45af75aaa20)

### Reproduction steps

```lua
---@class Position
---@field x number
---@field y number
---@field z number
Position = {};

---@param x number
---@param y number
---@return number
---@overload fun(self:Position, pos: Position): number
function Position:GetExactDist2dSq(x, y)
if type(x) == "table" then
return self:GetExactDist2dSq(x.x, x.y);
end
local dx = x - self.x;
local dy = y - self.y;
return dx*dx + dy*dy;
end

```

### 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 reproduction in the issue and compare the expected and actual type-checking behavior shown in the screenshots. Trace the language server's overload handling for GetExactDist2dSq; done means both the numeric-argument form and the Position-argument overload type-check correctly.

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
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.