xprogress 0.20.0 → 0.21.0

package/index.js

@@ -44,6 +44,7 @@ const globOpts = {
     'color:bar:separator': '',
   },
   forceFirst: !1,
+  keepHeader: !1,
 };
 
 const defaultOptions = {
@@ -54,7 +55,7 @@ const defaultOptions = {
 const streamOpts = {
   ...globOpts,
   pulsate: false,
-  progress: {time: 100, pulsate: false, infinite: !1, pulsateSkip: 15, pulsateLength: 15},
+  progress: {time: 200, pulsate: false, infinite: !1, pulsateSkip: 15, pulsateLength: 15},
   template: [
     ':{label}',
     ' |:{slot:bar}| [:3{slot:percentage}%] (:{slot:eta}) [:{speed}] [:{slot:size}/:{slot:size:total}]',
@@ -123,7 +124,8 @@ function parseBar(opts, fillable, percentage, headers = !opts.pulsate) {
   let empty = fillable - filled;
   let {filler, blank, header} = opts.bar;
   [filled, empty] = [filled, empty].map(Math.floor);
-  [filler, blank] = [filler, blank].map(content => (Array.isArray(content) || typeof content === 'string' ? content : ''));
+  [filler, blank] = [filler, blank].map(content => (typeof content === 'string' ? content : '?'));
+  if (!opts.keepHeader && headers && empty === 0) (filled += header.length), (headers = null);
   return stringd(
     [
       `:{color:bar:filled}${filler.repeat(filled)}`,
@@ -165,6 +167,28 @@ function pulsateBar(bar, slots, skip, sep = '') {
   return stack.map(({fillable, percentage}) => parseBar(bar.opts, fillable, percentage, false));
 }
 
+// eslint-disable-next-line no-control-regex
+const ANSI_RE = /\x1b\[[^m]*m/g;
+function trimLine(line, cols) {
+  let visible = 0;
+  let i = 0;
+  let result = '';
+  while (i < line.length) {
+    ANSI_RE.lastIndex = i;
+    const ansi = ANSI_RE.exec(line);
+    if (ansi && ansi.index === i) {
+      result += ansi[0];
+      i += ansi[0].length;
+      continue;
+    }
+    if (visible >= cols) break;
+    result += line[i];
+    visible++;
+    i++;
+  }
+  return visible < line.replace(ANSI_RE, '').length ? `${result}\x1b[0m` : result;
+}
+
 class ProgressGen extends EventEmitter {}
 
 export default class ProgressBar {
@@ -213,6 +237,20 @@ export default class ProgressBar {
     delete this.opts.label;
     delete this.opts.append;
     delete this.opts.length;
+    this.#resizeHandler = () => {
+      if (!this.hasBarredOnce || this.isEnded) return;
+      const stdout = this.cores.stdout;
+      this.#resizing = true;
+      stdout.moveCursor(0, -(this.oldBar.length - 1));
+      stdout.cursorTo(0);
+      stdout.clearScreenDown();
+      clearTimeout(this.#resizeTimer);
+      this.#resizeTimer = setTimeout(() => {
+        this.#resizing = false;
+        this.draw(this.oldBar);
+      }, 100);
+    };
+    this.cores.stdout?.on('resize', this.#resizeHandler);
   }
 
   /**
@@ -384,19 +422,28 @@ export default class ProgressBar {
    * @param {String|Object} [template] The template to use on the drawn progress bar or an array of predrawn progressbar from `this.constructBar` like `this.oldBar`
    */
   draw(template) {
+    if (!Array.isArray(template))
+      this.cores.append = this.cores.append.filter(block => !(block.bar.opts.clean && block.bar.isComplete()));
     const result = Array.isArray(template)
       ? template
       : [
           ...this.constructBar(template).split('\n'),
           ...this.cores.append.map(block => block.bar.constructBar(block.inherit ? template : null)),
         ];
+    const prevLength = this.hasBarredOnce ? this.oldBar.length : 0;
     this.oldBar = result;
-    this.print(`bar${result.length ? `+${result.length - 1}` : ''}`, result.join('\n'));
+    if (!this.#resizing) {
+      this.#printLines(result, this.justLogged, prevLength ? prevLength - 1 : 0);
+      this.justLogged = false;
+    }
     this.hasBarredOnce = !0;
     return this;
   }
 
   #flipperCount = 0;
+  #resizeHandler = null;
+  #resizeTimer = null;
+  #resizing = false;
 
   constructBar(template) {
     const forcedFirst = [
@@ -446,45 +493,40 @@ export default class ProgressBar {
     return stringd(stringd(str, template), variables);
   }
 
+  #printLines(lines, dontClean, addons = 0, ending = false) {
+    const stdout = this.cores.stdout;
+    if (!dontClean) {
+      // check https://github.com/freeall/single-line-log/blob/515b3b99b699396c2ad5f937e4b490b6f9fbff0e/index.js#L1-L3
+      stdout.moveCursor(0, -addons);
+      stdout.cursorTo(0);
+      stdout.clearScreenDown();
+    }
+    const cols = stdout.columns;
+    // eslint-disable-next-line no-control-regex
+    const strip = this.opts.bar.colorize ? l => l : l => l.replace(/\x1b\[\d+m/g, '');
+    stdout.write(
+      `${dontClean && ending && (addons || this.hasBarredOnce) ? '\n' : ''}${lines
+        .map(line => trimLine(strip(line), cols))
+        .join('\n')}`,
+    );
+  }
+
   /**
    * Print a message after a bar `draw` interrupt
-   * @param {'bar'|'end'} type Type of bar print or the first part of the printer
    * @param {any[]} content The contents to be formatted
    */
   print(type, ...content) {
-    const self = this;
+    if (this.isChild) return this.cores.parent.print(type, ...content);
     type = format(type);
-    if (!self.cores.stdout.isTTY) throw Error("Can't draw or print progressBar interrupts with piped output");
-    const cleanWrite = function cleanWrite(arr, dontClean, addons = 0, ending = false, normie = false) {
-      if (!dontClean) {
-        // check https://github.com/freeall/single-line-log/blob/515b3b99b699396c2ad5f937e4b490b6f9fbff0e/index.js#L1-L3
-        self.cores.stdout.moveCursor(0, -addons);
-        self.cores.stdout.cursorTo(0);
-        self.cores.stdout.clearScreenDown();
-      }
-      (normie ? process.stdout : self.cores.stdout).write(
-        `${dontClean && ending && addons ? '\n' : ''}${self
-          .parseString(format(...arr))
-          // eslint-disable-next-line no-control-regex
-          .replace(self.opts.bar.colorize ? '' : /\x1b\[\d+m/g, '')}`,
-      );
-    };
-    let addonPack;
+    if (!this.cores.stdout.isTTY) throw Error("Can't draw or print progressBar interrupts with piped output");
     const addons = this.hasBarredOnce && !this.justLogged ? this.oldBar.length - 1 : 0;
+    const lines = this.parseString(
+      type === 'end' ? format(...content) : format((type.startsWith(':') && type.slice(1)) || type, ...content, '\n'),
+    ).split('\n');
     this.justLogged =
-      type === 'bar' && content.length === 1
-        ? !!cleanWrite(content, this.justLogged, addons)
-        : (addonPack = type.match(/^bar\+(\d+)/)) !== null
-        ? !!cleanWrite(content, this.justLogged, this.hasBarredOnce ? addonPack[1] : addons)
-        : type === 'end'
-        ? !!cleanWrite(content, !this.opts.clean, addons, true, true)
-        : !cleanWrite(
-            [(type.startsWith(':') && `${type.slice(1)}`) || type, ...content, '\n'],
-            this.justLogged,
-            addons,
-            false,
-            true,
-          );
+      type === 'end'
+        ? !!this.#printLines(lines, !this.opts.clean, addons, true)
+        : !this.#printLines(lines, this.justLogged, addons);
     if (this.justLogged && this.hasBarredOnce) this.draw(this.oldBar);
     return this;
   }
@@ -495,8 +537,14 @@ export default class ProgressBar {
    */
   end(...message) {
     if (!this.isEnded) {
-      if (message.length) this.print('end', ...message);
+      if (message.length) {
+        if (this.isChild) this.cores.parent.print(...message);
+        else this.print('end', ...message);
+      }
       this.isEnded = !0;
+      this.#resizing = false;
+      clearTimeout(this.#resizeTimer);
+      this.cores.stdout?.off('resize', this.#resizeHandler);
     }
     return this;
   }
@@ -515,6 +563,21 @@ export default class ProgressBar {
    */
   drop() {}
 
+  /**
+   * Insert a bar immediately after an existing appended bar
+   * @param {ProgressBar} anchor The bar after which to insert
+   * @param {ProgressBar} bar The bar to insert
+   * @param {Boolean} inherit Whether or not to inherit bar templates from `this`
+   */
+  insertAfter(anchor, bar, inherit = !1) {
+    const idx = this.cores.append.findIndex(a => a.bar === anchor);
+    if (idx === -1) throw Error('Anchor bar not found');
+    const tail = this.cores.append.splice(idx + 1);
+    this.append(bar, inherit);
+    this.cores.append.push(...tail);
+    return this;
+  }
+
   /**
    * Append the specified bar after `this`
    * @param {ProgressBar} bar The bar to be appended
@@ -524,6 +587,8 @@ export default class ProgressBar {
     if (!ProgressBar.isBar(bar) && !bar.opts.template) throw Error('The Parameter <bar> is not a progressbar or a hanger');
     this.cores.append.push({bar, inherit});
     bar.cores.isKid = !0;
+    bar.cores.parent = this;
+    bar.cores.stdout?.off('resize', bar.#resizeHandler);
     return this;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xprogress",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS",
   "exports": "./index.js",
   "type": "module",
@@ -50,7 +50,7 @@
     "progress-stream": "^2.0.0",
     "speedometer": "^1.1.0",
     "stringd": "^2.2.0",
-    "stringd-colors": "^1.10.0",
+    "stringd-colors": "^1.11.0",
     "xbytes": "^1.6.1"
   }
 }