LuaLS / LuaLS/lua-language-server

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

未關閉
#2,657 5 則留言 6 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Lua
星號
4.4k
分支
442
PR 合併指標
30 天內沒有已合併 PR

描述

### 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)

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

使用 Lua: Export Document 命令重現該故障,然後從 script/cli/doc.lua:287 中的 collectConfig 開始。追蹤來自 script/core/command/exportDocument.lua 的呼叫。檢查提供的日誌和匯出路徑處理;完成的標準是選取輸出位置後能夠產生文件,且不出現日誌中記錄的錯誤。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
cli, documentation
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
描述清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。