X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=df92e6940ab4971af798cbde078b84656c3fa113;hb=e533e59f321e001c6a6dd1945af546af9b0a4e67;hp=17fe7357f5c80152e9f53e31bce92c012fd78dbf;hpb=1ecf70eedbfa77db779375ae365c59c197ed2ae9;p=github%2Ffretlink%2Fpurs-loader.git diff --git a/README.md b/README.md index 17fe735..df92e69 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,17 @@ # purs-loader -> [PureScript](http://www.purescript.org) loader for [webpack](https://github.com/webpack/webpack) +> [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io) ## Install -Install with [npm](https://npmjs.org/package/purs-loader) +Install with [npm](https://npmjs.org/package/purs-loader). + +This loader works in conjunction with the [PureScript webpack plugin](https://npmjs.org/package/purescript-webpack-plugin). Ensure the plugin is installed and configured accordingly. ``` npm install purs-loader --save-dev ``` -## Options - -#### 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. - - **runtime-type-checks**: Boolean value that toggles `--runtime-type-checks` - - Generate simple runtime type checks for function arguments with simple types. - - **verbose-errors**: Boolean value that toggles `--verbose-errors` - - Generate verbose error messages. - - **output**: String value that sets `--output=` - - Write the generated Javascript to the specified file. - ## Example -```js -var path = require('path'); - -module.exports = { - entry: './src/test', - output: { - path: path.join(__dirname, 'dist'), - filename: 'app.js' - }, - module: { - loaders: [{ - test: /\.purs$/, - loader: 'purs-loader?no-prelude&output=output' - }] - }, - resolve: { - modulesDirectories: [ - 'node_modules', - 'web_modules', - 'output' - ] - } -}; -``` +Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for an example.