https://github.com/blitzbanana/vantage-es6-contextified-repl

Contextified REPL module for Vantage with ES6 support
https://github.com/blitzbanana/vantage-es6-contextified-repl

babel context es6 repl vantage vantage-repl vorpal yarn

Last synced: 18 days ago
JSON representation

Contextified REPL module for Vantage with ES6 support

• Host: GitHub
• URL: https://github.com/blitzbanana/vantage-es6-contextified-repl
• Owner: BlitzBanana
• License: mit
• Created: 2017-11-13T07:26:15.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-16T17:06:32.000Z (about 7 years ago)
• Last Synced: 2024-04-24T17:09:15.171Z (8 months ago)
• Topics: babel, context, es6, repl, vantage, vantage-repl, vorpal, yarn
• Language: JavaScript
• Size: 503 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vantage REPL - ES6 & Context

[![NPM](https://nodei.co/npm/vantage-es6-contextified-repl.png)](https://nodei.co/npm/vantage-es6-contextified-repl/)

[![Build Status](https://travis-ci.org/BlitzBanana/vantage-es6-contextified-repl.svg?branch=master)](https://travis-ci.org/BlitzBanana/vantage-es6-contextified-repl)

[![code coverage](https://img.shields.io/codecov/c/github/blitzbanana/vantage-es6-contextified-repl.svg)](https://codecov.io/gh/blitzbanana/vantage-es6-contextified-repl)

[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)

[![license](https://img.shields.io/github/license/blitzbanana/vantage-es6-contextified-repl.svg)](LICENSE)

## Table of Contents

* [Install](#install)

* [Usage](#usage)

  * [Options](#options)

* [Contributors](#contributors)

* [License](#license)

## Install

[npm][]:

```sh

npm install vantage-es6-contextified-repl

```

[yarn][]:

```sh

yarn add vantage-es6-contextified-repl

```

## Usage

```js

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](LICENSE) © Victor Rebiard--Crépin

## 

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/