LuaLS / LuaLS/lua-language-server
[Feature Request] Allow passing filters to `--doc`
Personne n'a encore pris cette issue.
- Langage dominant
- Lua
- Étoiles
- 4.4k
- Forks
- 442
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la commande --doc et comparez la manière dont la documentation markdown et JSON est générée. Suivez le chemin de sortie de la documentation existante, puis déterminez où une valeur de --doc-filter peut limiter un namespace et ses membres. C’est terminé lorsque les sorties markdown et JSON filtrées incluent uniquement le périmètre du namespace demandé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- cli, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100