/node-purescript-bin

PureScript wrapper that makes it seamlessly available via npm

Primary LanguageJavaScriptMIT LicenseMIT

PureScript wrapper for Node

NPM version Build Status Coverage Status dependencies Status devDependencies Status

PureScript binary wrapper that makes it seamlessly available via npm

Installation

Use npm after making sure your development environment satisfies the requirements.

npm install purescript

Release candidate version

Specify next tag on installation.

npm install purescript@next

Usage

const {execFile} = require('child_process');
const paths = require('purescript');

// On POSIX
paths.psc; //=> '/path/to/proj/node_modules/purescript/vendor/psc'
paths['psc-bundle']; //=> '/path/to/proj/node_modules/purescript/vendor/psc-bundle'
paths['psc-docs']; //=> '/path/to/proj/node_modules/purescript/vendor/psc-docs'
paths['psc-ide-client']; //=> '/path/to/proj/node_modules/purescript/vendor/psc-ide-client'
paths['psc-ide-server']; //=> '/path/to/proj/node_modules/purescript/vendor/psc-ide-server'
paths['psc-publish']; //=> '/path/to/proj/node_modules/purescript/vendor/psc-publish'
paths.psci; //=> '/path/to/proj/node_modules/purescript/vendor/psci'

execFile(paths.psc, ['input.purs', '--output', 'output.purs'], err => {
  if (err) {
    throw err;
  }

  console.log('Compiled.');
});

API

require('purescript').psc

Type: String

The path to psc binary

require('purescript')['psc-bundle']

Type: String

The path to psc-bundle binary

require('purescript')['psc-docs']

Type: String

The path to psc-docs binary

require('purescript')['psc-ide-client']

Type: String

The path to psc-ide-client binary

require('purescript')['psc-ide-server']

Type: String

The path to psc-ide-server binary

require('purescript')['psc-publish']

Type: String

The path to psc-publish binary

require('purescript').psci

Type: String

The path to psci binary

CLI

You can use it via CLI by installing it globally.

npm install -g purescript

psc --help
psc-bundle --help
psc-docs --help
psc-ide-client --help
psc-ide-server --help
psc-publish --help
psci --help

License

Copyright (c) 2015 - 2016 Shinnosuke Watanabe

Licensed under the MIT License.