You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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:
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.
The text was updated successfully, but these errors were encountered:
I'll give a shot as well. Instead of manually parse annotations line (the one starting with ---) a viable approach is to use the json produce by the command for docs generation
./lua-language-server --doc=path/to/lua/workspace
I know that it's a bit against the mini.doc philosophy (few dependencies as possible, here we depend on lua LSP) but this should ensure perfect annotations parsing. So it "just" remains to convert json to proper vim documentation for :help
I know that it's a bit against the mini.doc philosophy (few dependencies as possible, here we depend on lua LSP) but this should ensure perfect annotations parsing. So it "just" remains to convert json to proper vim documentation for :help
No, that is definitely against 'mini.nvim' design. Everything will be parsed without external dependencies.
Contributing guidelines
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: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:Conversely, the
@param
annotation supported by LuaLS/lua-language-server is explicitly defined as:In this format, the
type
directly follows the parametername
, 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.The text was updated successfully, but these errors were encountered: