blitzbanana/vantage-es6-contextified-repl

Contextified REPL module for Vantage with ES6 support

Vantage REPL - ES6 & Context

Table of Contents

• Install
• Usage
  • Options
• Contributors
• License

Install

npm:

npm install vantage-es6-contextified-repl

yarn:

yarn add vantage-es6-contextified-repl

Usage

import Vantage from 'vantage'
import repl from 'vantage-es6-contextified-repl'
import chalk from 'chalk'
import figlet from 'figlet'

new Vantage()
  .use(repl, {
    delimiter: chalk.red('repl:'),
    description: 'Server REPL with access to app and db objects !',
    banner: 'Have fun !',
    context: { infos, app, db },
    formatter: 'highlight'
  })
  .banner(figlet.textSync('MAIN SERVER'))
  .delimiter(chalk.green('main-server~$'))
  .listen(8080)
  .show()

Options

• mode - the command to type to enter in REPL mode, default to repl.
• description - the mode description displayed in help menu, default to Enters REPL mode..
• banner - the welcome message displayed when entrering in REPL mode, default to: Entering REPL Mode. To exit, type 'exit'.
• delimiter - the additional delimiter of the mode, default to repl:.
• timeout - the maximum amout of time to eval the code, default to 15000.
• context - the REPL context, accessible from evalued code, default to {}.
• compiler - the code transformation functon, set null or a functon using signature function(code:string) and that returns a string, the default function uses Babel.
• formatter - the output transformation functon, set highlight, none or a functon using signature function(input:string) and that returns a string, default to highlight.

TODO: Multiline input support

TODO: Make an option to use a custom or predefined theme for highlight formatter

Contributors

Name
Victor Rebiard--Crépin

License

MIT © Victor Rebiard--Crépin