LuaLS / LuaLS/lua-language-server
discard-returns warning is not triggered in while/repeat loops
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?
Annotations
Expected Behaviour
@nodiscard annotated functions should always trigger the discard-returns warning in any context.
Actual Behaviour
discard-returns does not trigger in while and repeat loops.
Reproduction steps
---@nodiscard
local function bar()
--@nodiscard annotated function
end
while true do
bar() --< this DOES NOT trigger no-discard
break
end
repeat
bar() --< this DOES NOT trigger no-discard
break
until true
bar() -- < this DOES trigger no-discard
for index, value in ipairs({}) do
bar() -- < this DOES trigger no-discard
end
Additional Notes
No response
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
Reproduce the issue in the Visual Studio Code extension using the Lua snippet from the report, then trace how the discard-returns warning handles while and repeat loops compared with direct calls and for loops. Done means @nodiscard calls in both loop forms trigger the warning consistently with the other contexts.
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
- 45/100