]> git.immae.eu Git - github/fretlink/purs-loader.git/blame - README.md
Bumping version number to 0.2.1
[github/fretlink/purs-loader.git] / README.md
CommitLineData
a42f24b8 1# purs-loader
2
08b34471 3> [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
a42f24b8 4
5## Install
6
7Install with [npm](https://npmjs.org/package/purs-loader)
8
9```
10npm install purs-loader --save-dev
11```
12
13## Options
14
a72c8af1 15###### `noPrelude` (Boolean)
16
17Toggles `--no-prelude` that omits the Prelude.
18
19###### `noTco` (Boolean)
20
21Toggles `--no-tco` that disables tail-call optimizations.
22
23###### `noMagicDo` (Boolean)
24
25Toggles `--no-magic-do` that disables optimizations overloading the do keyword generating efficient code for the `Eff` monad.
26
27###### `noOpts` (Boolean)
28
29Toggles `--no-opts` that skips the optimization phase.
30
31###### `verboseErrors` (Boolean)
32
33Toggles `--verbose-errors` that displays verbose error messages.
34
35###### `comments` (Boolean)
36
37Toggles `--comments` that includes comments in generated code.
38
39###### `output` (String)
40
41Sets `--output=<string>` the specifies the output directory, `output` by default.
42
43###### `noPrefix` (Boolean)
44
45Toggles `--no-prefix` that does not include the comment header.
46
47###### `src` (String Array)
48
49Specifies PureScript source paths to be globbed for `.purs` files. By default, `bower_components` is search. Additional paths may be specified using this option. This option is specified as `src[]=path`.
a42f24b8 50
51## Example
52
464355c7 53See the [example](https://github.com/ethul/purs-loader/tree/master/example) directory for a complete example.