Back to Purescript

PureScript npm package

npm-package/README.md

0.15.162.1 KB
Original Source

PureScript npm package

PureScript binary wrapper that makes it seamlessly available via npm

Prerequisites

This package makes maximum use of postinstall script, so please make sure that ignore-scripts npm-config is not enabled before installation.

console
$ npm config get ignore-scripts
false

Installation

Use npm.

npm install purescript

Once the command above is executed,

1. First, it checks if a PureScript binary has been already cached, and restores that if available.

2. The second plan: if no cache is available, it downloads a prebuilt binary from the PureScript release page.

3. The last resort: if no prebuilt binary is provided for your platform or the downloaded binary doesn't work correctly, it downloads the PureScript source code and compile it with Stack.

API

require('purescript')

Type: string

An absolute path to the installed PureScript binary, which can be used with child_process functions.

javascript
const {execFile} = require('child_process');
const purs = require('purescript'); //=> '/Users/you/example/node_modules/purescript/purs.bin'

execFile(purs, ['compile', 'input.purs', '--output', 'output.purs'], () => {
  console.log('Compiled.');
});

CLI

You can use it via CLI by installing it globally.

npm install --global purescript

purs --help

License

ISC License © 2017 - 2019 Watanabe Shinnosuke