Feature Request: Add an option to require type annotations
還沒有人認領這個 Issue。
評估
研究方向
從 .luarc.json 設定以及現有的 incomplete-signature-doc、missing-global-doc 和 missing-local-export-doc 診斷開始，了解如何啟用和升級診斷。定義新診斷針對函式、全域表格變數和表格註解的範圍，然後根據 issue 中的範例驗證所要求的警告和錯誤行為。
由索引模型根據 Issue 內容生成。
描述
Desire
I would like a way for lua-language-server to apply a "strict" mode to the functions and tables variables of lua files. e.g. if a function takes at least one parameter or has at least one return <foo> statement, it would error if that function doesn't also have a ---@param / ---@return statement to match it.
Issue
There seems to be some arguments that can make lua-language-server more strict, for example these:
.luarc.json
{
"diagnostics": {
"neededFileStatus": {
"incomplete-signature-doc": "Any",
"missing-global-doc": "Any",
"missing-local-export-doc": "Any"
},
"severity": {
"incomplete-signature-doc": "Error",
"missing-global-doc": "Error",
"missing-local-export-doc": "Error"
}
},
}
But they seem to activate only on inlined functions or functions that have incomplete documentation. So if a function has no docs at all, it gets skipped.
Suggestion
A new diagnostic that maybe can be a warning but can be escalated to an error. And it basically says
- If it is a global variable table, it needs a
---@type - If it is a function
- And it has at least one parameter
- Each parameter must define
---@paramwith a name + type
- Each parameter must define
- And it has at least one non-bare-return `return
- Each parameter must define
---@returnwith type
- Each parameter must define
- And it has at least one parameter
- If the type annotation is a table
- Require that the table is "filled out" with concrete types. e.g.
---@type table->---@type table<string, integer>
- Require that the table is "filled out" with concrete types. e.g.
Something along these lines
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 446
- 平均合併
- 8 天 9 小時
- 30 天內合併 PR
- 1
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
LuaLS/lua-language-server 的其他 Issue
-
enhancement
難度 2/5 1-3 小時 新手友好度 62/100
LuaLS/lua-language-server#1776 ·
-
難度 4/5 3-5 天 新手友好度 35/100
LuaLS/lua-language-server#3470 ·
-
難度 3/5 1-2 天 新手友好度 68/100
LuaLS/lua-language-server#3469 ·
-
難度 3/5 1-2 天 新手友好度 68/100
LuaLS/lua-language-server#3468 ·
-
難度 3/5 1-2 天 新手友好度 65/100
LuaLS/lua-language-server#3463 · 5 則留言 ·
查看 LuaLS/lua-language-server 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 70/100
維護者通常 3 天內回覆
-
Campaign WC
難度 2/5 1-3 小時 新手友好度 60/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
public-transport/transitous#2569 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 82/100
-
bug: (profiler): E484 "Can't open file .../vim/_core/shared" when stopping profiler on Neovim 0.12未關閉bug
難度 2/5 1-3 小時 新手友好度 75/100
folke/snacks.nvim#2971 ·