X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=91ccfc0f061a592aa716dd09423316da12674112;hb=03f52cb367cc8f1e57c515e4ac61c49cb72773eb;hp=9d6166b075cbf7a4ef537ecd0da3afff4a6f0458;hpb=2d52ea7e4b77a3ea5a8574ca245f51738d22d4a0;p=github%2Ffretlink%2Fpurs-loader.git

diff --git a/README.md b/README.md
index 9d6166b..91ccfc0 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ Install with [npm](https://npmjs.org/package/purs-loader).
 // For PureScript 0.9 and newer
 npm install purs-loader --save-dev
 
-// Fore PureScript 0.8
+// For PureScript 0.8
 npm install purs-loader@purescript-0.8 --save-dev
 ```
 
@@ -47,28 +47,72 @@ Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-we
 Default options:
 
 ```javascript
-{
+const loaderConfig = {
   psc: 'psc',
   pscArgs: {},
   pscBundle: 'psc-bundle',
   pscBundleArgs: {},
   pscIde: false, // instant rebuilds using psc-ide-server (experimental)
   pscIdeArgs: {}, // for example, to use different psc-ide-server port: {port: 4088}
+  pscIdeServerArgs: {}, // for example, to change the port { port: 4088 }
   pscIdeColors: false, // defaults to true if psc === 'psa'
+  pscPackage: false,
   bundleOutput: 'output/bundle.js',
   bundleNamespace: 'PS',
   bundle: false,
   warnings: true,
+  watch: false, // indicates if webpack is in watch mode
   output: 'output',
   src: [
     path.join('src', '**', '*.purs'),
+    // if pscPackage = false
     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
+    // if pscPackage = true
+    // source paths reported by `psc-package sources`
   ]
 }
 ```
 
-### Instant rebuilds (experimental)
+### `psc-ide` support (experimental)
 
 Experimental support for instant rebuilds using `psc-ide-server` can be enabled
 via the `pscIde: true` option.
-You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`.
+You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`,
+if there is no server running this loader will start one for you.
+
+### `psc-package` support (experimental)
+
+Set `pscPackage` query parameter to `true` to enable `psc-package` support. The `psc-package`-supplied source paths
+will be appended to `src` parameter.
+
+### Troubleshooting
+
+#### Slower webpack startup after enabling psc-ide support?
+
+By default, the psc-ide-server will be passed the globs from query.src, this is
+helpful for other tools using psc-ide-server (for example IDE plugins), however
+it might result in a slower initial webpack startup time (rebuilds are not
+affected). To override the default behaviour, add:
+`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config
+
+#### Errors not being displayed in watch mode?
+
+When the `watch` option is set to `true`, psc errors are appended to
+webpack's compilation instance errors array and not passed back as an
+error to the loader's callback. This may result in the error not being
+reported by webpack. To display errors, the following plugin may be added
+to the webpack config.
+
+```javascript
+const webpackConfig = {
+  // ...
+  plugins: [
+    function(){
+      this.plugin('done', function(stats){
+        process.stderr.write(stats.toString('errors-only'));
+      });
+    }
+  ]
+  // ...
+}
+```