readline: support TERM=dumb

When TERM=dumb and .isTTY=true don't use ANSI escape codes and ignore all keys, except 'escape', 'return' and 'ctrl-c'. PR-URL: #26261 Fixes: #26187 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
nodejs · Mar 21, 2019 · d3a62fe7fc683bf74b3e9c743f73471f0167bd15 · d3a62fe
1 parent 9952375
commit d3a62fe7fc683bf74b3e9c743f73471f0167bd15
Showing with 75 additions and 7 deletions.

+51 −7 lib/readline.js

+21 −0 test/pseudo-tty/readline-dumb-tty.js

+3 −0 test/pseudo-tty/readline-dumb-tty.out
diff --git a/lib/readline.js b/lib/readline.js
@@ -34,7 +34,6 @@ const {
 const { validateString } = require('internal/validators');
 const { inspect } = require('util');
 const { emitExperimentalWarning } = require('internal/util');
-const { Buffer } = require('buffer');
 const EventEmitter = require('events');
 const {
   CSI,
@@ -161,6 +160,10 @@ function Interface(input, output, completer, terminal) {
 
   this.terminal = !!terminal;
 
+  if (process.env.TERM === 'dumb') {
+    this._ttyWrite = _ttyWriteDumb.bind(this);
+  }
+
   function ondata(data) {
     self._normalWrite(data);
   }
@@ -276,7 +279,7 @@ Interface.prototype._setRawMode = function(mode) {
 
 Interface.prototype.prompt = function(preserveCursor) {
   if (this.paused) this.resume();
-  if (this.terminal) {
+  if (this.terminal && process.env.TERM !== 'dumb') {
     if (!preserveCursor) this.cursor = 0;
     this._refreshLine();
   } else {
@@ -417,7 +420,11 @@ Interface.prototype.resume = function() {
 
 Interface.prototype.write = function(d, key) {
   if (this.paused) this.resume();
-  this.terminal ? this._ttyWrite(d, key) : this._normalWrite(d);
+  if (this.terminal) {
+    this._ttyWrite(d, key);
+  } else {
+    this._normalWrite(d);
+  }
 };
 
 Interface.prototype._normalWrite = function(b) {
@@ -789,6 +796,46 @@ Interface.prototype._moveCursor = function(dx) {
   }
 };
 
+function _ttyWriteDumb(s, key) {
+  key = key || {};
+
+  if (key.name === 'escape') return;
+
+  if (this._sawReturnAt && key.name !== 'enter')
+    this._sawReturnAt = 0;
+
+  if (key.ctrl && key.name === 'c') {
+    if (this.listenerCount('SIGINT') > 0) {
+      this.emit('SIGINT');
+    } else {
+      // This readline instance is finished
+      this.close();
+    }
+  }
+
+  switch (key.name) {
+    case 'return':  // carriage return, i.e. \r
+      this._sawReturnAt = Date.now();
+      this._line();
+      break;
+
+    case 'enter':
+      // When key interval > crlfDelay
+      if (this._sawReturnAt === 0 ||
+          Date.now() - this._sawReturnAt > this.crlfDelay) {
+        this._line();
+      }
+      this._sawReturnAt = 0;
+      break;
+
+    default:
+      if (typeof s === 'string' && s) {
+        this.line += s;
+        this.cursor += s.length;
+        this._writeToOutput(s);
+      }
+  }
+}
 
 // handle a write from the tty
 Interface.prototype._ttyWrite = function(s, key) {
@@ -1007,10 +1054,7 @@ Interface.prototype._ttyWrite = function(s, key) {
         // falls through
 
       default:
-        if (s instanceof Buffer)
-          s = s.toString('utf-8');
-
-        if (s) {
+        if (typeof s === 'string' && s) {
           var lines = s.split(/\r\n|\n|\r/);
           for (var i = 0, len = lines.length; i < len; i++) {
             if (i > 0) {

diff --git a/test/pseudo-tty/readline-dumb-tty.js b/test/pseudo-tty/readline-dumb-tty.js
@@ -0,0 +1,21 @@
+'use strict';
+require('../common');
+
+process.env.TERM = 'dumb';
+
+const readline = require('readline');
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+rl.write('text');
+rl.write(null, { ctrl: true, name: 'u' });
+rl.write(null, { name: 'return' });
+rl.write('text');
+rl.write(null, { name: 'backspace' });
+rl.write(null, { name: 'escape' });
+rl.write(null, { name: 'enter' });
+rl.write('text');
+rl.write(null, { ctrl: true, name: 'c' });
diff --git a/test/pseudo-tty/readline-dumb-tty.out b/test/pseudo-tty/readline-dumb-tty.out
@@ -0,0 +1,3 @@
+text
+text
+text