Skip to content

lib: support dumb terminals #26261

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

Closed
wlodzislav wants to merge 8 commits into from
Closed

lib: support dumb terminals #26261

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1c0ba10
console: don't use ANSI escape codes when TERM=dumb
wlodzislav Feb 22, 2019
1b7434d
readline: support TERM=dumb
wlodzislav Feb 22, 2019
6aa691d
repl: don't color output when TERM=dumb
wlodzislav Feb 22, 2019
826bab4
repl: fix unnecessary check
wlodzislav Feb 22, 2019
4113cfe
readline: remove _ttyWriteDumb from prototype
wlodzislav Feb 22, 2019
1468212
readline: remove unnecessary Buffer check
wlodzislav Feb 22, 2019
26fcf31
readline: not empty string check in _ttyWrite*
wlodzislav Feb 22, 2019
03994a0
repl: check colors with .getColorDepth()
wlodzislav Mar 5, 2019
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
Prev Previous commit
Next Next commit
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'.

Fixes: #26187
  • Loading branch information
@wlodzislav
wlodzislav committed Mar 5, 2019
commit 1b7434df9054dfeee3aa049f1a9284cc0a50777e
61 changes: 58 additions & 3 deletions lib/readline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,11 @@ function Interface(input, output, completer, terminal) {
}

function onkeypress(s, key) {
self._ttyWrite(s, key);
if (process.env.TERM === 'dumb') {
self._ttyWriteDumb(s, key);
} else {
self._ttyWrite(s, key);
}
Comment thread
BridgeAR marked this conversation as resolved.
Resolved
if (key && key.sequence) {
// If the key.sequence is half of a surrogate pair
// (>= 0xd800 and <= 0xdfff), refresh the line so
Expand Down Expand Up @@ -276,7 +280,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 {
Expand Down Expand Up @@ -417,7 +421,15 @@ 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) {
if (process.env.TERM === 'dumb') {
this._ttyWriteDumb(d, key);
} else {
this._ttyWrite(d, key);
}
} else {
this._normalWrite(d);
}
};

Interface.prototype._normalWrite = function(b) {
Expand Down Expand Up @@ -789,6 +801,49 @@ Interface.prototype._moveCursor = function(dx) {
}
};

Interface.prototype._ttyWriteDumb = function(s, key) {
Comment thread
BridgeAR marked this conversation as resolved.
Resolved
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 (s instanceof Buffer)
s = s.toString('utf-8');
Comment thread
BridgeAR marked this conversation as resolved.
Resolved

if (s) {
Comment thread
BridgeAR marked this conversation as resolved.
Resolved
this.line += s;
this.cursor += s.length;
this._writeToOutput(s);
}
}
};

// handle a write from the tty
Interface.prototype._ttyWrite = function(s, key) {
Expand Down
21 changes: 21 additions & 0 deletions test/pseudo-tty/readline-dumb-tty.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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' });
3 changes: 3 additions & 0 deletions test/pseudo-tty/readline-dumb-tty.out
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
text
text
text