LuaLS / LuaLS/vscode-lua

Export Document Renders Nothing

未关闭
#137 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
TypeScript
星标
215
派生
62
PR 合并指标
30 天内没有已合并 PR

描述

### Which OS are you using?

Linux

### Expected Behaviour

"Lua: Export Document" -> Should generate markdown files after choosing the output folder.

### Actual Behaviour

Nothing renders

### Reproduction steps

1. Open a lua file
2. press `ctl + shift + p`
3. select "Lua: Export Document"
4. choose a folder

no output generated.

### Additional Notes

- This may be user error, if so, no notification provided by the extension.
- I'm using LuaJIT as the interpreter.

### Log

```
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 <script/proto/proto.lua:175>
```

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先从 script/cli/doc.lua 中第 287 行附近的 collectConfig 以及 script/cli/doc.lua 中的导出路径开始,然后跟踪 script/core/command/exportDocument.lua:11。使用 LuaJIT 重现文档中记录的命令序列,并利用堆栈跟踪检查导出为何没有生成文件。当选定文件夹收到 markdown 输出,或扩展报告明确的配置错误时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
cli, documentation
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
描述清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。