Skip to content

Commit

Permalink
Improve CONTRIBUTING.md (#1678)
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING.md

* fix
  • Loading branch information
cspotcode authored Mar 15, 2022
1 parent ba95059 commit b5aa55d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ compiled code in `dist`.

Test cases are declared in `src/test/*.spec.ts`, and test fixtures live in `./tests`. They can be run with `npm run test-local`.

To run a subset of tests:

```
# Use ava's --match flag to match the name of a test or suite
# https://github.com/avajs/ava/blob/main/docs/05-command-line.md
# Don't forget the * wildcards
npm run test-local -- --match '*esm loader*'
```

Tests are run with AVA, but using a custom wrapper API to enable some TS-friendly features and grouped test suites.

The tests `npm pack` ts-node into a tarball and `npm install` it into `./tests/node_modules`. This makes `./tests` a better testing environment
Expand Down

0 comments on commit b5aa55d

Please sign in to comment.