LuaLS / LuaLS/lua-language-server
[Feature Request] Allow passing filters to `--doc`
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
It would be very nice if we were able to pass filters to the --doc command to only document specific namespaces.
Example:
lua-language-server --doc="../../.." --doc-filter="MyNameSpace" --doc_out_path="."
Would only output documentation for MyNameSpace and every member like MyNameSpace.Private etc.
For the json output formal I can do this easily via something like
jq '[.[] | select(.name | index("MyNameSpace") != -1)]' doc.json > output.json but for the markdown output, it would be fairly difficult.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
--doc コマンドから始め、markdown と JSON のドキュメントがどのように生成されるかを比較します。既存のドキュメント出力パスを追跡し、その後、--doc-filter の値によって namespace とそのメンバーを制限できる箇所を特定します。フィルタリングされた markdown と JSON の出力に、要求された namespace のスコープだけが含まれれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- cli, documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100