LuaLS / LuaLS/lua-language-server
Is it possible to annotate nodiscard for fields of a class?
還沒有人認領這個 Issue。
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- PR 合併指標
- 30 天內沒有已合併 PR
描述
### 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_
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
首先追蹤 language server 如何解析並套用 @class 與 @field 註解,然後將這條路徑與其現有的 @nodiscard 處理方式進行比較。定義型別為函式的類別欄位之註解語法,並驗證該欄位產生的未使用結果會產生預期的診斷資訊。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- devtools
- Issue 類型
- 功能
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100