LuaLS / LuaLS/lua-language-server

`need-check-nil` when nil check is done in a function

Open
#1,429 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
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

No type checking errors

### Actual Behaviour

`Need check nil.Lua Diagnostics.(need-check-nil)` on the `:lower()`

### Reproduction steps

Simplified case with the issue
```lua
---@param str string?
---@return boolean
local function isEmpty(str)
return str == nil or str == ''
end

---@param input string?
---@return string?
local function myFunc(input)
if isEmpty(input) then
return
end
return input:lower()
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 by running the Lua example in the issue through the language server and inspect the type-checking path that produces the need-check-nil diagnostic. Trace how the isEmpty function result affects narrowing of input, then verify that the diagnostic is absent for input:lower() while nil checks elsewhere remain correct.

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.