[Request] Automated help/man page generation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- typescript
- Área
- cli
Línea de trabajo
Empieza leyendo las APIs de command y type de Clack y, después, sigue cómo los commands configurados exponen sus argumentos. Define qué debería contener la salida de ayuda en texto plano y cómo la solicitarían los callers; el trabajo estará terminado cuando un command fuertemente tipado pueda producir una descripción útil de sus argumentos sin imponer una configuración completa de CLI.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Most other CLI packages use type systems to automate the creation of --help or man-page-like output for configured commands. I haven't found any way to do this for Clack commands.
This doesn't need to be a full, opinionated CLI setup — in fact it shouldn't be as that's clearly out of scope for this package. Rather I'm just looking for a way to turn a strongly typed Clack command into a string of text documenting what arguments it takes. To my mind that's the last primitive needed to rapidly build CLIs with Clack.
Describe the solution you'd like
Ability to generate plaintext descriptions of Clack commands and their arguments.
Describe alternatives you've considered
- Manually documenting each command.
- Maybe there's a third-party package that can do this and works with Clack, but I've looked and not found anything that appears to have concensus.
Additional context
I'm very surprised that I haven't found anyone else asking for this yet, so it makes me feel like I'm missing something here. Maybe there is somehow a giant hole in my mental model for this package, apologies if so!
I am very impressed with Clack and was looking forward to using it, but I don't see how I can build a CLI around this without an answer for auto-generating help docs based on the command code. Are people just using other CLI library tools but driving the input interfaces with Clack instead of using the built-in setups? That just feels like putting a hat on a hat to me.
- Lenguaje dominante
- TypeScript
- Estrellas
- 8.1k
- Forks
- 218
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de bombshell-dev/clack
-
Dificultad 3/5 1-2 días Aptitud para principiantes 70/100
bombshell-dev/clack#613 · 4 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
bombshell-dev/clack#597 ·
-
rfc: accessible modeAbiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
bombshell-dev/clack#585 · 1 comentario · 1 reacción ·
-
[Bug] Spinner does not run `onCancel` function on `Ctrl + C`Posiblemente ocupada @cyphercodes la tomó hace 101 días. Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
bombshell-dev/clack#573 · 1 comentario · 2 reacciones ·
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
bombshell-dev/clack#565 · 1 comentario · 1 reacción ·
Todos los issues de bombshell-dev/clack
Issues similares
-
awaiting-response bug needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
wildcard/caro#1562 · 1 comentario ·
Los mantenedores suelen responder en 3 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
supadata-ai/mcp#27 ·
-
content
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
cosimochellini/one-piece-zero-spoiler#516 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
capricorn86/happy-dom#2485 ·
Los mantenedores suelen responder en 2 días
-
lane: fast
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
unicef/adt-studio#946 ·
Los mantenedores suelen responder en 2 días