Ensime-launcher-js NPM

Ensime Launcher JS

NPM module that downloads and starts the ENSIME server. ENSIME is a cross editor platform for the scala programming language.

Usage

Install the ensime-launcher-js library

npm install --save ensime-launcher-js

and use it in your code to start the ensime server:

var Launcher = require("./index");
var dotEnsime = "/path/to/your/.ensime"
var esl = new Launcher(
  dotEnsime,
  "0.9.10-SNAPSHOT",  // ensime version
  "/tmp/ensime",      // directory that can be used to install ensime
  "sbt");            // sbt command (must be already installed)

esl.start(function(err, res) {
  if (err) return console.error(err);
  console.log("=================================");
  console.log("Ensime started on port: "+res.http);
});

API

The following functions are available:

start(output, callback): Start ensime. Will download ensime (once) if not already installed.
ports(callback): Looks for a running ensime and returns the port it runs on.
update(output, callback): (Re)download the newest version of ensime.
stop(callback): Stop ensime.
cleanup(callback): Gets rid of a running ensime process even if it was not started here.

Parameters:

output: {out: Stream, err: Stream} => Streams that capture the sysout/syserr of the started process (ensime resp. the installer).
callback: function(err, result)