aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAndrei Dziahel <develop7@develop7.info>2017-02-13 00:12:35 +0300
committereric <thul.eric@gmail.com>2017-02-12 16:12:35 -0500
commit86e2b3d4854157bbb65987f2939f50275edaea71 (patch)
tree08e6be9cedb3182064f2e13390d579f603cd69d4 /README.md
parent6d936842888ca5a5ff1efe2acfb502ac26b51004 (diff)
downloadpurs-loader-86e2b3d4854157bbb65987f2939f50275edaea71.tar.gz
purs-loader-86e2b3d4854157bbb65987f2939f50275edaea71.tar.zst
purs-loader-86e2b3d4854157bbb65987f2939f50275edaea71.zip
initial psc-package support (#82)
* Extract deps path * Initial psc-package support * index.js: `pscPackage` and `src` incompatibility warning * index.js: make use of user-provided options * index.js: make use of user-provided options: now for pscIdeColors * index.js: remember depsPaths call result * index.js: implemented appending user src paths with psc-packages' * README.md: sync changes of pscPackage behavior Also reflect pscPackage support in "Default options" section
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 292ab85..add7756 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-we
47Default options: 47Default options:
48 48
49```javascript 49```javascript
50{ 50const loaderConfig = {
51 psc: 'psc', 51 psc: 'psc',
52 pscArgs: {}, 52 pscArgs: {},
53 pscBundle: 'psc-bundle', 53 pscBundle: 'psc-bundle',
@@ -56,6 +56,7 @@ Default options:
56 pscIdeArgs: {}, // for example, to use different psc-ide-server port: {port: 4088} 56 pscIdeArgs: {}, // for example, to use different psc-ide-server port: {port: 4088}
57 pscIdeServerArgs: {}, // for example, to change the port { port: 4088 } 57 pscIdeServerArgs: {}, // for example, to change the port { port: 4088 }
58 pscIdeColors: false, // defaults to true if psc === 'psa' 58 pscIdeColors: false, // defaults to true if psc === 'psa'
59 pscPackage: false,
59 bundleOutput: 'output/bundle.js', 60 bundleOutput: 'output/bundle.js',
60 bundleNamespace: 'PS', 61 bundleNamespace: 'PS',
61 bundle: false, 62 bundle: false,
@@ -63,7 +64,11 @@ Default options:
63 output: 'output', 64 output: 'output',
64 src: [ 65 src: [
65 path.join('src', '**', '*.purs'), 66 path.join('src', '**', '*.purs'),
67 // if pscPackage = false
66 path.join('bower_components', 'purescript-*', 'src', '**', '*.purs') 68 path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
69 /*
70 * OR source paths reported by `psc-package sources`, if pscPackage = true
71 */
67 ] 72 ]
68} 73}
69``` 74```
@@ -84,6 +89,7 @@ it might result in a slower initial webpack startup time (rebuilds are not
84affected). To override the default behaviour, add: 89affected). To override the default behaviour, add:
85`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config 90`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config
86 91
92### `psc-package` support (experimental)
87 93
88 94Set `pscPackage` query parameter to `true` to enable `psc-package` support. The `psc-package`-supplied source paths
89 95will be appended to `src` parameter.