LuaLS / LuaLS/lua-language-server
[Feature Request] Allow passing filters to `--doc`
Nessuno ha ancora preso questa issue.
- Lingua principale
- Lua
- Stelle
- 4.4k
- Fork
- 442
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dal comando --doc e confronta come vengono generate la documentazione markdown e JSON. Segui il percorso di output della documentazione esistente, quindi determina dove un valore di --doc-filter può limitare un namespace e i suoi membri. Il lavoro è completato quando l'output markdown e JSON filtrato include solo l'ambito del namespace richiesto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- lua
- Ambito
- cli, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100