Readme section on how to run the tests

[Neppord]

From looking into the github workflow file I assume it is something like this:

spago test --purs-args '--censor-lib'

But it would be nice to have a more detailed explanation, or a npm test target.

[jam-awake]

I forget how to pass CLI args into spago-legacy (is it --exec-args?), so any additional things after spago test should be passed in. From the root directory, you would run spago test. For context, if you cd backend-es && npm run test, that's where the test files live.

By default,spago test will run all tests, comparing the outputted snapshots with the saved ones, and failing if any don't match. There are 3 CLI args you can pass to the Test.Main program:

• --filter "ModuleName" - only run tests that are prefixed with Snapshot.ModuleName
• --accept - Overwrite all saved snapshot files with the newly outputted ones
• --trace-rewrites Fully.Qualified.Module.Name - Output the steps of optimizations done by the optimizer when building the given module. Useful for troubleshooting why something did or didn't inline correctly.

[Neppord]

I didn't see the package.json file in the subfolder, only the one in the root folder.

Now when I understand that there are two, then it's obvius how to run the tests. But it still seams like a good idea with instructions in the readme.