README.md

   1 # purs-loader
   2
   3 > [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
   4
   5 - Supports hot-reloading and rebuilding of single source files
   6 - Dead code elimination using the `bundle` option
   7 - Colorized build output using `purescript-psa` and the `psc: "psa"` option
   8
   9 ## Install
  10
  11 Install with [npm](https://npmjs.org/package/purs-loader).
  12
  13 ```
  14 npm install purs-loader --save-dev
  15
  16 npm install purs-loader@next --save-dev
  17
  18 npm install purs-loader@purescript-0.8 --save-dev
  19
  20 npm install purs-loader@purescript-0.9 --save-dev
  21 ```
  22
  23 ## Example
  24
  25 ```javascript
  26 const webpackConfig = {
  27   // ...
  28   loaders: [
  29     // ...
  30     {
  31       test: /\.purs$/,
  32       loader: 'purs-loader',
  33       exclude: /node_modules/,
  34       query: {
  35         psc: 'psa',
  36         src: ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs']
  37       }
  38     }
  39     // ...
  40   ]
  41   // ...
  42 }
  43 ```
  44
  45 Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for a more detailed example.
  46
  47 ### Options
  48
  49 Default options:
  50
  51 ```javascript
  52 {
  53   psc: 'psc',
  54   pscArgs: {},
  55   pscBundle: 'psc-bundle',
  56   pscBundleArgs: {},
  57   pscIde: false, // instant rebuilds using psc-ide-server (experimental)
  58   pscIdeColors: false, // defaults to true if psc === 'psa'
  59   bundleOutput: 'output/bundle.js',
  60   bundleNamespace: 'PS',
  61   bundle: false,
  62   warnings: true,
  63   output: 'output',
  64   src: [
  65     path.join('src', '**', '*.purs'),
  66     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
  67   ]
  68 }
  69 ```
  70
  71 ### Instant rebuilds (experimental)
  72
  73 Experimental support for instant rebuilds using `psc-ide-server` can be enabled
  74 via the `pscIde: true` option.