LuaLS / LuaLS/lua-language-server
Is it possible to annotate nodiscard for fields of a class?
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
I hope there is a way to annotate that a `field` of a `class` is a `@nodiscard` `function`.
### Actual Behaviour
currently there is no way to annotate that a `field` of a `class` is `@nodiscard`
### Reproduction steps
1. Go to your code editor and write a class, for example:
```lua
---@class Item
---@field getPosition fun(self: Item): table
Item = {}
```
2. Try annotate getPosition `field` as `@nodiscard`
### 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
Start by tracing how the language server parses and applies @class and @field annotations, then compare that path with its existing handling of @nodiscard. Define the annotation syntax for a class field whose type is a function, and verify that unused results from that field produce the expected diagnostic.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100