LuaLS / LuaLS/lua-language-server

`--doc` CLI argument does not work

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

還沒有人認領這個 Issue。

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

描述

### How are you using the lua-language-server?

Command Line

### Which OS are you using?

Windows WSL

### What is the issue affecting?

Other

### Expected Behaviour

Document generation, as documented here:

https://luals.github.io/wiki/usage/#--doc

### Actual Behaviour

```sh
rhys@RhysDesktop:~/example-lua$ ~/lua-language-server/bin/lua-language-server --doc ~/example-lua/
root uri = file:///home/rhys/example-lua/
script/cli/doc/export.lua:304: attempt to concatenate a nil value (local 'outputDir')
stack traceback:
script/cli/doc/export.lua:304: in field 'serializeAndExport'
script/cli/doc/init.lua:235: in upvalue 'callback'
script/lclient.lua:129: in function
stack traceback:
script/lclient.lua:123: in function 'await.errorHandle'
script/await.lua:35: in function 'await.checkResult'
(...tail calls...)
[C]: in function 'xpcall'
script/timer.lua:52: in upvalue 'mWakeup'
script/timer.lua:93: in upvalue 'onTick'
script/timer.lua:236: in function 'timer.update'
script/lclient.lua:139: in method 'start'
script/cli/doc/init.lua:201: in function 'cli.doc.runCLI'
script/cli/init.lua:22: in main chunk
[C]: in function 'require'
/home/rhys/lua-language-server/main.lua:78: in main chunk
(bootstrap.lua):85: in main chunk
[C]: in ?
script/lclient.lua:124: [19:48:24.474][error][#0:script/lclient.lua:123]: script/cli/doc/export.lua:304: attempt to concatenate a nil value (local 'outputDir')
stack traceback:
script/cli/doc/export.lua:304: in field 'serializeAndExport'
script/cli/doc/init.lua:235: in upvalue 'callback'
script/lclient.lua:129: in function <script/lclient.lua:128>
stack traceback:
script/lclient.lua:123: in function 'await.errorHandle'
script/await.lua:35: in function 'await.checkResult'
(...tail calls...)
[C]: in function 'xpcall'
script/timer.lua:52: in upvalue 'mWakeup'
script/timer.lua:93: in upvalue 'onTick'
script/timer.lua:236: in function 'timer.update'
script/lclient.lua:139: in method 'start'
script/cli/doc/init.lua:201: in function 'cli.doc.runCLI'
script/cli/init.lua:22: in main chunk
[C]: in function 'require'
/home/rhys/lua-language-server/main.lua:78: in main chunk
(bootstrap.lua):85: in main chunk
[C]: in ?

stack traceback:
[C]: in function 'error'
script/lclient.lua:124: in function 'await.errorHandle'
script/await.lua:35: in function 'await.checkResult'
(...tail calls...)
[C]: in function 'xpcall'
script/timer.lua:52: in upvalue 'mWakeup'
script/timer.lua:93: in upvalue 'onTick'
script/timer.lua:236: in function 'timer.update'
script/lclient.lua:139: in method 'start'
script/cli/doc/init.lua:201: in function 'cli.doc.runCLI'
script/cli/init.lua:22: in main chunk
[C]: in function 'require'
/home/rhys/lua-language-server/main.lua:78: in main chunk
(bootstrap.lua):85: in main chunk
[C]: in ?
/home/rhys/lua-language-server/bin/lua-language-server: script/lclient.lua:149: two hours later ...
====== C -> S ======
====== S -> C ======
====================
stack traceback:
[C]: in function 'error'
script/lclient.lua:149: in method 'start'
script/cli/doc/init.lua:201: in function 'cli.doc.runCLI'
script/cli/init.lua:22: in main chunk
[C]: in function 'require'
/home/rhys/lua-language-server/main.lua:78: in main chunk
(bootstrap.lua):85: in main chunk
[C]: in ?
```

### Reproduction steps

1. Create a new folder
2. Add any documented lua file, I used this:
```lua
---@param x number
function foo(x) end
```
3. Run `lua-language-server --doc <path-to-folder>`

### Additional Notes

I tried this on both Windows and WSL with the same result.

### Log File

_No response_

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

Start with script/cli/doc/export.lua at the serializeAndExport failure on line 304, then trace how script/cli/doc/init.lua invokes it for `--doc`. Reproduce the command against a folder containing the documented Lua file. Done means the command completes without the nil `outputDir` error and generates the expected documentation.

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

評估

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

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

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