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

Offen

#58 erstellt am 05.8.2024 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 64/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Ruhig
Tech-Stack: javascript
Bereich: cli, tooling

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.

Beschreibung

CLI good first issue help wanted

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

Vorherrschende Sprache: JavaScript
Sterne: 65
Forks: 71
Ø Merge: 4 T. 3 Std.
Gemergte PRs (30 T.): 31

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus nodejs/doc-kit

PR-Quality action need to be fixed Offen

Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 68/100

nodejs/doc-kit#1085 · 6 Kommentare · Erstellt am 05.9.2026
inline code "type" didn't have same style everywhere Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100

nodejs/doc-kit#1054 · 1 Kommentar · Erstellt am 26.8.2026
Implement a Remark Linter to validate Semantic Version strings in metadata Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100

nodejs/doc-kit#1109 · Erstellt am 23.9.2026
Can the links to previews in the comments generated by a PR include `doc-kit`? Offen

nodejs/doc-kit#1098 · 2 Kommentare · 1 zugewiesene Person · Erstellt am 14.9.2026
`strong class="critical"` didn't exist on redesigned style Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

nodejs/doc-kit#1056 · 2 Kommentare · Erstellt am 26.8.2026

Alle Issues in nodejs/doc-kit