fix: apply review comments

Signed-off-by: Snehil Shah <[email protected]>

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: Snehil-Shah

lib/node_modules/@stdlib/repl/base/ctor/lib/completer.js

@@ -84,7 +84,7 @@ function completer( repl ) {
 	return complete;
 
 	/**
-	* Callback invoked upon a user entering the TAB character at the command prompt.
+	* Generates completions for a given line.
 	*
 	* @private
 	* @param {string} line - current line

lib/node_modules/@stdlib/repl/base/ctor/lib/is_multiline_input.js

@@ -64,7 +64,7 @@ function isMultilineInput( input ) {
 		return false;
 	}
 	// Check if the command has valid syntax...
-	tmp = this._processCommand( input );
+	tmp = this.processCommand( input );
 	if ( !( tmp instanceof Error ) ) {
 		debug( 'Multi-line input not detected.' );
 		return false;

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

@@ -70,8 +70,6 @@ var debug = logger( 'repl' );
 * @returns {REPL} REPL instance
 *
 * @example
-* var REPL = require( '@stdlib/repl/base' );
-*
 * // Create a new REPL:
 * var repl = new REPL();
 *
@@ -189,11 +187,8 @@ function REPL( options ) {
 	// Create a REPL execution context:
 	setNonEnumerable( this, '_context', this.createContext() );
 
-	// Create a new TAB completer:
-	setNonEnumerableReadOnly( this, '_completer', completerFactory( this ) );
-
-	// Create a new tokenizer:
-	setNonEnumerableReadOnly( this, '_tokenizer', tokenizer );
+	// Create a new completer:
+	setNonEnumerableReadOnly( this, 'completer', completerFactory( this ) );
 
 	// Add listener for "command" events:
 	this.on( 'command', onCommand );
@@ -269,38 +264,95 @@ inherit( REPL, EventEmitter );
 /**
 * Checks if the given input is a possible multi-line command.
 *
-* @private
-* @name _isMultilineInput
+* @name isMultilineInput
 * @memberof REPL.prototype
 * @type {Function}
 * @param {string} input - input command
 * @returns {boolean} boolean indicating whether the given input is a possible multi-line command
+*
+* @example
+* // Create a new REPL:
+* var repl = new REPL();
+*
+* // Check if an input is a possible multi-line command:
+* var input = 'for( var i = 0; i < 10; i++ ) {';
+* var out = repl.isMultilineInput( input );
+*
+* // Close the REPL:
+* repl.close();
 */
-setNonEnumerableReadOnly( REPL.prototype, '_isMultilineInput', isMultilineInput );
+setNonEnumerableReadOnly( REPL.prototype, 'isMultilineInput', isMultilineInput );
 
 /**
-* Processes a "raw" input command..
+* Processes a "raw" input command.
 *
-* @private
-* @name _processCommand
+* @name processCommand
 * @memberof REPL.prototype
 * @type {Function}
 * @param {string} code - unevaluated command
 * @returns {(string|Error)} processed command or an error
+*
+* @example
+* // Create a new REPL:
+* var repl = new REPL();
+*
+* // Process raw command:
+* var code = 'var y = 10;';
+* var out = repl.processCommand( code );
+*
+* // Close the REPL:
+* repl.close();
 */
-setNonEnumerableReadOnly( REPL.prototype, '_processCommand', processCommand );
+setNonEnumerableReadOnly( REPL.prototype, 'processCommand', processCommand );
 
 /**
 * Compiles a command.
 *
 * @private
-* @name _compileCommand
+* @name compileCommand
 * @memberof REPL.prototype
 * @type {Function}
 * @param {string} cmd - command string
 * @returns {(Object|Error)} compiled command or an error
+*
+* @example
+* // Create a new REPL:
+* var repl = new REPL();
+*
+* // Process raw command:
+* var code = 'var y = 10;';
+* var cmd = repl.processCommand( code );
+*
+* // Compile processed command:
+* var out = repl.compileCommand( cmd );
+*
+* // Close the REPL:
+* repl.close();
+*/
+setNonEnumerableReadOnly( REPL.prototype, 'compileCommand', compileCommand );
+
+/**
+* Tokenizes the input line based on ECMAScript specification.
+*
+* @name tokenizer
+* @memberof REPL.prototype
+* @type {Function}
+* @param {string} line - input line
+* @param {Object} context - REPL context
+* @returns {Array} array of tokens
+*
+* @example
+* // Create a new REPL:
+* var repl = new REPL();
+*
+* // Tokenize an input line:
+* var line = 'var x = 5;';
+* var out = repl.tokenizer( line, {} );
+*
+* // Close the REPL:
+* repl.close();
 */
-setNonEnumerableReadOnly( REPL.prototype, '_compileCommand', compileCommand );
+setNonEnumerableReadOnly( REPL.prototype, 'tokenizer', tokenizer );
 
 /**
 * Creates a REPL context.

lib/node_modules/@stdlib/repl/base/ctor/lib/process_input.js

@@ -57,7 +57,7 @@ function processInput( repl, input ) {
 	} else {
 		// Check if the command has valid syntax...
 		debug( 'Processing command...' );
-		tmp = repl._processCommand( input );
+		tmp = repl.processCommand( input );
 		if ( tmp instanceof Error ) {
 			repl.emit( 'command', input, false, tmp, false ); // command failed
 			return;
@@ -67,7 +67,7 @@ function processInput( repl, input ) {
 
 	// Attempt to compile the command:
 	debug( 'Attempting to compile command...' );
-	code = repl._compileCommand( tmp );
+	code = repl.compileCommand( tmp );
 	if ( code instanceof Error ) {
 		debug( 'Error: %s', code.message );
 		repl.emit( 'command', input, false, code, false ); // command failed

lib/node_modules/@stdlib/repl/base/ctor/lib/validate.js

@@ -38,14 +38,14 @@ var format = require( '@stdlib/string/format' );
 * @private
 * @param {Object} opts - destination object
 * @param {Options} options - function options
-* @param {ReadableStream} [options.input=process.stdin] - input stream
-* @param {WritableStream} [options.output=process.stdout] - output stream
-* @param {WritableStream} [options.error=process.stderr] - error stream
-* @param {boolean} [options.sandbox=true] - boolean indicating whether to run a REPL in a sandboxed context
-* @param {PositiveInteger} [options.timeout=4294967295] - number of milliseconds to execute a command before terminating execution
+* @param {ReadableStream} [options.input] - input stream
+* @param {WritableStream} [options.output] - output stream
+* @param {WritableStream} [options.error] - error stream
+* @param {boolean} [options.sandbox] - boolean indicating whether to run a REPL in a sandboxed context
+* @param {PositiveInteger} [options.timeout] - number of milliseconds to execute a command before terminating execution
 * @param {string} [options.save] - file path specifying where to save REPL command history
 * @param {string} [options.log] - file path specifying where to save REPL commands and printed output
-* @param {string} [options.quiet=false] - boolean indicating whether log information, confirmation messages, and other possible REPL diagnostics should be silenced
+* @param {string} [options.quiet] - boolean indicating whether log information, confirmation messages, and other possible REPL diagnostics should be silenced
 * @returns {(Error|null)} error or null
 *
 * @example

lib/node_modules/@stdlib/repl/base/package.json

@@ -55,8 +55,6 @@
     "interactive",
     "console",
     "terminal",
-    "shell",
-    "server",
-    "toplevel"
+    "shell"
   ]
 }

lib/node_modules/@stdlib/repl/cli/lib/commands/example.js

@@ -162,7 +162,7 @@ function command( repl, cmds ) {
 					lines.push( out[ i ] );
 
 					// If line is part of a multi-line input, wait for the next line...
-					if ( repl._isMultilineInput( lines.join( '\n' ) ) ) {
+					if ( repl.isMultilineInput( lines.join( '\n' ) ) ) {
 						return next();
 					}
 					for ( j = 0; j < lines.length; j++ ) {

lib/node_modules/@stdlib/repl/cli/lib/eager_evaluator.js

@@ -299,13 +299,13 @@ setNonEnumerableReadOnly( EagerEvaluator.prototype, 'onKeypress', function onKey
 		return;
 	}
 	debug( 'Processing command...' );
-	tmp = this._repl._processCommand( code );
+	tmp = this._repl.processCommand( code );
 	if ( tmp instanceof Error ) {
 		debug( 'Error encountered when processing command: %s', tmp.message );
 		return;
 	}
 	debug( 'Compiling command...' );
-	executable = this._repl._compileCommand( tmp );
+	executable = this._repl.compileCommand( tmp );
 	if ( executable instanceof Error ) {
 		debug( 'Error encountered when compiling command: %s', executable.message );
 		return;

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

@@ -230,13 +230,13 @@ function REPL( options ) {
 	setNonEnumerableReadOnly( this, '_editorActions', new EditorActions( this, this._rli._ttyWrite ) );
 
 	// Create a new TAB completer engine:
-	setNonEnumerableReadOnly( this, '_completerEngine', new CompleterEngine( this, this._completer, this._wstream, this._rli._ttyWrite ) );
+	setNonEnumerableReadOnly( this, '_completerEngine', new CompleterEngine( this, this.completer, this._wstream, this._rli._ttyWrite ) );
 
 	// Create a new auto-closer:
 	setNonEnumerableReadOnly( this, '_autoCloser', new AutoCloser( this._rli, this._settings.autoClosePairs, this._settings.autoDeletePairs, this._multilineHandler ) );
 
 	// Initialize a preview completer:
-	setNonEnumerableReadOnly( this, '_previewCompleter', new PreviewCompleter( this._rli, this._completer, this._ostream, this._settings.completionPreviews ) );
+	setNonEnumerableReadOnly( this, '_previewCompleter', new PreviewCompleter( this._rli, this.completer, this._ostream, this._settings.completionPreviews ) );
 
 	// Initialize a syntax-highlighter:
 	setNonEnumerableReadOnly( this, '_syntaxHighlighter', new SyntaxHighlighter( this, this._ostream, this._settings.syntaxHighlighting ) );
@@ -464,7 +464,7 @@ function REPL( options ) {
 		if ( success === false ) {
 			self._ostream.write( 'Error: '+res.message+'\n' );
 		} else if ( !silent && res !== void 0 ) {
-			pre = replace( self._outputPrompt, '%d', (self._count).toString() );
+			pre = replace( self._outputPrompt, '%d', self._count.toString() );
 
 			if ( isndarrayLike( res ) ) {
 				tmp = res.toString(); // FIXME: this is a hack in order to avoid printing private ndarray properties in the REPL, as done by the built-in `util.inspect`. Ideally, we'd roll our own inspector which specifically accommodates stdlib's ndarray and other specialized classes.
@@ -675,7 +675,6 @@ setNonEnumerableReadOnly( REPL.prototype, 'createContext', function createContex
 	var context;
 	var cmds;
 
-	// TODO: Call parent method
 	context = BaseREPL.prototype.createContext.call( this );
 
 	// Get the list of REPL-specific commands:

lib/node_modules/@stdlib/repl/cli/lib/multiline_handler.js

@@ -68,9 +68,6 @@ function MultilineHandler( repl, ttyWrite ) {
 	// Cache a reference to the command array:
 	this._cmd = repl._cmd;
 
-	// Cache a reference to the command queue:
-	this._queue = repl._queue;
-
 	// Initialize an internal object for command history:
 	this._history = {};
 	this._history.list = repl._history;
@@ -631,7 +628,7 @@ setNonEnumerableReadOnly( MultilineHandler.prototype, 'beforeKeypress', function
 		this._lines[ this._lineIndex ] = this._rli.line;
 
 		// If we are in paste mode or the command is incomplete, trigger multi-line mode...
-		if ( !this._multiline.pasteMode && !this._repl._isMultilineInput( cmd.join( '\n' ) ) ) {
+		if ( !this._multiline.pasteMode && !this._repl.isMultilineInput( cmd.join( '\n' ) ) ) {
 			this._ttyWrite.call( this._rli, data, key );
 			return;
 		}