LuaLS / LuaLS/lua-language-server

`Lua: Export Document ...` fails, throws error in log when trying to export documentation.

Open
#2,657 5 comments 6 reactions 0 assignees View on GitHub
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
[C]: in function 'xpcall'
script\proto\proto.lua:200: in function
```

### Reproduction steps

1. Open Command Pallete
2. Select `Lua: Export Document ...`
3. Select a location to export to.
4. Observe as nothing is output, and the error is thrown in the log.

### Additional Notes

_No response_

### Log File

[file_d%3A_Desktop_MMC_MultiMC_instances_pathfinding_.minecraft_saves_world_computercraft_computer_1_Simplify-Mapping.log](https://github.com/LuaLS/lua-language-server/files/15281399/file_d.3A_Desktop_MMC_MultiMC_instances_pathfinding_.minecraft_saves_world_computercraft_computer_1_Simplify-Mapping.log)

Contributor guide

Open the contributing guide

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.