adrieankhisbe/vorpal-replinception

Vorpal Extension for node Repl

vorpal-REPLinception

Vorpal Extension for node Repl

vorpal-REPLinception is a plugin to vorpal to provide a command to open a node REPL.

Installation

To add it to your project just yarn add/npm install it along vorpal

npm install vorpal
npm install vorpal-replinception

Basic Usage

const Vorpal = require('vorpal');
const vorpalReplinception = require('../src');

const vorpal = Vorpal();

vorpal
  .delimiter('node~$')
  .use(vorpalReplinception())
  .show();

Configuration

This is configurable, you can pass a config object to vorpalReplinception: here are so far the properties:

• prompt = the prompt used by the repl
• commandName : the name of the vorpal command to enter the repl, default to repl
• aliasName : an alias for the commandName, default to console, disable with false
• helpMessageMessage: the help message associated with the command
• enterMessage: some message at the entering of the node repl
• exitMessage: some message at the exit of the node repl, disable with false
• exitMessage: some message at the exit of the node repl, disable with false
• historyFile: where the repl history is persisted, default with .vorpal_node_history, disable with false
• context: this is a key value object for the values you want to expose in the repl context.

For more details refer to the examples folder, specificaly the my-repl-with-customized-repl.js file