LuaLS / LuaLS/lua-language-server

discard-returns warning is not triggered in while/repeat loops

Open
#2,549 1 comment 1 reaction 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?

Annotations

### Expected Behaviour

@nodiscard annotated functions should always trigger the `discard-return`s warning in any context.

### Actual Behaviour

`discard-returns` does not trigger in _while_ and _repeat_ loops.

### Reproduction steps

```lua

---@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

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.