# juicy-repl
An extensible JavaScript REPL
[](https://nodei.co/npm/juicy-repl/)
[](https://www.npmjs.com/package/juicy-repl)
[](https://www.npmjs.com/package/juicy-repl)
[](https://github.com/djorg83/juicy)
[](https://david-dm.org/djorg83/juicy?type=dev)
[](https://github.com/djorg83/juicy)
[](https://github.com/djorg83/juicy)
[](https://github.com/djorg83/juicy)
[](https://img.shields.io/badge/built%20with-love-ff69b4.svg)
[](https://nodejs.org/en/)
[](https://expressjs.com/)
[](https://microsoft.github.io/monaco-editor/)
[](https://rainglow.io/)
[](https://reactjs.org/)
[](https://webpack.js.org/)
[](https://babeljs.io/)
[](https://gulpjs.com/)
# Table Of Contents
- [Why use Juicy?](#why)
- [Demo](#demo)
- [Running using global command](#global)
- [Running from within a program](#programatic)
- [Default Options](#default-options)
- [Options](#options)
- [Development](#development)
- [Author](#author)
- [Contributors](#contributors)
# Why use Juicy?
- Juicy supports private npm packages. Just install `juicy-repl` globally and host it on your machine, tell it which packages to include, and in less than a minute you have a custom REPL running locally.
- Flow. Juicy supports [Flow](https://flow.org/) syntax, allowing you to copy and paste directly from your source without making syntax modifications.
- 300+ themes. Juicy implements all themes from [Rainglow](https://rainglow.io/). Thanks to [Dayle Rees](https://daylerees.com) for building these themes.
- Same [editor](https://microsoft.github.io/monaco-editor/) as [VS Code](https://code.visualstudio.com/).
- Autocomplete/intellisense
- Easy sharing. Quickly create a link to what you're working on and share it with anyone.
- Save your work. Juicy allows you to pin your work and return to it at anytime without any need to signup or login.
- Last but not least, Juicy is just plain awesome!
# Demo
[juicy-js.com](http://juicy-js.com)
# Running using global command
Install juicy-repl
``` bash
# with npm
npm install -g juicy-repl
# with yarn
yarn global add juicy-repl
```
Example 1: out of the box quick start
``` bash
juicy
```
Example 2: with command line args
``` bash
juicy --port 80 --detach false --processTitle "custom-repl" --replPageTitle "My Custom REPL" --hideHeader true
```
Example 3: with config file
``` bash
juicy --config "~/REPL_CONFIG.json"
```
Example 4: with config file added environment variables
``` bash
# add to ~/.bash_profile
export JUICY_CONFIG=~/REPL_CONFIG.json
```
``` bash
juicy
```
# Running from within a program
Install juicy-repl
``` bash
# with npm
npm install --save juicy-repl
# with yarn
yarn add juicy-repl
```
``` javascript
const juicy = require('juicy-repl');
// supply any, all, or no options
const options = { ... };
juicy(options)
.then((app) => {
// extend express app
app.get('/custom/api', res.json({ data: 'custom' }));
});
```
# Default Options
``` javascript
{
packages: [
'ramda',
'joi',
'lodash',
'bluebird',
'moment',
'uuid'
],
aliases: {
ramda: [
'R',
'Ramda'
],
lodash: [
'_'
],
bluebird: [
'Promise'
]
},
configPath: null,
port: 3000,
detach: true,
processTitle: 'juicy-repl',
replPageTitle: 'Juicy REPL',
gaid: null,
hideHeader: false,
spinnerPath: null,
spinnerBgColor: null,
faviconPath: null,
headerLogoPath: null,
headerTitle: null,
headerSubtitle: 'A JavaScript REPL that feels like an IDE',
headerColor: null,
headerFontColor: null
};
```
# Options
- [packages](#packages)
- [aliases](#aliases)
- [configPath](#configPath)
- [port](#port)
- [detach](#detach)
- [processTitle](#processTitle)
- [replPageTitle](#replPageTitle)
- [gaid](#gaid)
- [hideHeader](#hideHeader)
- [spinnerPath](#spinnerPath)
- [spinnerBgColor](#spinnerBgColor)
- [faviconPath](#faviconPath)
- [headerLogoPath](#headerLogoPath)
- [headerTitle](#headerTitle)
- [headerSubtitle](#headerSubtitle)
- [headerColor](#headerColor)
- [headerFontColor](#headerFontColor)
## options.packages
**Type:** `Array`
**Description:** A list of npm packages to include when building the REPL.
**Default value:**
``` javascript
[
'ramda',
'joi',
'lodash',
'bluebird',
'moment',
'uuid'
]
```
----
## options.aliases
**Type:** `Object>`
**Description:** Specify one or more aliases to expose as global variables for the packages.
**Default value:**
``` javascript
{
ramda: [
'R',
'Ramda'
],
lodash: [
'_'
],
bluebird: [
'Promise'
]
}
```
----
## options.configPath
**Type:** `String`
**Description:** Absolute path to config file.
**Default value:** `null`
**Command Line:** `--configPath '~/REPL_CONFIG.json'`
----
## options.port
**Type:** `Number`
**Description:** The port number the REPL server will be exposed on.
**Default value:** `3000`
**Command Line:** `--port 80`
----
## options.detach
**Type:** `Boolean`
**Description:** If true, then the REPL server will detach into a child process and allow the main process to exit. Otheriwse the main process will suspend while the REPL server is running. It is suggested to set `detach` to `false` if using `nohup` or a process manager such as `forever` or `pm2`.
**Default value:** `true`
**Command Line:** `--detach false`
----
## options.processTitle
**Type:** `String`
**Description:** The `process.title` for the REPL server process.
**Default value:** `'juicy-repl'`
**Command Line:** `--processTitle 'my-custom-repl'`
----
## options.replPageTitle
**Type:** `String`
**Description:** The `document.title` for the REPL browser app.
**Default value:** `'Juicy REPL'`
**Command Line:** `--replPageTitle 'My REPL'`
----
## options.gaid
**Type:** `String`
**Description:** Google Analytics ID. If set, then google analytics script is added to the page.
**Default value:** `null`
**Command Line:** `--gaid 'UA-112996224-1'`
----
## options.hideHeader
**Type:** `Boolean`
**Description:** If true, then the header of the REPL will be hidden.
**Default value:** `false`
**Command Line:** `--hideHeader true`
----
## options.spinnerPath
**Type:** `String`
**Description:** Set to absolute path of image to loading spinner.
**Default value:** `null`
**Command Line:** `--spinnerPath '/Users/myuser/images/spinner.gif'`
----
## options.spinnerBgColor
**Type:** `String`
**Description:** If set, then the spinner will have a circular background filled with this color
**Default value:** `null`
**Command Line:** `--spinnerBgColor '#FFFFFF'`
----
## options.faviconPath
**Type:** `String`
**Description:** Set to absolute path of image to override the favicon.
**Default value:** `null`
**Command Line:** `--faviconPath '/Users/myuser/images/favicon.ico'`
----
## options.headerLogoPath
**Type:** `String`
**Description:** Set to absolute path of image to override logo in header.
**Default value:** `null`
**Command Line:** `--headerLogoPath '/Users/myuser/images/my-repl-logo.png'`
----
## options.headerTitle
**Type:** `String`
**Description:** Overrides the title in the header. Use 'none' to hide the title.
**Default value:** `null`
**Command Line:** `--headerTitle 'My REPL'`
----
## options.headerSubtitle
**Type:** `String`
**Description:** The subtitle in the header. Use 'none' to hide the subtitle.
**Default value:** `'A JavaScript REPL that feels like an IDE'`
**Command Line:** `--headerSubtitle 'powered by Juicy'`
----
## options.headerColor
**Type:** `String`
**Description:** If set, overrides the backgorund color of the header.
**Default value:** `null`
**Command Line:** `--headerColor '#FF0000'`
----
## options.headerFontColor
**Type:** `String`
**Description:** If set, overrides the font color of the header.
**Default value:** `null`
**Command Line:** `--headerFontColor '#FFFFFF'`
----
# Development
``` bash
git clone https://github.com/djorg83/juicy
cd juicy
yarn dev
```
# Author
[Daniel Jorgensen](mailto:)
# Contributors
- [Daniel Jorgensen](mailto:djorg386@gmail.com)
- [Ricardo Spear](mailto:spear.ricardo@gmail.com)