aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authoreric thul <thul.eric@gmail.com>2017-02-20 17:56:56 -0500
committereric thul <thul.eric@gmail.com>2017-02-20 17:56:56 -0500
commit03f52cb367cc8f1e57c515e4ac61c49cb72773eb (patch)
treeba01c92c27497d136b7fc7c3e77b2815b6f38662
parentd146844d2e98aa08730bebd1f14a2bafb3cde1cf (diff)
downloadpurs-loader-03f52cb367cc8f1e57c515e4ac61c49cb72773eb.tar.gz
purs-loader-03f52cb367cc8f1e57c515e4ac61c49cb72773eb.tar.zst
purs-loader-03f52cb367cc8f1e57c515e4ac61c49cb72773eb.zip
Update README for error reporting
-rw-r--r--README.md31
1 files changed, 27 insertions, 4 deletions
diff --git a/README.md b/README.md
index 150c2c0..91ccfc0 100644
--- a/README.md
+++ b/README.md
@@ -80,8 +80,14 @@ via the `pscIde: true` option.
80You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`, 80You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`,
81if there is no server running this loader will start one for you. 81if there is no server running this loader will start one for you.
82 82
83### `psc-package` support (experimental)
84
85Set `pscPackage` query parameter to `true` to enable `psc-package` support. The `psc-package`-supplied source paths
86will be appended to `src` parameter.
87
88### Troubleshooting
83 89
84#### Slower webpack startup after using purs-loader ? 90#### Slower webpack startup after enabling psc-ide support?
85 91
86By default, the psc-ide-server will be passed the globs from query.src, this is 92By default, the psc-ide-server will be passed the globs from query.src, this is
87helpful for other tools using psc-ide-server (for example IDE plugins), however 93helpful for other tools using psc-ide-server (for example IDE plugins), however
@@ -89,7 +95,24 @@ it might result in a slower initial webpack startup time (rebuilds are not
89affected). To override the default behaviour, add: 95affected). To override the default behaviour, add:
90`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config 96`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config
91 97
92### `psc-package` support (experimental) 98#### Errors not being displayed in watch mode?
93 99
94Set `pscPackage` query parameter to `true` to enable `psc-package` support. The `psc-package`-supplied source paths 100When the `watch` option is set to `true`, psc errors are appended to
95will be appended to `src` parameter. 101webpack's compilation instance errors array and not passed back as an
102error to the loader's callback. This may result in the error not being
103reported by webpack. To display errors, the following plugin may be added
104to the webpack config.
105
106```javascript
107const webpackConfig = {
108 // ...
109 plugins: [
110 function(){
111 this.plugin('done', function(stats){
112 process.stderr.write(stats.toString('errors-only'));
113 });
114 }
115 ]
116 // ...
117}
118```