diff options
author | eric thul <thul.eric@gmail.com> | 2015-05-14 22:13:59 -0400 |
---|---|---|
committer | eric thul <thul.eric@gmail.com> | 2015-05-14 22:13:59 -0400 |
commit | a72c8af19a72186069465c139b72df9c353fd3d1 (patch) | |
tree | ecb69055fe7b668b99d49153c12c729938ed08dc /README.md | |
parent | a8b2571ee98ccd640a39873f8a9d67c707f336fe (diff) | |
download | purs-loader-a72c8af19a72186069465c139b72df9c353fd3d1.tar.gz purs-loader-a72c8af19a72186069465c139b72df9c353fd3d1.tar.zst purs-loader-a72c8af19a72186069465c139b72df9c353fd3d1.zip |
Additional loader options
Adds the `psc-make` options `comments` and `no-prefix`. Also, an
internal option `src` has been added that is used to specify the source
paths of `PureScript` files that will be globbed for compilation.
By default the `bower_components` path is globbed, but the loader
requires that the source paths be provided for the user's code.
Resolves #12
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 47 |
1 files changed, 35 insertions, 12 deletions
@@ -12,18 +12,41 @@ npm install purs-loader --save-dev | |||
12 | 12 | ||
13 | ## Options | 13 | ## Options |
14 | 14 | ||
15 | - **no-prelude**: Boolean value that toggles `--no-prelude` | 15 | ###### `noPrelude` (Boolean) |
16 | - Do not include the Prelude in the generated Javascript. | 16 | |
17 | - **no-opts**: Boolean value that toggles `--no-opts` | 17 | Toggles `--no-prelude` that omits the Prelude. |
18 | - Disable all optimizations. | 18 | |
19 | - **no-magic-do**: Boolean value that toggles `--no-magic-do` | 19 | ###### `noTco` (Boolean) |
20 | - Turn off optimizations which inline calls to >>= for the Eff monad. | 20 | |
21 | - **no-tco**: Boolean value that toggles `--no-tco` | 21 | Toggles `--no-tco` that disables tail-call optimizations. |
22 | - Turn off tail-call elimination. | 22 | |
23 | - **verbose-errors**: Boolean value that toggles `--verbose-errors` | 23 | ###### `noMagicDo` (Boolean) |
24 | - Generate verbose error messages. | 24 | |
25 | - **output**: String value that sets `--output=<string>` | 25 | Toggles `--no-magic-do` that disables optimizations overloading the do keyword generating efficient code for the `Eff` monad. |
26 | - Write the generated Javascript to the specified file. | 26 | |
27 | ###### `noOpts` (Boolean) | ||
28 | |||
29 | Toggles `--no-opts` that skips the optimization phase. | ||
30 | |||
31 | ###### `verboseErrors` (Boolean) | ||
32 | |||
33 | Toggles `--verbose-errors` that displays verbose error messages. | ||
34 | |||
35 | ###### `comments` (Boolean) | ||
36 | |||
37 | Toggles `--comments` that includes comments in generated code. | ||
38 | |||
39 | ###### `output` (String) | ||
40 | |||
41 | Sets `--output=<string>` the specifies the output directory, `output` by default. | ||
42 | |||
43 | ###### `noPrefix` (Boolean) | ||
44 | |||
45 | Toggles `--no-prefix` that does not include the comment header. | ||
46 | |||
47 | ###### `src` (String Array) | ||
48 | |||
49 | Specifies 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`. | ||
27 | 50 | ||
28 | ## Example | 51 | ## Example |
29 | 52 | ||