LuaLS / LuaLS/lua-language-server

How to make a third-party member function as deprecated

未關閉
#2,784 11 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

enhancement
主要語言
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?

Diagnostics/Syntax Checking

### Expected Behaviour

```lua
---@deprecated
M.add = M.add
```
The left one should have marked as deprecated immediately when used such as ~u:add~

### Actual Behaviour

1. it not works first.
![QQ_1722841266627](https://github.com/user-attachments/assets/6d27266b-1c94-4210-9b11-b42051fefe3b)
2. and works unexpectedly.
![QQ_1722841307997](https://github.com/user-attachments/assets/e082f762-4d47-472b-9337-a4fdea7c2a94)

### Reproduction steps

1. Write the code
```lua
-- File A

---@class A
local A = {}

---@param attr string
function A.add(attr)
end

-- File B

---@class A
local B = A

---@deprecated
B.add = A.add

B.add('some attr')
```
We'll find that B.add havn't marked as deprecated
2. Keep write the followed
```lua
-- File C

---@class A
---@field add fun(attr: string)
local C = A
```

### Additional Notes

My original intention was to mark a third-party member function as deprecated.
As there was no straightforward way, I think, to do it, I had to use a lot of tricks, which led to more subsequent problems.

### Log File

_No response_

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 issue 中的 File A、File B 和 File C 重現開始,重點關注診斷在已棄用指派之後如何標記 B.add。在 Visual Studio Code 擴充功能中執行重現,並將觀察到的診斷與針對 B.add 的預期棄用警告進行比較。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
devtools
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。