Update mini.doc to LuaCATS
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- lua
调研方向
从 mini.doc 模块开始，阅读链接的 LuaCATS 文档，尤其是 @param 格式和 LuaLS 兼容性说明。将该规范与 mini.doc 帮助部分中描述的当前类似 EmmyLua 的注释行为进行比较。当 mini.doc 遵循文档化的 LuaCATS 结构，并且无需依赖启发式类型搜索即可支持用户定义的类型时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
Contributing guidelines
- I have read CONTRIBUTING.md
- I have read CODE_OF_CONDUCT.md
Module(s)
mini.doc
Description
LuaLS/lua-language-server is the most used implementation Language server for Lua. One of its features are annotations implemented as LuaCATS (Lua Comment And Type System). As stated in their docs:
LuaCATS annotations are no longer cross-compatible with EmmyLua annotations as of v3
The current implementation of mini.doc try to parse EmmyLua-like annotations. Compare to EmmyLua annoation, LuaCATS define a precise specification for annotation.
For instance, the mini.doc :help section mentions:
Hooks for sections which supposed to have "type-like" data ('@field',
'@param', '@return', '@type') automatically enclose first found
"type-like" word and its neighbor characters in '(<type>)' (expect
false positives). Algorithm is far from being 100% correct ...
Conversely, the @param annotation supported by LuaLS/lua-language-server is explicitly defined as:
---@param <name[?]> <type[|type...]> [description]
In this format, the type directly follows the parameter name, eliminating the need for heuristic searches for the type. Additionally, this format simplifies the integration of user-defined types into help.txt.
While I could develop my own hooks to adhere to the LuaCATS specification (skill permitting), I believe that aligning with a dominant and well-documented standard would be more advantageous for the community.
- 主要语言
- Lua
- 星标
- 9.6k
- 派生
- 314
- 平均合并
- 21 小时 47 分钟
- 30 天内合并 PR
- 6
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nvim-mini/mini.nvim 的其他 Issue
-
'mini.nvim' and multicursor可能重新可做 @justinmk 于 37 天前认领，目前没有进行中的 PR。 未关闭ALL neovim-upstream
难度 5/5 一周以上 新手友好度 28/100
-
mini.statuscolumn
难度 5/5 一周以上 新手友好度 25/100
-
feature-request mini.surround
难度 3/5 1-2 天 新手友好度 52/100
-
new-module
难度 5/5 一周以上 新手友好度 25/100
-
feature-request mini.extra
难度 3/5 1-2 天 新手友好度 48/100
查看 nvim-mini/mini.nvim 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
fw876/helloworld#2074 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
-
Bug
难度 2/5 1-3 小时 新手友好度 68/100
-
bug documentation lua
难度 2/5 1-3 小时 新手友好度 65/100