LuaLS / LuaLS/lua-language-server

Type narrowing breaks on equivalence to false.

Open
#3,287 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

When x is a boolean, if x == false then should identify x as false in its true block, and true in its false block.

Actual Behaviour

In the true block, x is identified as true, and in the false block, x is identified as boolean.

Reproduction steps
  1. Paste this code into the editor
local x ---@type boolean

if x == false then
	local y = x
	-- y is type `true`, should be type `false`
else
	local y = x
	-- y is type 'boolean', should be type 'true'
end
  1. Hover over y to inspect its type.
Additional Notes

This doesn't just happen with boolean types. It can happen to any type that can be false, such as integer|false|nil.

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 issue in the Visual Studio Code extension using the Lua snippet and hover over y in both branches. Trace the type-checking behavior for x == false, then verify that the true branch resolves to false and the false branch to true, including unions such as integer|false|nil.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.