suzanne.soy/cover
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added README

Browse Source
This commit is contained in:
Spencer Florence 2014-12-28 16:04:44 -06:00
parent 081d8d2352
commit cc27842fa9
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Better Test
This library is a replacement for rackets `raco test` that has a few benefits. Namely, it can generate code coverage reports and it will return with a non-zero exit code if tests fail.
## How to install
install via `raco pkg install better-test`. To install for development, checkout the repo into a folder named `Better Test` and in the parent directory run `raco pkg install better-test/`.
## How to use
To view the arguments for Better Test run `raco better-test -h`.
Code coverage can be generated by specifying the `-c <format>` flag.
Right now the valid formats are: html. Coveralls support is comming.
The directory that the coverage is outputted to can be specified with the `-d` flag.
If any tests run by `rackunit` fail, Better Test will return with exit code `1`. If all tests pass it will return with exit code `0`.
## Internals
Better Test also comes with a racket API for running tests and generating coverage reports. Documentation comming soon...