Export Document Renders Nothing

オープン

#137 2024年4月27日に作成コメント 1 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語: 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

Open a lua file
press ctl + shift + p
select "Lua: Export Document"
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 <script/provider/provider.lua:962>
	[C]: in function 'xpcall'
	script/proto/proto.lua:200: in function <script/proto/proto.lua:175>

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
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