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

Closed
wants to merge 59 commits into from
Closed

feat(progress-bar): setup basic #98

wants to merge 59 commits into from

Conversation

AugustinMauroy
Copy link
Member

@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
flakey5
flakey5 reviewed Sep 11, 2024
View reviewed changes
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
Member 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
Member Author

@ovflowd could you give last review ? 😄

ovflowd
ovflowd reviewed Oct 21, 2024
View reviewed changes
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)

ovflowd
ovflowd reviewed Nov 11, 2024
View reviewed changes
ovflowd
ovflowd reviewed Nov 11, 2024
View reviewed changes
ovflowd
ovflowd reviewed Nov 11, 2024
View reviewed changes
ovflowd
ovflowd reviewed Nov 11, 2024
View reviewed changes
@ovflowd
Copy link
Member

ovflowd commented Nov 18, 2024

Bump, @AugustinMauroy

@avivkeller
Copy link
Member

IMO there should be a way to disable the progress bar, like --no-progress or something.

aduh95 and others added 27 commits February 7, 2025 18:57
@aduh95
doc: make MDN links to global classes more consistent (#190)
3452cf2
@flakey5 @ovflowd
feat apilinks.json generator (#153)
11a7953 
* feat apilinks.json generator

Closes #152

Signed-off-by: flakey5 <[email protected]>

Co-authored-by: Claudio W <[email protected]>

* Update getBaseGitHubUrl.mjs

---------

Co-authored-by: Claudio W <[email protected]>
@dependabot
meta: bump ossf/scorecard-action from 2.4.0 to 2.4.1 (#202)
20d1cac 
Bumps [ossf/scorecard-action](https://github.com/ossf/scorecard-action) from 2.4.0 to 2.4.1.
- [Release notes](https://github.com/ossf/scorecard-action/releases)
- [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md)
- [Commits](ossf/scorecard-action@62b2cac...f49aabe)

---
updated-dependencies:
- dependency-name: ossf/scorecard-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump step-security/harden-runner from 2.10.4 to 2.11.0 (#201)
9a3c811 
Bumps [step-security/harden-runner](https://github.com/step-security/harden-runner) from 2.10.4 to 2.11.0.
- [Release notes](https://github.com/step-security/harden-runner/releases)
- [Commits](step-security/harden-runner@cb605e5...4d991eb)

---
updated-dependencies:
- dependency-name: step-security/harden-runner
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump actions/upload-artifact from 4.6.0 to 4.6.1 (#200)
546f284 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.1.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@65c4c4a...4cec3d8)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump github/codeql-action from 3.28.8 to 3.28.10 (#199)
1206535 
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.28.8 to 3.28.10.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@dd74661...b56ba49)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump hastscript from 9.0.0 to 9.0.1 (#198)
c6c1408 
Bumps [hastscript](https://github.com/syntax-tree/hastscript) from 9.0.0 to 9.0.1.
- [Release notes](https://github.com/syntax-tree/hastscript/releases)
- [Commits](syntax-tree/hastscript@9.0.0...9.0.1)

---
updated-dependencies:
- dependency-name: hastscript
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump semver from 7.7.0 to 7.7.1 (#197)
0a05afb 
Bumps [semver](https://github.com/npm/node-semver) from 7.7.0 to 7.7.1.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/main/CHANGELOG.md)
- [Commits](npm/node-semver@v7.7.0...v7.7.1)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump remark-gfm from 4.0.0 to 4.0.1 (#195)
d162314 
Bumps [remark-gfm](https://github.com/remarkjs/remark-gfm) from 4.0.0 to 4.0.1.
- [Release notes](https://github.com/remarkjs/remark-gfm/releases)
- [Commits](remarkjs/remark-gfm@4.0.0...4.0.1)

---
updated-dependencies:
- dependency-name: remark-gfm
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump @types/node from 22.13.0 to 22.13.8 (#194)
d896c77 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.13.0 to 22.13.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump the lint group with 4 updates (#193)
588d8f2 
Bumps the lint group with 4 updates: [@eslint/js](https://github.com/eslint/eslint/tree/HEAD/packages/js), [eslint](https://github.com/eslint/eslint), [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [globals](https://github.com/sindresorhus/globals).


Updates `@eslint/js` from 9.19.0 to 9.21.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/commits/v9.21.0/packages/js)

Updates `eslint` from 9.19.0 to 9.21.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v9.19.0...v9.21.0)

Updates `eslint-config-prettier` from 10.0.1 to 10.0.2
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases)
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/eslint-config-prettier@v10.0.1...v10.0.2)

Updates `globals` from 15.14.0 to 16.0.0
- [Release notes](https://github.com/sindresorhus/globals/releases)
- [Commits](sindresorhus/globals@v15.14.0...v16.0.0)

---
updated-dependencies:
- dependency-name: "@eslint/js"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: lint
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: lint
- dependency-name: eslint-config-prettier
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: lint
- dependency-name: globals
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: lint
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
meta: bump prettier from 3.4.2 to 3.5.2 in the fromat group (#192)
c26adb4 
Bumps the fromat group with 1 update: [prettier](https://github.com/prettier/prettier).


Updates `prettier` from 3.4.2 to 3.5.2
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/prettier@3.4.2...3.5.2)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: fromat
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@AugustinMauroy
workflow(pr): improve (#203)
adefb11
@AugustinMauroy
feat(progress-bar): setup basic
4eb8286
@AugustinMauroy
test: progress-bar
984022e
@AugustinMauroy @flakey5
fix: code style
766bae6 
Co-authored-by: flakey5 <[email protected]>
@AugustinMauroy @flakey5
fix: code style
5479cab 
Co-authored-by: flakey5 <[email protected]>
@AugustinMauroy @flakey5
fix: code style
2769920 
Co-authored-by: flakey5 <[email protected]>
@AugustinMauroy
fix + update
6b1308d
@AugustinMauroy
fix: codespell
47c2765
@AugustinMauroy
wip
3a00ed5
@AugustinMauroy
remove
0c22339
@AugustinMauroy
add withe-spaces
89228fd
@AugustinMauroy
remove useless await
f311669
@AugustinMauroy
WIP(spinner)
9124051
@AugustinMauroy
use clack
89e377e
@AugustinMauroy
Merge branch 'feat(progress-bar)' of https://github.com/nodejs/api-do…
b45d230 
…cs-tooling into feat(progress-bar)
@AugustinMauroy
Copy link
Member Author

I broke them all with my rebase.
And I can't get it to work

@AugustinMauroy AugustinMauroy deleted the feat(progress-bar) branch March 23, 2025 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ovflowd ovflowd ovflowd left review comments

@flakey5 flakey5 flakey5 approved these changes

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
6 participants
@AugustinMauroy @ovflowd @avivkeller @araujogui @flakey5 @aduh95