nodejs / nodejs/doc-kit

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

Open
#58 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CLI good first issue help wanted
Dominant language
JavaScript
Stars
65
Forks
71
Avg merge
2d 17h
Merged PRs (30d)
31

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with cli.mjs and the existing utilities under src/utils, then review the linked nodejs.dev example for how progress is reported during parsing and generation. Add the progress-bar utility in src/utils and import it from cli.mjs; done means the CLI shows where it is and what it is parsing or generating.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.