Fixes #274: remove internal use of process.stdout (#275)

* Fix(select, multiselect) duplicate output when stdout is redirected (fixes #274) * Remove process.stdout from util functions internals
terkelg · Oct 6, 2020 · 9628ebe · 9628ebe
1 parent a90d118
commit 9628ebe
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 22 deletions.
diff --git a/lib/elements/autocomplete.js b/lib/elements/autocomplete.js
@@ -47,7 +47,7 @@ class AutocompletePrompt extends Prompt {
     this.scale = this.transform.scale;
     this.render = this.render.bind(this);
     this.complete = this.complete.bind(this);
-    this.clear = clear('');
+    this.clear = clear('', this.out.columns);
     this.complete(this.render);
     this.render();
   }
@@ -216,7 +216,7 @@ class AutocompletePrompt extends Prompt {
   render() {
     if (this.closed) return;
     if (this.firstRender) this.out.write(cursor.hide);
-    else this.out.write(clear(this.outputText));
+    else this.out.write(clear(this.outputText, this.out.columns));
     super.render();
 
     let { startIndex, endIndex } = entriesToDisplay(this.select, this.choices.length, this.limit);

diff --git a/lib/elements/autocompleteMultiselect.js b/lib/elements/autocompleteMultiselect.js
@@ -21,7 +21,7 @@ class AutocompleteMultiselectPrompt extends MultiselectPrompt {
     opts.overrideRender = true;
     super(opts);
     this.inputValue = '';
-    this.clear = clear('');
+    this.clear = clear('', this.out.columns);
     this.filteredOptions = this.value;
     this.render();
   }
@@ -187,7 +187,7 @@ Filtered results for: ${this.inputValue ? this.inputValue : color.gray('Enter so
     prompt += this.renderOptions(this.filteredOptions);
 
     this.out.write(this.clear + prompt);
-    this.clear = clear(prompt);
+    this.clear = clear(prompt, this.out.columns);
   }
 }
 

diff --git a/lib/elements/confirm.js b/lib/elements/confirm.js
@@ -67,7 +67,7 @@ class ConfirmPrompt extends Prompt {
   render() {
     if (this.closed) return;
     if (this.firstRender) this.out.write(cursor.hide);
-    else this.out.write(clear(this.outputText));
+    else this.out.write(clear(this.outputText, this.out.columns));
     super.render();
 
     this.outputText = [

diff --git a/lib/elements/date.js b/lib/elements/date.js
@@ -50,7 +50,7 @@ class DatePrompt extends Prompt {
     this.errorMsg = opts.error || 'Please Enter A Valid Value';
     this.validator = opts.validate || (() => true);
     this.mask = opts.mask || 'YYYY-MM-DD HH:mm:ss';
-    this.clear = clear('');
+    this.clear = clear('', this.out.columns);
     this.render();
   }
 
@@ -180,7 +180,7 @@ class DatePrompt extends Prompt {
   render() {
     if (this.closed) return;
     if (this.firstRender) this.out.write(cursor.hide);
-    else this.out.write(clear(this.outputText));
+    else this.out.write(clear(this.outputText, this.out.columns));
     super.render();
 
     // Print prompt

diff --git a/lib/elements/multiselect.js b/lib/elements/multiselect.js
@@ -42,7 +42,7 @@ class MultiselectPrompt extends Prompt {
         disabled: ch && ch.disabled
       };
     });
-    this.clear = clear('');
+    this.clear = clear('', this.out.columns);
     if (!opts.overrideRender) {
       this.render();
     }
@@ -260,7 +260,7 @@ class MultiselectPrompt extends Prompt {
     prompt += this.renderOptions(this.value);
 
     this.out.write(this.clear + prompt);
-    this.clear = clear(prompt);
+    this.clear = clear(prompt, this.out.columns);
   }
 }
 

diff --git a/lib/elements/number.js b/lib/elements/number.js
@@ -181,8 +181,8 @@ class NumberPrompt extends Prompt {
     if (this.closed) return;
     if (!this.firstRender) {
       if (this.outputError)
-        this.out.write(cursor.down(lines(this.outputError) - 1) + clear(this.outputError));
-      this.out.write(clear(this.outputText));
+        this.out.write(cursor.down(lines(this.outputError, this.out.columns) - 1) + clear(this.outputError, this.out.columns));
+      this.out.write(clear(this.outputText, this.out.columns));
     }
     super.render();
     this.outputError = '';

diff --git a/lib/elements/select.js b/lib/elements/select.js
@@ -36,7 +36,7 @@ class SelectPrompt extends Prompt {
     });
     this.optionsPerPage = opts.optionsPerPage || 10;
     this.value = (this.choices[this.cursor] || {}).value;
-    this.clear = clear('');
+    this.clear = clear('', this.out.columns);
     this.render();
   }
 
@@ -116,7 +116,7 @@ class SelectPrompt extends Prompt {
   render() {
     if (this.closed) return;
     if (this.firstRender) this.out.write(cursor.hide);
-    else this.out.write(clear(this.outputText));
+    else this.out.write(clear(this.outputText, this.out.columns));
     super.render();
 
     let { startIndex, endIndex } = entriesToDisplay(this.cursor, this.choices.length, this.optionsPerPage);

diff --git a/lib/elements/text.js b/lib/elements/text.js
@@ -25,7 +25,7 @@ class TextPrompt extends Prompt {
     this.value = ``;
     this.errorMsg = opts.error || `Please Enter A Valid Value`;
     this.cursor = Number(!!this.initial);
-    this.clear = clear(``);
+    this.clear = clear(``, this.out.columns);
     this.render();
   }
 
@@ -156,8 +156,8 @@ class TextPrompt extends Prompt {
     if (this.closed) return;
     if (!this.firstRender) {
       if (this.outputError)
-        this.out.write(cursor.down(lines(this.outputError) - 1) + clear(this.outputError));
-      this.out.write(clear(this.outputText));
+        this.out.write(cursor.down(lines(this.outputError, this.out.columns) - 1) + clear(this.outputError, this.out.columns));
+      this.out.write(clear(this.outputText, this.out.columns));
     }
     super.render();
     this.outputError = '';

diff --git a/lib/elements/toggle.js b/lib/elements/toggle.js
@@ -95,7 +95,7 @@ class TogglePrompt extends Prompt {
   render() {
     if (this.closed) return;
     if (this.firstRender) this.out.write(cursor.hide);
-    else this.out.write(clear(this.outputText));
+    else this.out.write(clear(this.outputText, this.out.columns));
     super.render();
 
     this.outputText = [

diff --git a/lib/util/clear.js b/lib/util/clear.js
@@ -5,7 +5,11 @@ const { erase, cursor } = require('sisteransi');
 
 const width = str => [...strip(str)].length;
 
-module.exports = function(prompt, perLine = process.stdout.columns) {
+/**
+ * @param {string} prompt
+ * @param {number} perLine
+ */
+module.exports = function(prompt, perLine) {
   if (!perLine) return erase.line + cursor.to(0);
 
   let rows = 0;

diff --git a/lib/util/lines.js b/lib/util/lines.js
@@ -2,7 +2,11 @@
 
 const strip = require('./strip');
 
-module.exports = function (msg, perLine = process.stdout.columns) {
+/**
+ * @param {string} msg
+ * @param {number} perLine
+ */
+module.exports = function (msg, perLine) {
   let lines = String(strip(msg) || '').split(/\r?\n/);
 
   if (!perLine) return lines.length;

diff --git a/lib/util/wrap.js b/lib/util/wrap.js
@@ -2,16 +2,16 @@
 
 /**
  * @param {string} msg The message to wrap
- * @param {object} [opts]
+ * @param {object} opts
  * @param {number|string} [opts.margin] Left margin
- * @param {number} [opts.width] Maximum characters per line including the margin
+ * @param {number} opts.width Maximum characters per line including the margin
  */
 module.exports = (msg, opts = {}) => {
   const tab = Number.isSafeInteger(parseInt(opts.margin))
     ? new Array(parseInt(opts.margin)).fill(' ').join('')
     : (opts.margin || '');
 
-  const width = opts.width || process.stdout.columns;
+  const width = opts.width;
 
   return (msg || '').split(/\r?\n/g)
     .map(line => line