LuaLS / LuaLS/lua-language-server

[Feature Request] Allow passing filters to `--doc`

未关闭
#2,630 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
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.

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 --doc 命令开始,比较 markdown 和 JSON 文档的生成方式。跟踪现有的文档输出路径,然后确定 --doc-filter 值可以在哪里限制一个 namespace 及其成员。完成的标准是,经过过滤的 markdown 和 JSON 输出只包含所请求的 namespace 范围。

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

评估

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

把新 issue 发到你的邮箱

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