[Feature] Added concurrent info for single progress bars#148

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

Open
gregormaclaine wants to merge 4 commits into
base:master
Choose a base branch
from
Open

[Feature] Added concurrent info for single progress bars #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
258e176
Added concurrent information to single bars
gregormaclaine Aug 2, 2023
02f47dc
Added example for single bar with concurrent info
gregormaclaine Aug 2, 2023
9b7d4cb
Prevent user from using concurrent info in multibars
gregormaclaine Aug 2, 2023
95b6759
Update README.md to include concurrent info
gregormaclaine Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions examples/example-concurrent-info.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() =>
Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
format: 'Files [{bar}] | {percentage}% | {value}/{total}',
hideCursor: true,
barCompleteChar: '\u2588',
barIncompleteChar: '\u2591',
stopOnComplete: true,

// If clear on complete then both bar and info are cleared
// clearOnComplete: true,

// forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
if (bar.value < bar.total) {
bar.increment();

const current_file = random_file_names[Math.floor(bar.value / 20)];
bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
}

if (!bar.isActive) {
clearInterval(timer);
console.log('Download complete!\n');
}
}, 15);
63 changes: 62 additions & 1 deletion lib/generic-bar.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

// use default formatter or custom one ?
this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

/**
* Whether the progress bar should be able to show concurrent info or not.
* E.g. In multibars, each bar should not be able to have concurrent text
* @type {boolean}
*/
this.allowConcurrentInfo = this.options.allowConcurrentInfo;

/**
* The information to show below progress bar
* @type {string | null}
*/
this.concurrentInfo = null;

/**
* The concurrent information has changed and should be rerendered next render
* @type {boolean}
*/
this.concurrentInfoUpdated = false;
}

// internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
|| (this.options.noTTYOutput && !this.terminal.isTTY());

// string changed ? only trigger redraw on change!
if (forceRedraw || this.lastDrawnString != s){
if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
// trigger event
this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
// store string
this.lastDrawnString = s;

// check if concurrent text needs to be rendered
if (this.concurrentInfo !== null) {
// reset cursor to start of next line
this.terminal.cursorRelative(-s.length, 1);

// write concurrent info text
this.terminal.write(this.concurrentInfo);
this.terminal.clearRight();

// reset cursor to previous line
this.terminal.cursorRelative(0, -1);

// concurrent info is now up to date
this.concurrentInfoUpdated = false;
}

// set last redraw time
this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
// add new value; recalculate eta
this.eta.update(Date.now(), this.value, this.total);
}

/**
* Sets the information that is given as additional concurrent information
* below the progress bar. It is cleared once the bar completes.
* @param {string} text The info shown below the progress bar
*/
setConcurrentInfo(text) {
if (!this.allowConcurrentInfo) {
return;
}

this.concurrentInfoUpdated = this.concurrentInfo !== text;
this.concurrentInfo = text;
}

/**
* Clears the additional concurrent information.
*/
clearConcurrentInfo() {
if (!this.allowConcurrentInfo) {
return;
}

this.concurrentInfoUpdated = this.concurrentInfo !== '';
this.concurrentInfo = '';
}
}
7 changes: 5 additions & 2 deletions lib/multi-bar.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
// global options
this.options,

// terminal instance
{
terminal: this.terminal
// terminal instance
terminal: this.terminal,

// concurrent text in multibars is not defined behaviour
allowConcurrentInfo: false
},

// overrides
Expand Down
2 changes: 2 additions & 0 deletions lib/options.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
// autopadding character - empty in case autopadding is disabled
options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

return options;
}
};
9 changes: 7 additions & 2 deletions lib/single-bar.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

// clear line on complete ?
if (this.options.clearOnComplete){
// clear progress bar (And any information below) and remain on same line
this.terminal.cursorTo(0, null);
this.terminal.clearBottom();
} else if (this.concurrentInfo) {
// clear the concurrent information and begin on new line
this.terminal.cursorRelative(0, 1);
this.terminal.clearLine();
}else{
// new line on complete
}else{
// start on next line
this.terminal.newline();
}
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[Feature] Added concurrent info for single progress bars#148

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

 Open

gregormaclaine
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


[Feature] Added concurrent info for single progress bars
#148
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
258e176

Added concurrent information to single bars


gregormaclaine Aug 2, 2023
02f47dc

Added example for single bar with concurrent info


gregormaclaine Aug 2, 2023
9b7d4cb

Prevent user from using concurrent info in multibars


gregormaclaine Aug 2, 2023
95b6759

Update README.md to include concurrent info


gregormaclaine Aug 2, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,5 @@ node_modules*
.tmp*
intern_*
dev.js
yarn-error.log
yarn-error.log
.DS_Store

23 changes: 23 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ Features
* Preset/Theme support
* Custom bar formatters (via callback)
* Logging during multibar operation
* Concurrent updatable progress information below progressbar

Usage
------------
Expand DownExpand Up@@ -160,6 +161,28 @@ Note: you may want to increase `etaBuffer` size - otherwise it can cause `INF` e
<instance>.updateETA();
```

### ::setConcurrentInfo()

Sets the text that is written below the progress bar that can be updated while the process is continuing.

For example, the text could track which file is currently being downloaded during a multi-file synchronous download process.

```js
const currentFile = filenames[i];
<instance>.setConcurrentInfo(` --> Downloading ${currentFile}...`);
```

Concurrent Info example:

![](assets/concurrent-info.png)

### ::clearCurrentInfo()

Clears any concurrent text written below the progress bar.

```js
<instance>.clearConcurrentInfo();
```

Multi Bar Mode
-----------------------------------
Expand Down
Binary file addedassets/concurrent-info.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

36 changes: 36 additions & 0 deletions
examples/example-concurrent-info.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
const cli_progress = require('../cli-progress');

// Generate random file names using random hexadecimal names
const random_file_names = Array(10).fill(0).map(() => 
 Math.floor(Math.random() * Math.pow(16, 6)).toString(16) + '.txt'
);

const bar = new cli_progress.Bar({
 format: 'Files [{bar}] | {percentage}% | {value}/{total}',
 hideCursor: true,
 barCompleteChar: '\u2588',
 barIncompleteChar: '\u2591',
 stopOnComplete: true,

 // If clear on complete then both bar and info are cleared
 // clearOnComplete: true,

 // forceRedraw: true
});

console.log('Downloading files..');
bar.start(200, 0);

const timer = setInterval(() => {
 if (bar.value < bar.total) {
 bar.increment();

 const current_file = random_file_names[Math.floor(bar.value / 20)];
 bar.setConcurrentInfo(` --> Downloading ${current_file}...`);
 }

 if (!bar.isActive) {
 clearInterval(timer);
 console.log('Download complete!\n');
 }
}, 15);

63 changes: 62 additions & 1 deletion
lib/generic-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,25 @@ module.exports = class GenericBar extends _EventEmitter{

 // use default formatter or custom one ?
 this.formatter = (typeof this.options.format === 'function') ? this.options.format : _formatter;

 /**
 * Whether the progress bar should be able to show concurrent info or not.
 * E.g. In multibars, each bar should not be able to have concurrent text
 * @type {boolean}
 */
 this.allowConcurrentInfo = this.options.allowConcurrentInfo;

 /**
 * The information to show below progress bar
 * @type {string | null}
 */
 this.concurrentInfo = null;

 /**
 * The concurrent information has changed and should be rerendered next render
 * @type {boolean}
 */
 this.concurrentInfoUpdated = false;
 }

 // internal render function
Expand DownExpand Up@@ -77,7 +96,7 @@ module.exports = class GenericBar extends _EventEmitter{
 || (this.options.noTTYOutput && !this.terminal.isTTY());

 // string changed ? only trigger redraw on change!
 if (forceRedraw || this.lastDrawnString != s){
 if (forceRedraw || this.lastDrawnString != s || this.concurrentInfoUpdated) {
 // trigger event
 this.emit('redraw-pre');

Expand All@@ -93,6 +112,22 @@ module.exports = class GenericBar extends _EventEmitter{
 // store string
 this.lastDrawnString = s;

 // check if concurrent text needs to be rendered
 if (this.concurrentInfo !== null) {
 // reset cursor to start of next line
 this.terminal.cursorRelative(-s.length, 1);

 // write concurrent info text
 this.terminal.write(this.concurrentInfo);
 this.terminal.clearRight();

 // reset cursor to previous line
 this.terminal.cursorRelative(0, -1);

 // concurrent info is now up to date
 this.concurrentInfoUpdated = false;
 }

 // set last redraw time
 this.lastRedraw = Date.now();

Expand DownExpand Up@@ -231,4 +266,30 @@ module.exports = class GenericBar extends _EventEmitter{
 // add new value; recalculate eta
 this.eta.update(Date.now(), this.value, this.total);
 }

 /**
 * Sets the information that is given as additional concurrent information
 * below the progress bar. It is cleared once the bar completes.
 * @param {string} text The info shown below the progress bar
 */
 setConcurrentInfo(text) {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== text;
 this.concurrentInfo = text;
 }

 /**
 * Clears the additional concurrent information.
 */
 clearConcurrentInfo() {
 if (!this.allowConcurrentInfo) {
 return;
 }

 this.concurrentInfoUpdated = this.concurrentInfo !== '';
 this.concurrentInfo = '';
 }
}

7 changes: 5 additions & 2 deletions
lib/multi-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,12 @@ module.exports = class MultiBar extends _EventEmitter{
 // global options
 this.options, 

 // terminal instance
 {
 terminal: this.terminal
 // terminal instance
 terminal: this.terminal,

 // concurrent text in multibars is not defined behaviour
 allowConcurrentInfo: false
 },

 // overrides
Expand Down

2 changes: 2 additions & 0 deletions
lib/options.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,8 @@ module.exports = {
 // autopadding character - empty in case autopadding is disabled
 options.autopaddingChar = options.autopadding ? mergeOption(options.autopaddingChar, ' ') : '';

 options.allowConcurrentInfo = 'allowConcurrentInfo' in options ? options.allowConcurrentInfo : true;

 return options;
 }
};

9 changes: 7 additions & 2 deletions
lib/single-bar.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,10 +131,15 @@ module.exports = class SingleBar extends _GenericBar{

 // clear line on complete ?
 if (this.options.clearOnComplete){
 // clear progress bar (And any information below) and remain on same line
 this.terminal.cursorTo(0, null);
 this.terminal.clearBottom();
 } else if (this.concurrentInfo) {
 // clear the concurrent information and begin on new line
 this.terminal.cursorRelative(0, 1);
 this.terminal.clearLine();
 }else{
 // new line on complete
 }else{
 // start on next line
 this.terminal.newline();
 }
 }
Expand Down