Export Documentation

[TurtleP]

Heya,

From what I understand, there should be/is a way to export the annotation data to markdown/html via command line. However, I tried to do this in the Visual Studio Code settings, but it didn’t seem to do anything, even checking where it might possibly have output. There’s also no command that can just output based on a directory or file, so I’m left to wonder: how is this supposed to work? I would like to be able to export the annotations I’ve written.

[sumneko]

1. Find the binary in your computer, it should be C:\Users\<USERNAME>\.vscode\extensions\sumneko.lua-XXXX\server\bin\lua-language-server.exe
2. Run command in cmd or powershell at bin: .\lua-language-server.exe --doc=<PROJECT_PATH>
3. Server will export doc.json and doc.md into C:\Users\<USERNAME>\.vscode\extensions\sumneko.lua-XXXX\server\log

[TurtleP]

I feel like having a Visual Studio Code command would also be beneficial. Would this be possible?

[sumneko]

Sure, please open an issue about it

[sumneko]

@carsakiller Could you please update the wiki about it?

[carsakiller]

Updated the wiki 🙂

[gdevillele]

Thank you for the explanations.
I am new to lua-language-server and trying to generate documentation as well.

My test Lua file:

--- This is a test function
---@param bar string
function Foo(bar)
end

I am executing the following command:

$ ~/.vscode/extensions/sumneko.lua-3.6.7-darwin-arm64/server/bin/lua-language-server --doc="./test.lua"

And it doesn't generate any doc... the doc.json file only contains [].
Do I need some special configuration ? I am not providing any, currently.

I spent a lot of time in the lua-language-server documentation but I can't figure out what I'm missing here.
Thanks a lot for the help 🙂

[carsakiller]

I believe the path for --doc must be absolute, like C:/Users/me/lua/test.lua

[aduermael]

Hey! (I'm working with @gdevillele)
I tried with absolute paths, but it's still the same result:

./lua-language-server \
--logpath="/Users/aduermael/Desktop/lua-docs" \
--configpath "/Users/aduermael/repos/particubes-private/common/assets/scripts/lua-language-server-config.lua" \
--doc "/Users/aduermael/repos/particubes-private/common/assets/scripts/uikit.lua"

It creates these files:

doc.json
doc.md
file_Users_aduermael_repos_particubes-private_common_assets_scripts.log
file_Users_aduermael_repos_particubes-private_common_assets_scripts_uikit.lua.log
service.log

doc.json contains an empty array [], and doc.md is empty.

service.log contains this:

[17:52:19.938][info] [#0:/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/main.lua:66]: Lua Lsp startup, root: 	/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec
[17:52:19.939][info] [#0:/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/main.lua:67]: ROOT:	/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec
[17:52:19.939][info] [#0:/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/main.lua:68]: LOGPATH:	/Users/aduermael/Desktop/lua-docs
[17:52:19.939][info] [#0:/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/main.lua:69]: METAPATH:	/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/meta
[17:52:19.939][info] [#0:/opt/homebrew/Cellar/lua-language-server/3.6.7/libexec/main.lua:70]: VERSION:	<Unknown>
[17:52:19.967][info] [#0:script/language.lua:137]: VSC language: nil
[17:52:19.967][info] [#0:script/language.lua:138]: LS  language: en-us
[17:52:19.967][info] [#0:script/language.lua:137]: VSC language: nil
[17:52:19.967][info] [#0:script/language.lua:138]: LS  language: en-us
[17:52:19.967][info] [#0:script/workspace/workspace.lua:38]: Workspace init root: 	file:///Users/aduermael/repos/particubes-private/common/assets/scripts
[17:52:19.967][info] [#0:script/workspace/workspace.lua:42]: Log path: 	/Users/aduermael/Desktop/lua-docs/file_Users_aduermael_repos_particubes-private_common_assets_scripts.log

[gdevillele]

Thanks.
If you could see a working example, it would be very helpful.

[aduermael]

Oooh! We just needed to add a @class annotation... 🤦‍♂️ cc @gdevillele

[Ismoh]

@aduermael Could you explain it in more detail?
I am having issues with it:
#2063
I think a verbose logging would be awesome, but doesn't look like it's working.