rescript-ava

Runtime free ReScript bindings for Ava

Usage

$3

``sh
npm install -D @dzakh/rescript-ava ava
`

Then add @dzakh/rescript-ava to bs-dev-dependencies in your rescript.json:

`diff
{
...
+ "bs-dev-dependencies": ["@dzakh/rescript-ava"]
}
`

Then add __tests__ to sources in your rescript.json:

`diff
"sources": [
{
"dir": "src"
},
+ {
+ "dir": "__tests__",
+ "type": "dev"
+ }
]
`

Then add test script and minimalistic configuration in your package.json:

`diff
{
"name": "awesome-package",
"scripts": {
+ "test": "ava"
},
"devDependencies": {
"@dzakh/rescript-ava": "latest"
},
+ "ava": {
+ "files": [
+ "__tests__/*/_test.mjs",
+ "__tests__/*/_test.bs.js"
+ ]
+ }
}
`

$3

Create a test file in the tests directory and use the suffix _test.res. When compiled they will be put in a tests directory with a _test.bs.js suffix, ready to be picked up when you run ava. If you're not already familiar with Ava, see the Ava documentation.

`res
// __tests__/Main_test.res
open Ava

test("foo", t => {
t->Assert.pass
})

asyncTest("bar", t => {
Promise.resolve("bar")->Promise.thenResolve(bar => {
t->Assert.is(bar, "bar")
})
})

`

$3

`sh
npm test
`

Or with npx:

`sh
npx ava
`

Run with the --watch flag to enable AVA's watch mode:

`sh
npx ava --watch
``

Documentation

For the moment, please refer to Ava.res.

Examples

Open source projects using rescript-ava:

- rescript-schema - The fastest parser in the entire JavaScript ecosystem with a focus on small bundle size and top-notch DX
- rescript-rest - RPC-like client, contract, and server implementation for a pure REST API
- rescript-envsafe - Makes sure you don't accidentally deploy apps with missing or invalid environment variables
- rescript-json-schema - Typesafe JSON schema for ReScript