docs: document added prototype methods and settings

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

Author: Snehil-Shah

lib/node_modules/@stdlib/repl/README.md

@@ -71,6 +71,7 @@ The function accepts the following `options`:
 -   **outputPrompt**: output prompt. If the output prompt includes the character sequence `%d`, the output prompt includes line numbers. Default: `'Out[%d]: '`.
 -   **welcome**: welcome message.
 -   **padding**: number of empty lines between consecutive commands. Default: `1`.
+-   **themes**: table mapping of color themes to load for syntax-highlighting
 -   **load**: file path specifying a JavaScript file to load and evaluate line-by-line (e.g., a previous REPL history file).
 -   **save**: file path specifying where to save REPL command history.
 -   **log**: file path specifying where to save REPL commands and printed output.
@@ -83,6 +84,28 @@ The function supports specifying the following settings:
 -   **autoDeletePairs**: boolean indicating whether to automatically delete adjacent matching brackets, parentheses, and quotes. Default: `true`.
 -   **autoPage**: boolean indicating whether to automatically page return values having a display size exceeding the visible screen. When streams are TTY, the default is `true`; otherwise, the default is `false`.
 -   **completionPreviews**: boolean indicating whether to display completion previews for auto-completion. When streams are TTY, the default is `true`; otherwise, the default is `false`.
+-   **syntaxHighlighting**: boolean indicating whether to enable syntax highlighting of the input. When streams are TTY, the default is `true`; otherwise, the default is `false`.
+-   **theme**: theme to set upon REPL startup. Default: `default`.
+-   **defaultTheme**: default theme to set upon REPL startup. Default: `default`.
+
+#### REPL.prototype.viewport()
+
+Returns the REPL viewport.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// Query the REPL viewport:
+var v = repl.viewport();
+
+// Close the REPL:
+repl.close();
+```
 
 #### REPL.prototype.createContext()
 
@@ -176,6 +199,126 @@ repl.clearUserDocs();
 repl.close();
 ```
 
+#### Repl.prototype.themes()
+
+Returns all available themes in the syntax-highlighter.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// ...
+
+// Fetch all available themes:
+repl.themes();
+
+// ...
+
+// Close the REPL:
+repl.close();
+```
+
+#### Repl.prototype.getTheme()
+
+Returns all available themes in the syntax-highlighter.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// ...
+
+// Fetch all available themes:
+repl.themes();
+
+// ...
+
+// Close the REPL:
+repl.close();
+```
+
+#### Repl.prototype.addTheme()
+
+Adds a color theme to the syntax-highlighter.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// ...
+
+// Add a user-defined theme:
+repl.addTheme( 'myTheme', {
+    'keyword': 'red',
+    'variable': 'green'
+
+    // ...
+});
+
+// ...
+
+// Close the REPL:
+repl.close();
+```
+
+#### Repl.prototype.deleteTheme()
+
+Deletes a specified theme from the syntax-highlighter.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// ...
+
+// Delete an existing theme:
+repl.deleteTheme( 'myTheme' );
+
+// ...
+
+// Close the REPL:
+repl.close();
+```
+
+#### Repl.prototype.renameTheme()
+
+Renames a specified theme in the syntax-highlighter.
+
+```javascript
+var debug = require( '@stdlib/streams/node/debug-sink' );
+
+// Create a new REPL:
+var repl = new REPL({
+    'output': debug()
+});
+
+// ...
+
+// Rename an existing theme:
+repl.renameTheme( 'myTheme', 'yourTheme' );
+
+// ...
+
+// Close the REPL:
+repl.close();
+```
+
 #### REPL.prototype.load( fpath, clbk )
 
 Loads and evaluates a JavaScript file line-by-line.

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

@@ -90,7 +90,16 @@ function defaults() {
 			'autoPage': void 0,
 
 			// Flag indicating whether to enable the display of completion previews for auto-completion (note: default depends on whether TTY):
-			'completionPreviews': void 0
+			'completionPreviews': void 0,
+
+			// Flag indicating whether to enable syntax highlighting of the input (note: default depends on whether TTY):
+			'syntaxHighlighting': void 0,
+
+			// Theme for syntax highlighting:
+			'theme': 'default',
+
+			// Default theme for syntax highlighting:
+			'defaultTheme': 'default'
 		}
 	};
 }

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

@@ -150,8 +150,6 @@ function REPL( options ) {
 	opts.settings.autoPage = ( opts.settings.autoPage === void 0 ) ? opts.isTTY : opts.settings.autoPage; // eslint-disable-line max-len
 	opts.settings.completionPreviews = ( opts.settings.completionPreviews === void 0 ) ? opts.isTTY : opts.settings.completionPreviews; // eslint-disable-line max-len
 	opts.settings.syntaxHighlighting = ( opts.settings.syntaxHighlighting === void 0 ) ? opts.isTTY : opts.settings.syntaxHighlighting; // eslint-disable-line max-len
-	opts.settings.theme = ( opts.settings.theme === void 0 ) ? 'default' : opts.settings.theme;
-	opts.settings.defaultTheme = ( opts.settings.defaultTheme === void 0 ) ? 'default' : opts.settings.defaultTheme;
 
 	debug( 'Options: %s', JSON.stringify({
 		'input': '<readable_stream>',
@@ -822,7 +820,7 @@ setNonEnumerableReadOnly( REPL.prototype, 'clearUserDocs', function clearUserDoc
 *
 * // ...
 *
-* // Fetch all themes:
+* // Fetch all available themes:
 * repl.themes();
 *
 * // ...
@@ -895,6 +893,8 @@ setNonEnumerableReadOnly( REPL.prototype, 'getTheme', function getTheme( theme )
 * repl.addTheme( 'myTheme', {
 *     'keyword': 'red',
 *     'variable': 'green'
+*
+*     // ...
 * });
 *
 * // ...