LuaLS / LuaLS/lua-language-server
[Feature Request] Allow passing filters to `--doc`
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the --doc command and compare how markdown and JSON documentation are generated. Trace the existing documentation output path, then determine where a --doc-filter value can limit a namespace and its members. Done means filtered markdown and JSON output include only the requested namespace scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100