purescript

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.

$ 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.

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

Changelog

0.15.15

New features:

• Add --exclude-file to more commands (#4530 by @JordanMartinez)

  This CLI arg was added to the compile command, but not to other commands where such a usage would be relevant (e.g. docs, repl, graph, and ide).

• Enable passing source input globs via --source-globs-file path/to/file (#4530 by @JordanMartinez)

  --source-globs-file support has been added to the following commands: compile, docs, graph, ide, and publish.

  Due to a shell character limitation on Windows where a large list of source globs cannot be passed (e.g. purs compile ... glob1000/src/**/*.purs), source globs can be stored in a file according to the format below and the file is passed in instead via purs compile ---source-globs-file path/to/file.

  # Lines starting with '#' are comments.
  # Blank lines are ignored.
  # Otherwise, every line is a glob.
  
  .spago/foo-1.2.3/src/**/*.purs
  .spago/bar-2.3.3/src/**/*.purs
  my-package/src/**/*.purs
  my-package/tests/**/*.purs
  

  --source-globs-file is an optional argument. Mixing it with the normal source globs is fine. Assuming .spago/source-globs contains src/**/*.purs, each command below will use the same input globs:

  purs compile src/**/*.purs
  purs compile --source-globs .spago/source-globs
  purs compile --source-globs .spago/source-globs src/**/*.purs 
  

  In the command...

  purs compile inputGlob1 inputGlob2 --source-globs-file fileWithMoreGlobs --exclude-files excludeGlob1
  

  the files passed to the compiler are: all the files found by inputGlob1, inputGlob2, and all the globs listed in fileWithMoreGlobs minus the files found by excludeGlob1.