11 KiB
11 KiB
Branch 3.x
3.12.0
- Added: option to override bar characters via instance options on
multibar.create()- thanks to Araxeus on GitHub - Added: example howto use multibars with different bar styles
- Bugfix: global terminal instance was not used for multibar elements which forces hard string trimming to terminal width - caused by default
linewrap=truestate of the terminal - thanks to emmercm on GitHub
3.11.2
- Bugfix: disabled
gracefulExitby default, because the default SIGINT/SIGTERM handlers of nodejs are removed
3.11.1
- Bugfix:
MaxListenersExceededWarningwas triggered bygracefulExithandlers added inv3.11.0- thanks to TychoTheTaco on GitHub
3.11.0
- Added:
log()convenience method the multibar to enable custom logging output on top of the progress bars during operation - Added:
gracefulExitoption (enabled by default) to stop the bars in case ofSIGINTorSIGTERM- this restores most cursor settings before exiting - Added:
progressCalculationRelativeoption (disabled by default) to use thestartValueas offset for the progress calculation and calculate the absolute progress from the difference given bytotal-startValue#121 - Added: ability to pass bar options (overrides the global options) to
multibar.create - Bugfix: within a non-tty environment (e.g. CI/CD taskrunners)
multibar.create()returns an undefined value in casenoTTYOutputis not enabled #117
3.10.0
- Changed: foreground color of
preset.shades-greyis set directly by ANSI codes - Changed: example snippets are using
ansi-colorslibrary - Bugfix: removed
colorsdependency due to some issues with the maintainer... see Zalgo bomb
3.9.1
- Bugfix: duration calculation doesn't work for bar restart scenarios - thanks to autlaw on GitHub
3.9.0
- Added: exported standard formatter and format helper
- Added: example howto use multibars in synchronous context
- Changed: upper eta display limit to
1e7(115days) #92
3.8.2
- Bugfix: bar duration not stopped until all bars have finished - thanks to omjadas on GitHub
3.8.1
- Bugfix: percentage calculation used
Math.roundwhich caused incorrect values for edge cases - thanks to OxCom on GitHub
3.8.0
- Changed: allow to pass payload as first argument to
increment()with implicit delta of 1 - thanks to ecdeveloper on GitHub - Changed: allow to pass payload as first argument to
update()without updating bar value - Bugfix:
formatTimeoption ignored due to type - thanks to omjadas on GitHub
3.7.0
- Added: asynchronous eta update for long running processes (optional) - feature requested on GitHub
- Added: method to trigger eta calculation without progress update
3.6.1
- Bugfix: bar initialization overrides options within all instances - thanks to BigBrainAFK on GitHub
3.6.0
- Added: support for custom time-format function
- Added: support for custom bar-format function
- Added: support for custom value-format function
- Added: auto-padding option to enforce fixed size of values - feature requested on GitHub
- Added:
barGlueoption to insert ascii escape sequences (e.g. for colorization) between the bar complete/incomplete elements - feature requested on GitHub - Bugfix:
etavalue can be negative for multibars in case the bar is alredy completed
3.5.0
- Added: support for events via EventEmitter - feature requested on GitHub
3.4.0
- Added: testsuites based on mocha - thanks to on GitHub
- Added: automatic tests via Travis CI
- Bugfix: Fixing issues with falsy values in format which causes remdering artifacts - thanks to on GitHub
- Bugfix: documentation of the
streamoptions was wrong - thanks to ehmicky on GitHub - Changed: updated examples/syntax of
README.md- thanks to justsml on GitHub
3.3.1
- Bugifx: synchronous update may cause unexpected behaviour on multibars - limited to single bars
- Changed: renamed internal eta
push()method toupdate() - Changed: moved internal eta calculation call into
update()
3.3.0
- Added: option to pass custom formatters as callback via
options.format - Changed: replaced static placeholder code with generic regex (performance enhancement)
3.2.0
- Added:
emptyOnZerooption to display total:0 bars as empty, not full - thanks to nickcmaynard on GitHub - Bugfix: removed cursor save/restore calls for multibars - clearOnComplete might not work on all environments - thanks to sayem314 onGitHub
3.1.0
- Added: notty support (interval/schedule based output) - feature requested on GitHub
- Added:
stopOnCompletesupport withinMultiBar- thanks to Nox-404 on GitHub - Changed: initial throttel time of
MultiBaris controlled byfpsoption instead of static500msvalue - Bugfix: provided option didn't take precedence over the preset as in v2 - thanks to AxelTerizaki on GitHub #37
3.0.0
- Added: multi-progressbar support - feature requested on GitHub
- Added: option
synchronousUpdateto control the synchronized redraw duringupdate()call (default=true) - Changed: project split into multiple classes
- Changed: default cli progress output is written to
stdoutinstead ofstderr
Branch 2.x
2.1.1
- Bugifx: preset object got altered by options - thanks to rvalitov on GitHub #27
2.1.0
- Added:
alignoption to change the position of the progress bar (left, center, right) - thanks to sidneys on GitHub #22 - Changed: ETA value of type
Infinityis displayed as INF,NaNas NULL - feature requested by AxelTerizaki on GitHub #21 - Changed: Limited the maximum ETA value to
100000s(INF is displayed in this case) - Changed: ETA calculation moved to own scope
- Bugfix: example
example-notty.phpwas broken
2.0.0
Upgrade is possible without any code modifications! requires node.js 4
- Added: option
linewrapto disable terminal line wrapping (default) - Changed: requires node.js >= 4
- Changed: Native ES2015 class syntax
- Changed: renamed application entry file to
cli-progress.js - Changed: low-level terminal interactions are encapsulated within
Terminalclass - Changed: terminal/cursor settings are restored after progress bar stopped
- Bugfix: used hex ascii escape sequences instaed of octals to avoid javascript errors in recent nodejs version
- Bugfix: disabled line wrapping by default to avoid multiple line breaks on small terminals (cut on the right) - reported by puppeteer701 on GitHub #20
Branch 1.x
1.8.0
- Added: method
setTotal()to manipulate the total value within running progress-bar - feature requested by ReggaePanda on GitHub #19 - Changed: moved example file to
examples/directory
1.7.0
- Added: payload argument to
increment()- feature requested by dsego on GitHub #18
1.6.1
- Bugfix:
roundToparameter was not set forelapsedTimecalculation which caused raw float values within formatted time strings - thanks to rekinyz on GitHub #16
1.6.0
- Added: Additional payload data which can be used as custom-tokens within the bar - thanks to tobiasps on GitHub #15
1.5.1
- Bugfix: Progressbar cannot be initialized to 0% - thanks to erikkallen on GitHub #13
- Bugfix: ETA was NULL in case the progress bar is initialized with (0/0)
1.5.0
- Added: 0 values for total/progress initialization are allowed - feature requested by jfmmm on GitHub #11
1.4.0
- Added: Preset/Theme support. Different bar-styles can be loaded from internal library (in addition to full customization)
- Added: Dependency colors for colorized progress bars
- Added: Preset
legacy - Added: Preset
shades-classic - Added: Preset
shades-grey - Added: Preset
rect
1.3.1
- Added:
example-nottyto test the behaviour of progress bar in non-interactive environments (input streams closed) - Bugfix:
update()throws an error in non-tty environments - reported by Ognian on GitHub #9
1.3.0
- Added:
stopOnCompleteoption to automatically callstop()when the value reaches the total - thanks to lennym on GitHub #7
1.2.0
- Added:
increment()method to increase the current progress relatively - thanks to lennym on GitHub #6 - Added: ETA time formatting options (mm:ss, hh:mm, ss) - thanks to lennym on GitHub #5
- Improvement: More accurate ETA calculation using linear estimation of last N values - thanks to lennym on GitHub #4
- Bugfix: FPS calculation error which caused performance issues - thanks to lennym on GitHub #7
1.1.2
- Bugfix: stdout.cursorTo/stdout.clearLine is not a function; replaced by
readline- thanks to remcoder on GitHub
1.1.1
- Bugfix: Hide cursor options was enabled by default
1.1.0
- Added: Support for synchronous operations (interval has been replaced by timeout and throttle time) - feature requested GitHub
- Added: Synchronous Operation Example
example-synchronous.js - Added: Option to hide the cursor
options.hideCursor- default set to false - Changed: Improved ETA calculation
1.0.1
- Bugfix: the bar-size is limited to
options.barsize- in some (numerical) situations it can be too long (n+1)
1.0.0
- Initial public release