Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Request] Automated help/man page generation

Aperta
  • Qualcosa non va?
#525 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
cli

Direzione di ricerca

Inizia leggendo le API di command e type di Clack, quindi traccia il modo in cui i commands configurati espongono i loro argomenti. Definisci cosa dovrebbe contenere l’output della guida in testo semplice e come i callers lo richiederebbero; il lavoro è completato quando un command fortemente tipizzato può produrre una descrizione utile dei propri argomenti senza imporre una configurazione CLI completa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

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.

Lingua principale
TypeScript
Stelle
8.1k
Fork
217
Merge medio
1g 11h
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di bombshell-dev/clack

Tutte le issue di bombshell-dev/clack

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.