Repository navigation
Lua: Export Document ... fails, throws error in log when trying to export documentation. #2657
Description
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
Export document to allow exporting documentation.
Actual Behaviour
Nothing happens, though if you check the logs there is the following error:
[20:31:45.883][error][#0]: script\cli\doc.lua:287: bad argument #1 to 'path' (bee::path expected, got nil)
stack traceback:
[C]: in function 'bee.filesystem.path'
script\cli\doc.lua:287: in upvalue 'collectConfig'
script\cli\doc.lua:300: in function 'cli.doc.export'
script\cli\doc.lua:354: in function 'cli.doc.makeDoc'
script\core\command\exportDocument.lua:11: in function 'core.command.exportDocument'
script\provider\provider.lua:984: in function <script\provider\provider.lua:962>
[C]: in function 'xpcall'
script\proto\proto.lua:200: in function <script\proto\proto.lua:175>
Reproduction steps
- Open Command Pallete
- Select
Lua: Export Document ... - Select a location to export to.
- Observe as nothing is output, and the error is thrown in the log.
Additional Notes
No response
Activity
strattera commentedon May 11, 2024
Same here, I've been using --doc instead of this.
Another issue I'd like to point out about this is, if you export documentation using --doc, then it can't locate the config and therefore doesn't respect any settings.
strattera commentedon May 12, 2024
Found a temporary fix. In
.../script/cli/doc.lua, replaceDOCwith a path to your workspace.drd-dev commentedon Jun 3, 2024
having the same issue
hunterpankey commentedon Sep 4, 2025
Also came here for this issue. I'll try manually fixing doc.lua to see if that does anything. I thought it might be a clue that every time I ran the command, it forgot my previously selected output path and defaulted to ".vscode\extensions\sumneko.lua-3.15.0-win32-x64\server\log"...
mark-wiemer commentedon Dec 6, 2025
Try the fix documented in #3170 :)