feat: add support for auto-closing brackets/quotations in the REPL

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

@@ -0,0 +1,116 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable no-underscore-dangle */
+
+'use strict';
+
+// VARIABLES //
+
+var SYMBOLS = {
+	'{': '}',
+	'[': ']',
+	'(': ')',
+	'\'': '\'',
+	'"': '"',
+	'`': '`'
+};
+
+
+// MAIN //
+
+/**
+* Returns a callback that handles auto matching symbols.
+*
+* @private
+* @param {REPL} repl - REPL instance
+* @returns {Function} callback
+*/
+function autoMatch( repl ) {
+	return onKeypress;
+
+	/**
+	* Callback invoked upon a readline interface "keypress" event.
+	*
+	* @private
+	* @param {string} chunk - character pressed by the user
+	* @param {Object} key - keypress event information
+	*/
+	function onKeypress( chunk, key ) {
+		if ( repl._settings.autoMatch ) {
+			// Handle edge cases
+			if ( repl._auto_match_status ) {
+				// Auto delete appended symbol when deleting input
+				if (
+					key.name === 'backspace'
+				) {
+					repl._rli.write( null, {
+						'name': 'right'
+					} );
+					repl._rli.write( null, {
+						'name': 'backspace'
+					} );
+					return;
+				}
+				// Discard instinctive closing symbols
+				if (
+					typeof chunk !== 'undefined' &&
+					repl._rli.line[ repl._rli.cursor ] === chunk &&
+					SYMBOLS[ repl._rli.line[ repl._rli.cursor - 2 ] ] === chunk
+				) {
+					repl._rli.write( null, {
+						'name': 'backspace'
+					} );
+					repl._rli.write( null, {
+						'name': 'right'
+					} );
+					repl._auto_match_status = false;
+					return;
+				}
+				repl._auto_match_status = false;
+			}
+
+			// For a bracket/quotation input, append corresponding closing symbol
+			if ( SYMBOLS[chunk] ) {
+				if (
+					(
+						SYMBOLS[chunk] === '\'' || SYMBOLS[chunk] === '"'
+					) &&
+					(
+						/^[a-zA-Z0-9"'/\\]$/.test(repl._rli.line[repl._rli.cursor - 2 ]) ||
+						/^[a-zA-Z0-9"'/\\]$/.test(repl._rli.line[repl._rli.cursor ])
+					)
+				) {
+					// Don't auto-complete quotations around text
+					return;
+				}
+				repl._rli.write( SYMBOLS[chunk] );
+				repl._rli.write( null, {
+					'ctrl': true,
+					'name': 'b'
+				} );
+				repl._auto_match_status = true;
+			}
+		}
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = autoMatch;

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

@@ -55,6 +55,7 @@ var onRenameWorkspace = require( './commands/rename_workspace.js' );
 var onRerequire = require( './commands/rerequire.js' );
 var onRerun = require( './commands/rerun.js' );
 var onReset = require( './commands/reset.js' );
+var onSettings = require( './commands/settings.js' );
 var onTutorial = require( './commands/tutorial.js' );
 var onUserDoc = require( './commands/user_doc.js' );
 var onVars = require( './commands/vars.js' );
@@ -122,6 +123,7 @@ function commands( repl ) {
 	cmds.push( [ 'rerequire', onRerequire( repl ), false ] );
 	cmds.push( [ 'rerun', onRerun( repl ), false ] );
 	cmds.push( [ 'reset', onReset( repl ), false ] );
+	cmds.push( [ 'settings', onSettings( repl ), false ] );
 	cmds.push( [ 'tutorial', onTutorial( repl ), false ] );
 	cmds.push( [ 'userDoc', onUserDoc( repl ), false ] );
 	cmds.push( [ 'vars', onVars( repl ), false ] );

lib/node_modules/@stdlib/repl/lib/commands/settings.js

@@ -0,0 +1,143 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable no-underscore-dangle */
+
+'use strict';
+
+// MODULES //
+
+var logger = require( 'debug' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var objectKeys = require( '@stdlib/utils/keys' );
+var format = require( '@stdlib/string/format' );
+
+
+// VARIABLES //
+
+var debug = logger( 'repl:command:settings' );
+var SETTINGS = {
+	'autoMatch': {
+		'desc': 'Automatically insert matching brackets, parentheses, and quotes.',
+		'default': true,
+		'type': 'boolean'
+	}
+};
+var VALIDATORS = {
+	'boolean': isBoolean
+};
+
+
+// FUNCTIONS //
+
+/**
+* Returns settings help text.
+*
+* @private
+* @param {REPL} repl - REPL instance
+* @returns {string} settings help text
+*/
+function help( repl ) {
+	var HELP_TEXT;
+	var names;
+	var o;
+	var i;
+
+	names = objectKeys( SETTINGS );
+	HELP_TEXT = '\n';
+	for ( i = 0; i < names.length; i++ ) {
+		o = SETTINGS[ names[ i ] ];
+		HELP_TEXT += names[ i ] + '\n';
+		HELP_TEXT += '    ';
+		if ( o.desc ) {
+			HELP_TEXT += SETTINGS[ names[ i ] ].desc;
+		} else {
+			HELP_TEXT += '(no description available)';
+		}
+		HELP_TEXT += format( ' Value: %s', repl._settings[names[ i ]] );
+		HELP_TEXT += '\n\n';
+	}
+	return HELP_TEXT;
+}
+
+
+// MAIN //
+
+/**
+* Returns a callback to be invoked upon calling the `settings` command.
+*
+* @private
+* @param {REPL} repl - REPL instance
+* @returns {Function} callback
+*/
+function command( repl ) {
+	return onCommand;
+
+	/**
+	* Manages REPL settings.
+	*
+	* If no arguments are given, it prints all settings with their description.
+	* If one argument is given, it fetches the value of the setting with the given name and prints it.
+	* If two arguments are given, it updates the value of the given setting name to the given value.
+	*
+	* @private
+	* @param {string} [name] - setting name
+	* @param {*} [value] - new setting value
+	*/
+	function onCommand( name, value ) {
+		var validator;
+		var err;
+		if ( arguments.length === 0 ) {
+			repl._ostream.write( help( repl ) );
+			return;
+		}
+		if ( !isString( name ) ) {
+			err = new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', name ) );
+			debug( 'Error: %s', err.message );
+			repl._ostream.write( format( 'Error: %s\n', err.message ) );
+			return;
+		}
+		if ( !hasOwnProp( SETTINGS, name ) ) {
+			err = new Error( format( 'invalid argument. Unrecognized setting. Value: `%s`.', name ) );
+			debug( 'Error: %s', err.message );
+			repl._ostream.write( format( 'Error: %s\n', err.message ) );
+			return;
+		}
+		if ( arguments.length === 1 ) {
+			// repl._ostream.write( '\n'+repl._settings[name]+'\n\n' );
+			repl._ostream.write( format( '\n%s\n\n', repl._settings[name] ) );
+			return;
+		}
+		validator = VALIDATORS[ SETTINGS[name].type ];
+		if ( !validator(value) ) {
+			err = new TypeError( format( 'invalid argument. Second argument must be a %s. Value: `%s`.', SETTINGS[name].type, name ) );
+			debug( 'Error: %s', err.message );
+			repl._ostream.write( format( 'Error: %s\n', err.message ) );
+			return;
+		}
+		repl._settings[name] = value;
+		repl._ostream.write( format( '\nUpdated setting %s to %s.\n\n', name, String(value) ) );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = command;

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

@@ -51,8 +51,7 @@ function defaults() {
 		'save': '',
 		'load': '',
 		'log': '',
-		'quiet': false,
-		'autoClose': true
+		'quiet': false
 	};
 }
 

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

@@ -0,0 +1,74 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable no-underscore-dangle */
+
+'use strict';
+
+// MODULES //
+
+var repeat = require( '@stdlib/string/repeat' );
+
+
+// MAIN //
+
+/**
+* Returns a callback that handles multiline editing using a modifier key.
+*
+* @private
+* @param {REPL} repl - REPL instance
+* @returns {Function} callback
+*/
+function manualMultiline( repl ) {
+	return onKeypress;
+
+	/**
+	* Callback invoked upon a readline interface "keypress" event.
+	*
+	* @private
+	* @param {string} key - key event information
+	*/
+	function onKeypress( key ) {
+		var charsAfterCursor;
+		var codeAfterCursor;
+
+		// For ALT+ENTER keypress, manually enter multi-line mode:
+		if ( key && key.name === 'return' && key.meta ) {
+			charsAfterCursor = repl._rli.line.length - repl._rli.cursor;
+			codeAfterCursor = repl._rli.line.substring( repl._rli.cursor );
+
+			// Update flag
+			repl._multiline.mode = 'modifier';
+
+			// Store code after cursor in buffer for next line
+			repl._multiline.buffer = codeAfterCursor;
+			repl._ostream.write( repeat( '\x1b[C', charsAfterCursor ) + repeat( '\b \b', charsAfterCursor ) );
+			repl._rli.line = repl._rli.line.substring( 0, repl._rli.cursor );
+
+			// Simulate `line` event
+			repl._rli.write( null, {
+				'name': 'return'
+			});
+		}
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = manualMultiline;

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

@@ -71,6 +71,8 @@ var MSG = [
 	'    userDoc()               Add user-defined documentation.',
 	'    clearUserDocs()         Clear user-defined documentation.',
 	'',
+	'    settings()              View and update settings.',
+	'',
 	'    clearHistory()          Clear the REPL history.',
 	'',
 	'    clear()                 Clear the entire REPL screen and scrollback history.',