Skip to content

Commit 102a24c

Browse files
StephenWakelyhdgarrood
authored andcommitted
Update references to psc-bundle to 'purs bundle'. (documentationjs#233)
1 parent 3eae733 commit 102a24c

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

CONTRIBUTORS.md

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ If you would prefer to use different terms, please use the section below instead
5151
| [@shuhei](https://github.com/shuhei) | Shuhei Kagawa | [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/deed) |
5252
| [@owickstrom](https://github.com/owickstrom) | Oskar Wickström | [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/deed) |
5353
| [@soupi](https://github.com/soupi) | Gil Mizrahi | [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/deed) |
54+
| [@FungusHumungus](https://github.com/FungusHumungus) | Stephen Wakely | [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/deed) |
5455

5556
### Contributors using Modified Terms
5657

guides/FFI-Tips.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ exports.doSomethingImpl = function(fn, x) {
7171
};
7272
```
7373

74-
Calling these functions directly in the FFI code isn't recommended as it makes the code brittle to changes in the code generator. Additionally, doing this can cause problems when using `psc-bundle` for dead code elimination.
74+
Calling these functions directly in the FFI code isn't recommended as it makes the code brittle to changes in the code generator. Additionally, doing this can cause problems when using `purs bundle` for dead code elimination.
7575

7676
The recommended approach is to add extra arguments to your FFI-defined function to accept the functions you need to call as arguments:
7777

guides/FFI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Test.gcd(15)(20);
3939

4040
Here, I am assuming that the code was compiled with `psc`, which compiles PureScript modules to CommonJS modules. For that reason, I was able to reference the `gcd` function on the `Test` object, after importing the `Test` module using `require`.
4141

42-
You might also like to bundle JavaScript code for the browser, using `psc-bundle`. In that case, you would access the `Test` module on the global namespace, which defaults to `PS`:
42+
You might also like to bundle JavaScript code for the browser, using `purs bundle`. In that case, you would access the `Test` module on the global namespace, which defaults to `PS`:
4343

4444
``` javascript
4545
var Test = PS.Test;

guides/PureScript-Without-Node.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ Compiling Effect.Console
5959

6060
#### Bundling JavaScript for the Browser
6161

62-
To bundle the generated Javascript code, we will use the `psc-bundle` tool, which ships with the PureScript compiler binary distribution.
62+
To bundle the generated Javascript code, we will use `purs bundle`.
6363

64-
`psc-bundle` takes a collection of CommonJS module files as input, and generates a single JavaScript file.
64+
`purs bundle` takes a collection of CommonJS module files as input, and generates a single JavaScript file.
6565

66-
Run `psc-bundle` with the following arguments:
66+
Run `purs bundle` with the following arguments:
6767

6868
```text
69-
$ psc-bundle output/*/{index,foreign}.js --module Main --main Main
69+
$ purs bundle output/*/{index,foreign}.js --module Main --main Main
7070
```
7171

7272
The `--module` argument specifies an _entry-point_ module, which will be used to determine dead code which can be removed. For our purposes, we only care about bundling the CommonJS module corresponding to the Main PureScript module and its transitive dependencies.

0 commit comments

Comments
 (0)