LuaLS / LuaLS/lua-language-server
Function Prototype Narrowing with nils
Open
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
Foo.Bar('Baz', 'Qux') -- **string**
Foo.Bar('Baz', nil) -- nil
Foo.Bar('Baz') -- nil
Foo.Bar(nil, 'Qux') -- nil
Foo.Bar(nil, nil) -- nil
Foo.Bar() -- nil
Actual Behaviour
Foo.Bar('Baz', 'Qux') -- **string|nil**
Foo.Bar('Baz', nil) -- nil
Foo.Bar('Baz') -- nil
Foo.Bar(nil, 'Qux') -- nil
Foo.Bar(nil, nil) -- nil
Foo.Bar() -- nil
Reproduction steps
---@param baz string|number
---@param qux string|number
---@return string
---@overload fun(text: string|number, title: nil):nil
---@overload fun(text: nil, title: string|number):nil
---@overload fun(text: nil, title: nil):nil
function Foo.Bar(baz, qux)
if not baz or not qux then
return nil
end
return 'SomeString'
end
Additional Notes
It seems to match the 'strings' can be nil
First input example
Last input example
Log File
No response
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 by running the Lua reproduction from the issue and compare the inferred return types for each argument combination. Trace the type-checking and overload-resolution paths involved in function prototypes, then add coverage for the expected narrowing behavior and verify that the non-nil overload resolves to string while the nil cases resolve to nil.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100