LuaLS / LuaLS/lua-language-server

Reassigning nullable in if block

Open
#1,664 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement feat/type check
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

After cheking for null in IF block, variable should return not null.

Actual Behaviour

After cheking for null in IF block, variable returns nullable value, so it causes warning

solution: check in two if blocks or use --[[@as not_nullable_type]]

Reproduction steps

---@class Mclass
local var1= {
---@type number?
var2 = nil,
}

---@param number
local function fun1(var2) end


if var1 and var1.var2 then
local var2= var1.var2
fun1(var2) --Cannot assign number? to parameter number.
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 using the Visual Studio Code extension and inspect the type-checking behavior around the nullable field inside the if block. Confirm the reported warning and trace how the checked value is typed when assigned to the local variable. Done means the narrowing is preserved so passing that variable to the number parameter no longer reports a nullable-type warning.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.