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 npm install purs-loader@purescript-0.10 --save-dev
  23 ```
  24
  25 ## Example
  26
  27 ```javascript
  28 const webpackConfig = {
  29   // ...
  30   loaders: [
  31     // ...
  32     {
  33       test: /\.purs$/,
  34       loader: 'purs-loader',
  35       exclude: /node_modules/,
  36       query: {
  37         psc: 'psa',
  38         src: ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs']
  39       }
  40     }
  41     // ...
  42   ]
  43   // ...
  44 }
  45 ```
  46
  47 Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for a more detailed example.
  48
  49 ### Options
  50
  51 Default options:
  52
  53 ```javascript
  54 {
  55   psc: 'psc',
  56   pscArgs: {},
  57   pscBundle: 'psc-bundle',
  58   pscBundleArgs: {},
  59   pscIde: false, // instant rebuilds using psc-ide-server (experimental)
  60   pscIdeArgs: {}, // for example, to use different psc-ide-server port: {port: 4088}
  61   pscIdeColors: false, // defaults to true if psc === 'psa'
  62   bundleOutput: 'output/bundle.js',
  63   bundleNamespace: 'PS',
  64   bundle: false,
  65   warnings: true,
  66   output: 'output',
  67   src: [
  68     path.join('src', '**', '*.purs'),
  69     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
  70   ]
  71 }
  72 ```
  73
  74 ### Instant rebuilds (experimental)
  75
  76 Experimental support for instant rebuilds using `psc-ide-server` can be enabled
  77 via the `pscIde: true` option.
  78 You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`.