Add cli-progress (Progress Bar) for CLI #58

Activity

1. ovflowd

   added this to Node.js API Documentation Toolingon Aug 5, 2024
2. ovflowd

   moved this to Todo in Node.js API Documentation Toolingon Aug 5, 2024
3. AugustinMauroy

   self-assigned this

   on Sep 10, 2024
4. AugustinMauroy

   removed their assignment

   on Mar 4, 2025
5. avivkeller

   added the

   Feature

   issue type on Mar 20, 2025
6. AugustinMauroy

   added

   enhancement

   good first issueGood for newcomersGood for newcomers

   help wantedExtra attention is neededExtra attention is needed

   on Mar 23, 2025
7. avivkeller

   moved this from In Progress to Todo in Node.js API Documentation Toolingon Apr 20, 2025
8. avivkeller

   removed

   good first issueGood for newcomersGood for newcomers

   on May 27, 2025
9. avivkeller

   moved this from Todo to 📋 Backlog in Node.js API Documentation Toolingon May 27, 2025
10. ovflowd commented on Jun 28, 2025

    

    ovflowd

    on Jun 28, 2025

    MemberAuthor

    More actions

    cc @nodejs/nodejs-website can someone work on this?
11. avivkeller

    added a parent issue on Jun 28, 2025

    • Add custom console logger with Prefix #329
12. avivkeller

    added

    CLICommand-line InterfaceCommand-line Interface

    and removed

    enhancement

    on Oct 12, 2025
13. ovflowd

    added

    good first issueGood for newcomersGood for newcomers

    on Feb 7, 2026
14. wilsonwangdev commented on Mar 26, 2026

    

    wilsonwangdev

    on Mar 26, 2026

    Contributor

    More actions

    Hi, I'd like to take this on. Before implementing, I wanted to propose a design and get feedback.

    Where progress events naturally occur

    There are two levels in the pipeline:

    1. Generator level — src/generators.mjs schedules generators sequentially (ast → metadata → legacy-html → ...). It knows when each starts/finishes.
    2. Chunk level — src/threading/parallel.mjs already tracks completed vs chunks.length per generator in its while loop (line 120-134).

    Proposed design

    New file: src/progress.mjs — a createProgressReporter() factory that returns:

    • onGeneratorStart(name)
    • onChunkComplete(generatorName, completed, total)
    • onGeneratorComplete(name)
    • destroy()

    When disabled, all methods are no-ops.

    Integration points:

    • src/generators.mjs — accept an optional progress parameter in runGenerators(config, { progress }). Call onGeneratorStart / onGeneratorComplete. Pass progress down to createParallelWorker.
    • src/threading/parallel.mjs — call onChunkComplete after each chunk yield.
    • bin/commands/generate.mjs — instantiate the reporter and pass it in.

    When NOT to show progress:

    • --log-level debug (would interleave with debug output)
    • Non-TTY environments (!process.stdout.isTTY) — CI, piped output
    • When used as a library (no reporter passed)

    Output would look like:

      ast           ████████████████ 4/4 chunks
      metadata      ████████████░░░░ 3/4 chunks
    

    Non-streaming generators (like web) would just show start/complete without chunk progress.

    Open questions

    1. Dependencies — should we use cli-progress or keep it zero-dep with a simple \r-based overwrite (~30 lines)? Given this project values minimal deps, I'm leaning zero-dep.
    2. Scope — should progress also cover the config loading phase (parsing changelog, index), or just the generator pipeline?
    3. Any preferences on the visual format?

    Happy to adjust the approach based on feedback.
15. avivkeller commented on Mar 26, 2026

    

    avivkeller

    on Mar 26, 2026

    Member

    More actions

    Hello, @wilsonwangdev! We'd like to remind you to review the Linux Foundation's AI policy. While AI can certainly assist contributors, a human aspect is needed properly understand and iterate on the existing code base.
16. avivkeller commented on Mar 26, 2026

    

    avivkeller

    on Mar 26, 2026

    Member

    More actions

    To answer your questions, do what you think is best.
17. wilsonwangdev commented on Mar 26, 2026

    

    wilsonwangdev

    on Mar 26, 2026

    Contributor

    More actions

    Hello, @wilsonwangdev! We'd like to remind you to review the Linux Foundation's AI policy. While AI can certainly assist contributors, a human aspect is needed properly understand and iterate on the existing code base.

    Thanks for your remind, I'll take it seriously.
18. wilsonwangdev commented on Mar 26, 2026

    

    wilsonwangdev

    on Mar 26, 2026

    Contributor

    More actions

    To answer your questions, do what you think is best.

    I find there already has a related pull request, so I'm not going to do duplicate things. Thanks for your remind anyway.