nodejs / nodejs/doc-kit

Add `cli-progress` (Progress Bar) for CLI

Aperta
#58 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

CLI good first issue help wanted
Lingua principale
JavaScript
Stelle
65
Fork
71
Merge medio
2g 17h
PR unite (30g)
31

Descrizione

This issue details the introduction of a progress bar to show the progress made in parsing and generating files. Similar to how we did on nodejs.dev (https://github.com/nodejs/nodejs.dev/blob/e670ec88c82119ed3141d97e24a2e98630a304c9/util-node/getApiDocsData.js#L25)

It should represent where it is and what it is generating/parsing. It should reside as a tool within src/utils and be imported within the cli.mjs

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia da cli.mjs e dalle utility esistenti in src/utils, quindi esamina l’esempio nodejs.dev collegato per capire come viene riportato l’avanzamento durante il parsing e la generazione. Aggiungi l’utility progress-bar in src/utils e importala da cli.mjs; il lavoro è completo quando la CLI mostra dove si trova e cosa sta analizzando o generando.

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

Valutazione

Stack tecnologico
javascript
Ambito
cli, tooling
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
64/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.