Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rtsao/unitest
:earth_americas: Seamless node and browser unit testing with code coverage
https://github.com/rtsao/unitest
babel browser-tests coverage coverage-report istanbul tap tape unittest
Last synced: 25 days ago
JSON representation
:earth_americas: Seamless node and browser unit testing with code coverage
- Host: GitHub
- URL: https://github.com/rtsao/unitest
- Owner: rtsao
- License: mit
- Created: 2016-01-23T20:20:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:49:20.000Z (about 2 years ago)
- Last Synced: 2024-12-16T20:03:16.252Z (about 1 month ago)
- Topics: babel, browser-tests, coverage, coverage-report, istanbul, tap, tape, unittest
- Language: JavaScript
- Homepage:
- Size: 569 KB
- Stars: 28
- Watchers: 3
- Forks: 10
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [](https://github.com/rtsao/unitest)
[![build status][build-badge]][build-href]
[![dependencies status][deps-badge]][deps-href]
[![npm version][npm-badge]][npm-href]
Seamless node and browser unit testing with code coverage
##### Features
- Unified node and browser tests with merged TAP output, code coverage reports, and exit status codes.
- Headless Chrome-powered browser testing for a fast, modern browser testing environment.
- Bundler-agnostic usage. Use browserify, webpack, or something else.
- Designed to be used with [Babel-powered coverage instrumentation](https://github.com/istanbuljs/babel-plugin-istanbul) for fast, efficient testing with code coverage.
- Works seamlessly with [nyc](https://github.com/istanbuljs/nyc), the official Istanbul CLI.
## Usage
```
Usage: unitest {OPTIONS}
Options:
--version, -v Print version and exit
--help, -h Print usage information
--node, -n Path to node test entry file
--browser, -c Path to browser test entry file
```
## Getting Started
### Run node and browser tests
1. Transpile source code with Babel *(optional)*
2. Bundle browser code
3. Run `unitest`, specifying test entry files
```
babel src -d build
browserify build/test/browser.js > build/test/browser-bundle.js
unitest --browser=build/test/browser-bundle.js --node=build/test/node.js
```
### Run node and browser tests with coverage report
Unitest works with [`nyc`](https://github.com/istanbuljs/nyc), the Istanbul CLI. To run unitest with coverage, add the [Istanbul instrumentation Babel plugin](https://github.com/istanbuljs/babel-plugin-istanbul) then run unitest with nyc on the instrumented code:
```
babel src -d build --plugins=istanbul
browserify build/test/browser.js > build/test/browser-bundle.js
nyc --report=html unitest --browser=build/test/browser-bundle.js --node=build/test/node.js
```
#### Merged test output
The separate TAP and coverage output along with exit code for your node and browser tests will be merged seamlessly.
## Debugging
### Debug node tests
No magic here, just use plain node.
```
node --inspect-brk build/test/node.js
```
### Debug browser tests
Coming soon: ability to launch Chrome with a DevTools window open, or let you connect to the script URL manually.
[build-badge]: https://travis-ci.org/rtsao/unitest.svg?branch=master
[build-href]: https://travis-ci.org/rtsao/unitest
[deps-badge]: https://david-dm.org/rtsao/unitest.svg
[deps-href]: https://david-dm.org/rtsao/unitest
[npm-badge]: https://badge.fury.io/js/unitest.svg
[npm-href]: https://www.npmjs.com/package/unitest