6 |
7 | ## What's inside
8 |
9 | ### Familiar standard library
10 |
11 | The configuration automatically gives you [Belt](https://rescript-lang.org/docs/manual/latest/api/belt) and [ReScriptJs.Js](https://github.com/bloodyowl/rescript-js) in scope.
12 |
13 | This makes your code always default to JavaScript APIs if available, while giving you good manipulation functions for ReScript-specific types (like `Option` & `Result`)
14 |
15 | This means that by default, the following code:
16 |
17 | ```rescript
18 | let x = [1, 2, 3]
19 | ->Array.map(x => x * 2)
20 | ->Array.forEach(Console.log)
21 | ```
22 |
23 | will compile to the following JS (no additional runtime cost!):
24 |
25 | ```js
26 | [1, 2, 3]
27 | .map(function (x) {
28 | return x << 1;
29 | })
30 | .forEach(function (prim) {
31 | console.log(prim);
32 | });
33 | ```
34 |
35 | If you need a specific data-structure from Belt, you can prefix with `Belt`'s scope:
36 |
37 | ```rescript
38 | let x = Belt.Map.String.fromArray([("a", 1), ("b", 2)])
39 | ```
40 |
41 | ### Ready-to-go requests
42 |
43 | This starter kit gives you three building blocks to handle API calls from the get go.
44 |
45 | #### AsyncData
46 |
47 | [AsyncData](https://github.com/bloodyowl/rescript-asyncdata) is a great way to represent asynchronous data in React component state. It's a variant type that can be either `NotAsked`, `Loading` or `Done(payload)`, leaving no room for the errors you get when managing those in different state cells.
48 |
49 | #### Future
50 |
51 | Promises don't play really well with React's effect cancellation model, [Future](https://github.com/bloodyowl/rescript-future) gives you a performant equivalent that has built-in cancellation and leaves error management to the [Result](https://rescript-lang.org/docs/manual/latest/api/belt/result) type.
52 |
53 | #### Request
54 |
55 | [Request](https://github.com/bloodyowl/rescript-request) gives you a simple API to perform API calls in a way that's easy to store in React component state.
56 |
57 | ### Dev server
58 |
59 | Once your project grows, having the compiler output files and webpack watching it can lead to long waiting times. Here, the development server waits for BuckleScript to be ready before it triggers a compilation.
60 |
61 | The dev server supports basic **live reload**.
62 |
63 | ### Testing library
64 |
65 | With [ReScriptTest](https://github.com/bloodyowl/rescript-test), you get a light testing framework that plays nicely with React & lets you mock HTTP call responses.
66 |
67 | The assertion part is on your side, the library simply runs and renders the tests.
68 |
69 | ```rescript
70 | open ReactTest
71 |
72 | testWithReact("Robots renders", container => {
73 | let (future, resolve) = Deferred.make()
74 |
75 | let fetchRobotsTxt = () => future
76 |
77 | act(() => ReactDOM.render({"Welcome to ReScript React Starter Kit!"->React.string}
20 | {robots->React.string}
84 | | Done(_) => "An error occured"->React.string
85 | }}
86 |