LuaLS / LuaLS/lua-language-server

@generic return ignores question mark

Open
#2,439 0 comments 0 reactions 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

Type of y in example below is integer?

Actual Behaviour

Type of y in example below is integer

Reproduction steps
---@generic T
---@param test T
---@return T?
function Func(test)
end

--- @return integer?
function Func2()
end

local x = 0
local y = Func(x)
local z = Func2()
Additional Notes

T | nil works as a workaround.
image

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

Reproduce the Lua snippet in the Visual Studio Code extension and inspect the inferred types for y and z, comparing T? with the T | nil workaround. Done means the generic @return T? preserves nil so y is integer?, while the existing Func2 result remains integer?.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, vscode
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.