LuaLS / LuaLS/lua-language-server
`Lua: Export Document ...` fails, throws error in log when trying to export documentation.
Open
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
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
Log File
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the failure with the Lua: Export Document command, then start at script/cli/doc.lua:287 in collectConfig and follow the call from script/core/command/exportDocument.lua. Check the provided log and the export path handling; done means selecting an output location produces the documentation without the logged error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100