nodejs / nodejs/doc-kit

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

Offen
#58 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

CLI good first issue help wanted
Vorherrschende Sprache
JavaScript
Sterne
65
Forks
71
Ø Merge
2 T. 17 Std.
Gemergte PRs (30 T.)
31

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit cli.mjs und den vorhandenen Utilities unter src/utils und sieh dir anschließend das verknüpfte nodejs.dev-Beispiel an, um zu erfahren, wie der Fortschritt während des Parsens und der Generierung gemeldet wird. Füge das progress-bar-Utility in src/utils hinzu und importiere es aus cli.mjs; fertig ist die Aufgabe, wenn die CLI anzeigt, wo sie sich befindet und was sie gerade parst oder generiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
cli, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
64/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.