[github/fretlink/purs-loader.git] / README.md

# purs-loader

> [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)

## Install

Install with [npm](https://npmjs.org/package/purs-loader)

```
npm install purs-loader --save-dev
```

## Options

 - **no-prelude**: Boolean value that toggles `--no-prelude`
  - Do not include the Prelude in the generated Javascript.
 - **no-opts**: Boolean value that toggles `--no-opts`
  - Disable all optimizations.
 - **no-magic-do**: Boolean value that toggles `--no-magic-do`
  - Turn off optimizations which inline calls to >>= for the Eff monad.
 - **no-tco**: Boolean value that toggles `--no-tco`
  - Turn off tail-call elimination.
 - **verbose-errors**: Boolean value that toggles `--verbose-errors`
  - Generate verbose error messages.
 - **output**: String value that sets `--output=<string>`
  - Write the generated Javascript to the specified file.

## Example

See the [example](https://github.com/ethul/purs-loader/tree/master/example) directory for a complete example.
Commit	Line	Data
a42f24b8	1	# purs-loader
a42f24b8	2
08b34471	3	> [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
a42f24b8	4
	5	## Install
	6
	7	Install with [npm](https://npmjs.org/package/purs-loader)
	8
	9	```
	10	npm install purs-loader --save-dev
	11	```
	12
	13	## Options
	14
a42f24b8	15	- no-prelude: Boolean value that toggles `--no-prelude`
	16	- Do not include the Prelude in the generated Javascript.
	17	- no-opts: Boolean value that toggles `--no-opts`
	18	- Disable all optimizations.
	19	- no-magic-do: Boolean value that toggles `--no-magic-do`
	20	- Turn off optimizations which inline calls to >>= for the Eff monad.
	21	- no-tco: Boolean value that toggles `--no-tco`
	22	- Turn off tail-call elimination.
a42f24b8	23	- verbose-errors: Boolean value that toggles `--verbose-errors`
	24	- Generate verbose error messages.
	25	- output: String value that sets `--output=<string>`
	26	- Write the generated Javascript to the specified file.
	27
	28	## Example
	29
464355c7	30	See the [example](https://github.com/ethul/purs-loader/tree/master/example) directory for a complete example.