fix: make completer SIGWINCH aware

Signed-off-by: Snehil Shah <snehilshah.989@gmail.com>

lib/node_modules/@stdlib/repl/lib/completer_engine.js

@@ -26,7 +26,8 @@ var readline = require( 'readline' );
 var logger = require( 'debug' );
 var setNonEnumerableReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
 var lowercase = require( '@stdlib/string/lowercase' );
-var max = require( '@stdlib/stats/base/max' );
+var maxInArray = require( '@stdlib/stats/base/max' );
+var max = require( '@stdlib/math/base/special/max' );
 var min = require( '@stdlib/math/base/special/min' );
 var floor = require( '@stdlib/math/base/special/floor' );
 var ceil = require( '@stdlib/math/base/special/ceil' );
@@ -43,6 +44,7 @@ var commonPrefix = require( './longest_common_prefix.js' );
 
 var debug = logger( 'repl:completer:engine' );
 var RE_ANSI = /[\u001B\u009B][[\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\d/#&.:=?%@~_]+)*|[a-zA-Z\d]+(?:;[-a-zA-Z\d/#&.:=?%@~_]*)*)?\u0007)|(?:(?:\d{1,4}(?:;\d{0,4})*)?[\dA-PR-TZcf-nq-uy=><~]))/g; // eslint-disable-line no-control-regex
+var RESERVED_COMPLETER_ROWS = 2; // input prompt + empty line
 
 
 // FUNCTIONS //
@@ -135,6 +137,7 @@ function CompleterEngine( repl, completer, ostream, ttyWrite ) {
 * @private
 * @name _completionCallback
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {Function} completion callback
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionCallback', function completionCallback() {
@@ -201,6 +204,13 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionCallback', func
 		}
 		debug( 'No auto-completion candidate, displaying all possible completions.' );
 
+		// Check if completions can be displayed...
+		if ( !self._isDisplayable() ) {
+			debug( 'TTY height too short. exiting completer...' );
+			self._rli.resume();
+			return;
+		}
+
 		// Display completions:
 		self._displayCompletions();
 		self._isNavigating = true;
@@ -216,6 +226,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionCallback', func
 * @private
 * @name _displayCompletions
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {void}
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_displayCompletions', function displayCompletions() {
@@ -228,7 +239,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_displayCompletions', func
 	for ( i = 0; i < this._completionsList.length; i++ ) {
 		this._completionsLength.push( this._completionsList[ i ].length );
 	}
-	this._widthOfColumn = max( this._completionsLength.length, this._completionsLength, 1 ) + 4; // eslint-disable-line max-len
+	this._widthOfColumn = maxInArray( this._completionsLength.length, this._completionsLength, 1 ) + 4; // eslint-disable-line max-len
 
 	// Highlight completions if operating in "terminal" mode...
 	if ( this.repl._isTTY ) {
@@ -255,6 +266,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_displayCompletions', func
 * @private
 * @name _updateCompletions
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {void}
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_updateCompletions', function updateCompletions() {
@@ -290,6 +302,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_updateCompletions', funct
 * @private
 * @name _drawOutput
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {number} rows - number of rows in output grid
 * @param {number} columns - number of columns in output grid
 * @returns {string} output string
@@ -307,11 +320,12 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_drawOutput', function dra
 	whitespaces = 0;
 	for ( i = 0; i < this._highlightedCompletions.length; i++ ) {
 		completion = this._highlightedCompletions[ i ];
+
+		// If completions start overflowing the maximum allowed rows, stop writing to output...
+		if ( i >= rows * columns ) {
+			break;
+		}
 		if ( lineIndex >= columns ) {
-			// If completions start overflowing the maximum allowed rows, stop writing to output...
-			if ( i >= rows * columns ) {
-				break;
-			}
 			// Reached end of column, enter next line:
 			output += '\r\n';
 			lineIndex = 0;
@@ -340,6 +354,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_drawOutput', function dra
 * @private
 * @name _highlightCompletions
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {Array<string>} array of highlighted completions
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_highlightCompletions', function highlightCompletions() {
@@ -397,6 +412,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_highlightCompletions', fu
 *
 * @name _completionColumns
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {number} number of columns
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionColumns', function completionColumns() {
@@ -408,23 +424,38 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionColumns', funct
 *
 * @name _completionRows
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {number} columns - number of columns in the completions output grid
 * @returns {number} number of rows
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_completionRows', function completionRows( columns ) {
-	var maxRows = this.repl.viewportHeight() - 2; // two rows reserved for the input prompt and an empty line at the end of viewport
+	var maxRows = max( this.repl.viewportHeight() - RESERVED_COMPLETER_ROWS, 0 ); // eslint-disable-line max-len
 	var rows = ceil( this._completionsList.length / columns );
 
 	// Truncate number of completion rows to fit the viewport:
 	return min( rows, maxRows );
 });
 
+/**
+* Checks whether content having a specified number of lines is unable to fit within the current viewport.
+*
+* @private
+* @name _isDisplayable
+* @memberof CompleterEngine.prototype
+* @type {Function}
+* @returns {boolean} boolean indicating whether content is "displayable"
+*/
+setNonEnumerableReadOnly( CompleterEngine.prototype, '_isDisplayable', function isDisplayable() {
+	return this.repl.viewportHeight() > RESERVED_COMPLETER_ROWS;
+});
+
 /**
 * Closes completer engine.
 *
 * @private
 * @name _closeCompleter
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {void}
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_closeCompleter', function closeCompleter() {
@@ -451,6 +482,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_closeCompleter', function
 * @private
 * @name _navigateUp
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {string} data - input data
 * @param {Object} key - key object
 * @returns {void}
@@ -479,6 +511,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_navigateUp', function nav
 * @private
 * @name _navigateDown
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @returns {void}
 */
 setNonEnumerableReadOnly( CompleterEngine.prototype, '_navigateDown', function navigateDown() {
@@ -501,6 +534,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_navigateDown', function n
 * @private
 * @name _navigateLeft
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {string} data - input data
 * @param {Object} key - key object
 * @returns {void}
@@ -525,6 +559,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_navigateLeft', function n
 * @private
 * @name _navigateRight
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {string} data - input data
 * @param {Object} key - key object
 * @returns {void}
@@ -548,6 +583,7 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, '_navigateRight', function
 *
 * @name beforeKeypress
 * @memberof CompleterEngine.prototype
+* @type {Function}
 * @param {string} data - input data
 * @param {Object} key - key object
 * @returns {void}
@@ -613,6 +649,25 @@ setNonEnumerableReadOnly( CompleterEngine.prototype, 'beforeKeypress', function
 	this._completer( this._inputLine, this._onCompletions, this._settings.fuzzyCompletions ); // eslint-disable-line max-len
 });
 
+/**
+* Callback which should be invoked upon a "resize" event.
+*
+* @name onResize
+* @memberof CompleterEngine.prototype
+* @type {Function}
+* @returns {void}
+*/
+setNonEnumerableReadOnly( CompleterEngine.prototype, 'onResize', function onResize() {
+	if ( !this._isNavigating ) {
+		return;
+	}
+	if ( !this._isDisplayable() ) {
+		this._closeCompleter();
+		return;
+	}
+	this._updateCompletions();
+});
+
 
 // EXPORTS //
 

lib/node_modules/@stdlib/repl/lib/main.js

@@ -277,7 +277,7 @@
 	setNonEnumerableReadOnly( this, '_ttyWrite', this._rli._ttyWrite );
 
 	// Overwrite the private `ttyWrite` method to allow processing input before a "keypress" event is triggered:
 	this._rli._ttyWrite = beforeKeypress; // WARNING: overwriting a private property
 
 	// Add event listeners:
 	this._rli.on( 'close', onClose );
@@ -297,9 +297,9 @@
 	// Write a welcome message:
 	this._wstream.write( opts.welcome );
 
 	// TODO: check whether to synchronously initialize a REPL history file
 
 	// TODO: check whether to synchronously initialize a REPL log file
 
 	// Check whether to load and execute a JavaScript file (e.g., prior REPL history) upon startup...
 	if ( opts.load ) {
@@ -387,6 +387,7 @@
 	function onSIGWINCH() {
 		debug( 'Received a SIGWINCH event. Terminal was resized.' );
 		self._ostream.onResize();
+		self._completerEngine.onResize();
 	}
 
 	/**
@@ -447,7 +448,7 @@
 		// Update the internal command history buffer: [..., <id>, <cmd>, <success>, ...]
 		self._history.push( self._count, cmd, success );
 
 		// TODO: if successful and if necessary, (asynchronously?) write the command to a history file (question: do we only want to write successful commands to the history file? maybe we need to option for limiting to successful commands?)
 
 		// TODO: if necessary, (asynchronously?) write the command and result to a log file (JSON serialization?)
 	}