IJavascript Home Page
IJavascript Repository
jp-babel Repository
jp-coffeescript Repository

IJavascript

IJavascript is an npm package that implements a Javascript kernel for the Jupyter notebook . A Jupyter notebook combines the creation of rich-text documents (including equations, graphs and videos) with the execution of code in a number of programming languages.

The execution of code is carried out by means of a kernel that implements the Jupyter messaging protocol. There are kernels available for Python, Babel, CoffeeScript, Julia, Haskell, Ruby and many other languages.

Announcements

• Starting with IJavascript v5.0.11, it is possible to customise the output of an object based on its class. See the documentation on custom output for details.
• The use of $$mimer$$ and $$defaultMimer$$ to customise output is now deprecated.
• To avoid clutter in the global context, the use of $$async$$, $$done$$, $$mime$$, $$html$$, $$svg$$, $$png$$ and $$jpeg$$ has also been deprecated.

Main Features

• Run Javascript code in a Node.js session
• Hello, World!
• Asynchronous output
• Custom output
• Autocompletion: press TAB to complete keywords and object properties
• Object inspection: press Shift-TAB to inspect an object and show its content or, if available, its documentation

Installation

The instructions to install IJavascript are platform-dependent. For example, in Ubuntu 16.04, IJavascript and its prerequisites can be installed simply by running:

sudo apt-get install nodejs-legacy npm ipython ipython-notebook libzmq3-dev
sudo npm install -g ijavascript

In OS X, Homebrew and pip can be used to install IJavascript and its prerequisites:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install pkg-config node zeromq
sudo easy_install pip
sudo pip install --upgrade pyzmq jupyter
sudo npm install -g ijavascript

In Windows, Anaconda offers a convenient distribution to install Python and many other packages, such as Jupyter and IJavascript.

For other platforms or if you find any problems with the instructions above, please, refer to the installation notes.

Usage

To create a Jupyter notebook that runs a session in the IJavascript kernel, run:

ijs

This command should open the Jupyter dashboard in your default web browser:

Here's a sample notebook that makes use of the IJavascript kernel:

Please, refer to the usage notes for further details.

Contributions

First of all, thank you for taking the time to contribute. Please, read CONTRIBUTING and use the issue tracker for any contributions: support requests, bug reports, enhancement requests, pull requests, submission of tutorials...

TO DO

• Split kernel into Jupyter and Javascript frameworks to help reuse code in the Babel and CoffeeScript kernels.
• Use Mocha test framework
• Complete the implementation of the Jupyter messaging protocol v4.1
• Complete the implementation of the Jupyter messaging protocol v5.0

See the TODO list in the NEL package for additional items.