Export Documentation

[Ismoh]

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Other

Expected Behaviour

I would have expected to see doc.json or doc.md in any log file.

Actual Behaviour

I run

C:\Users\Ismoh-PC\.vscode\extensions\sumneko.lua-3.6.18-win32-x64\server\bin>lua-language-server.exe --loglevel=trace --doc"D:/______BACKUP/NoitaMP_repo/NoitaMP/mods/noita-mp/files/scripts"

and I am unable to find doc.json nor doc.md anywhere in the logs!

Reproduction steps

In VSCode cmd terminal:

C:\Users\Ismoh-PC\.vscode\extensions\sumneko.lua-3.6.18-win32-x64\server\bin>lua-language-server.exe --loglevel=trace --doc"D:/______BACKUP/NoitaMP_repo/NoitaMP/mods/noita-mp/files/scripts"
Content-Length: 120

{"jsonrpc":"2.0","method":"$/status/report","params":{"text":"­ƒÿ║Lua","tooltip":"Cached files: 0/0\nMemory usage: 2M"}}

Additional Notes

No response

Log File

file_d%3A_______BACKUP_NoitaMP_repo_NoitaMP.log
service.log

[omarkmu]

Have you tried adding a space between --doc and the path?

[Ismoh]

Have you tried adding a space between --doc and the path?

Yes, unfortunatelly didn't help. Are there any warnings or errors, when lua files cannot be parsed?
Because I kept it running for 5h, while coding and nothing happened.

I am also wondering, if anything will happen, when annotations aren't correctly used.
There are not so much information about this topic.

[Ismoh]

D:\______BACKUP\NoitaMP_repo\NoitaMP>C:\Users\Ismoh-PC\.vscode\extensions\sumneko.lua-3.6.18-win32-x64\server\bin\lua-language-server.exe --loglevel=trace --doc \"D:\______BACKUP\NoitaMP_repo\NoitaMP\mods\noita-mp\files\scripts"
root uri = file:///d%3A/______BACKUP/NoitaMP_repo/NoitaMP/%22D%3A/______BACKUP/NoitaMP_repo/NoitaMP/mods/noita-mp/files/scripts
Document exporting completed!
Raw data: [C:\Users\Ismoh-PC\.vscode\extensions\sumneko.lua-3.6.18-win32-x64\server\log\doc.json](file:///c%3A/Users/Ismoh-PC/.vscode/extensions/sumneko.lua-3.6.18-win32-x64/server/log/doc.json)
Markdown(example): [C:\Users\Ismoh-PC\.vscode\extensions\sumneko.lua-3.6.18-win32-x64\server\log\doc.md](file:///c%3A/Users/Ismoh-PC/.vscode/extensions/sumneko.lua-3.6.18-win32-x64/server/log/doc.md)

It works now like a charm! I did a mistake when executing the exe file in command prompt.

Also interesting for reading: #1830

[rhys-vdw]

Have you tried adding a space between --doc and the path?

This is how it's formatted in the wiki: https://github.com/LuaLS/lua-language-server/wiki/Export-Documentation

From the bin directory, run ./lua-language-server.exe --doc"<PROJECT_PATH>".

I still have not been able to get it to export, but if someone knows maybe they should update the wiki.