]> git.immae.eu Git - github/fretlink/purs-loader.git/blob - README.md
Splitting PSC functionality into a separate plugin
[github/fretlink/purs-loader.git] / README.md
1 # purs-loader
2
3 > [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
4
5 ## Install
6
7 Install with [npm](https://npmjs.org/package/purs-loader).
8
9 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.
10
11 ```
12 npm install purs-loader --save-dev
13 ```
14
15 ## Options
16
17 ###### `pscBundle` (String)
18
19 Relative path to the bundled JavaScript file generated by the `PurescriptWebpackPlugin`. The default value is `output/bundle.js`.
20
21 ## Example
22
23 ```js
24 // webpack.config.js
25 'use strict';
26
27 var PurescriptWebpackPlugin = require('purescript-webpack-plugin');
28
29 var src = ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs'];
30
31 var ffi = ['bower_components/purescript-*/src/**/*.js', 'src/**/*FFI.js'];
32
33 var modulesDirectories = [
34 'node_modules',
35 'bower_components'
36 ];
37
38 var config
39 = { entry: './src/entry'
40 , output: { path: __dirname
41 , pathinfo: true
42 , filename: 'bundle.js'
43 }
44 , module: { loaders: [ { test: /\.purs$/
45 , loader: 'purs-loader'
46 } ] }
47 , resolve: { modulesDirectories: modulesDirectories }
48 , plugins: [ new PurescriptWebpackPlugin({src: src, ffi: ffi}) ]
49 }
50 ;
51
52 module.exports = config;
53 ```
54
55 See the [example](https://github.com/ethul/purs-loader/tree/master/example) directory for a complete example.