Skip to content

Extends Node's repl.REPLServer to allow for a colorize function.

License

Notifications You must be signed in to change notification settings

mongodb-js/pretty-repl

Repository files navigation

Pretty REPL

Node.js CI

An extension of the Node REPL (repl.REPLServer) that applies syntax highlighting as the user types.

Pretty REPL Screenshot

How to use it

Install the package:

$ npm install --save pretty-repl

Use the package:

const repl = require('pretty-repl');

const options = {
    prompt: '→ '
};

repl.start(options);

options is an an object with the same options as repl.REPLServer.

Additionally, it's possible to pass an additional colorize property to the options object:

{
    colorize: function (str) {
        // str is the the string in input.
        // the function should return the string that has been colorized to output in the REPL.
    }
}

In order to highlighting matching pairs of brackets, a colorizeMatchingBracket is also available.

Credits

Pretty repl is inspired and includes code fragments from: