Feature: Adding support for custom @tags
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 45/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- lua
研究方向
先找出文件匯出器及其產生的 JSON 文件,接著追蹤 Lua 註解如何被解析與匯出。定義 custom_tags 項目(包括標題、隱藏旗標和格式函式)應如何表示在匯出的 JSON 中;當不需要內部使用即可解析和後處理自訂標籤時,即表示完成。
由索引模型根據 Issue 內容生成。
描述
One of the nice things with LDoc was the ability to define custom tags, so they could be used to give additional annotations.
As an example, this is the tags section of one of our projects.
custom_tags = {
{"baseclass", title = "BaseClass", hidden = true},
{"state", title = "State", hidden = true},
{"warns", title = "Warnings", format = function(...)
return "<span class='tag-warning'>" .. markup(...) .. "</span>"
end},
{"bugs", title = "Known Issues", format = function(...)
return "<span class='tag-bugs'>" .. markup(...) .. "</span>"
end},
{"deprecated", title = "Deprecated", format = function(str)
if str == "" then
return "<span class='tag-deprecated'>This function is deprecated and may be removed in a future version.</span>"
else
return "<span class='tag-deprecated'>This function is deprecated and may be removed in a future version.<br>" .. markup(str) .. "</span>"
end
end},
{"internal", title = "Internal", format = function(str)
if str == "" then
return "<span class='tag-internal'>This function is internal. Whilst you can call it, you probably shouldn't.</span>"
else
return "<span class='tag-internal'>This function is internal. Whilst you can call it, you probably shouldn't.<br>" .. markup(str) .. "</span>"
end
end}
}
Even if these aren't used internally, being able to define them for LuaLS to parse and export from the docs exporter in the json document would allow us to do post-processing on the files.
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- 平均合併
- 8 天 9 小時
- 30 天內合併 PR
- 1
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
LuaLS/lua-language-server 的其他 Issue
-
enhancement
難度 2/5 1-3 小時 新手友好度 62/100
LuaLS/lua-language-server#1776 ·
-
難度 3/5 1-2 天 新手友好度 65/100
LuaLS/lua-language-server#3463 · 5 則留言 ·
-
難度 4/5 3-5 天 新手友好度 55/100
LuaLS/lua-language-server#3461 ·
-
難度 3/5 1-2 天 新手友好度 68/100
LuaLS/lua-language-server#3460 · 1 則留言 · 1 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 68/100
LuaLS/lua-language-server#3459 · 1 個 reaction ·
查看 LuaLS/lua-language-server 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 70/100
openSUSE/python-rpm-macros#219 ·
-
bug mini.bracketed
難度 2/5 1-3 小時 新手友好度 75/100
-
accessibility bug typst
難度 2/5 1-3 小時 新手友好度 75/100
quarto-dev/quarto-cli#14947 · 2 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
HenrikBengtsson/CBI-software#134 ·
-
Nmap
難度 1/5 1 小時以內 新手友好度 85/100