Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(progress-bar): setup basic #98

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat(progress-bar): setup basic #98

wants to merge 10 commits into from

Conversation

AugustinMauroy
Copy link
Collaborator

@AugustinMauroy AugustinMauroy commented Sep 11, 2024 •
edited
Loading

Description

Adding a cool progress bar to know what is going on.

Validation

Run this command and see progress bar

npx api-docs-tooling -i "/path/to/node/doc/api/*.md" -t legacy-html -o /tmp/out

Related Issues

Close #58

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I've covered new added functionality with unit tests if necessary.

flakey5
flakey5 reviewed Sep 11, 2024
View reviewed changes
src/loader.mjs Outdated Show resolved Hide resolved
flakey5
flakey5 reviewed Sep 11, 2024
View reviewed changes
src/loader.mjs Outdated Show resolved Hide resolved
AugustinMauroy and others added 3 commits September 12, 2024 09:05
@AugustinMauroy @flakey5
fix: code style
b96cfd0 
Co-authored-by: flakey5 <[email protected]>
@AugustinMauroy @flakey5
fix: code style
9180963 
Co-authored-by: flakey5 <[email protected]>
@AugustinMauroy @flakey5
fix: code style
3d1760f 
Co-authored-by: flakey5 <[email protected]>
@ovflowd
Copy link
Member

ovflowd commented Oct 14, 2024

@AugustinMauroy, any progress here? Would love to have this landed!

@AugustinMauroy
Copy link
Collaborator Author

I'll take time today to fix this pr. When a generator as ended the process still running because the progressbar did't ended correctly

@AugustinMauroy AugustinMauroy marked this pull request as ready for review October 14, 2024 19:27
@AugustinMauroy AugustinMauroy requested a review from a team as a code owner October 14, 2024 19:27
@AugustinMauroy
Copy link
Collaborator Author

@ovflowd could you give last review ? 😄

ovflowd
ovflowd reviewed Oct 21, 2024
View reviewed changes
Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the progress bar should be for:

  1. Loader (progress of loading files)
  2. Parser (progress of parsing files)
  3. Top Level generator.mjs (progress of going through generators, instead of each file being generated)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flakey5 flakey5 flakey5 approved these changes

@ovflowd ovflowd Awaiting requested review from ovflowd

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add cli-progress (Progress Bar) for CLI
3 participants
@AugustinMauroy @ovflowd @flakey5