Skip to content

Commit 3244f86

Browse files
committed
[Super errors] Update instructions
No longer need the build cache bursting
1 parent ae445b7 commit 3244f86

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed
Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
Special tests for super errors (the pretty error display)
1+
Special tests for super errors (the pretty error display).
22

3-
Follow CONTRIBUTING.md and run the integration build that produces the binary needed in these tests:
3+
Follow CONTRIBUTING.md and build the project, then run `node ./jscomp/build_tests/super_errors/input.js` at the root of the project to check the tests against previous snapshots.
44

5-
```sh
6-
npm uninstall -g bs-platform # a cache-busting uninstall is needed, but only for npm >=7
7-
BS_TRAVIS_CI=1 npm install -g .
8-
```
9-
10-
To get a production bsc binary the test script will use.
11-
12-
Then, run `node ./jscomp/build_tests/super_errors/input.js` to check the tests against previous snapshots.
13-
Run `node ./jscomp/build_tests/super_errors/input.js update` to update the snapshots (assuming you've made some changes to super errors' display and/or messages)
5+
Run `node ./jscomp/build_tests/super_errors/input.js update` to update the snapshots (assuming you've made some changes to super errors' display and/or messages).

jscomp/super_errors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Hello! This is the subdirectory for the new, newcomer-friendly OCaml/Reason warning & error report system. Most of the logic are lifted from the compiler (https://github.com/rescript-lang/ocaml/tree/master). The convention here is to have a `super_foo` for each corresponding compiler's file `foo`. So, for example, `warnings.ml` becomes `super_warnings.ml`. The exception is `super_main`, the entry point.
1+
Hello! This is the subdirectory for the new, newcomer-friendly ReScript warning & error report system. Most of the logic are lifted from the compiler (https://github.com/rescript-lang/ocaml/tree/master). The convention here is to have a `super_foo` for each corresponding compiler's file `foo`. So, for example, `warnings.ml` becomes `super_warnings.ml`. The exception is `super_main`, the entry point.
22

33
Feel free to submit new ones or tweak existing messages in these files! They also have more precise comments in them that tells you how they work.
44

0 commit comments

Comments
 (0)