JSPM

  • Created
  • Published
  • Downloads 5627
  • Score
    100M100P100Q140030F
  • License ISC

PureScript wrapper that makes it available as a local dependency

Package Exports

  • purescript

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (purescript) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

logo

PureScript npm package

npm version Build Status Build status

PureScript binary wrapper that makes it seamlessly available via npm

Installation

Use npm.

npm install purescript

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

Once the command above is executed,

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

screencast: restoring a cache

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

screencast: downloading a binary

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

screencast: compile a source

API

require('purescript')

Type: string

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

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

exec(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 Shinnosuke Watanabe

The original PureScript logo is included in purescript/purescript repository which is licensed under the 3-Clause BSD License.