Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/forbeslindesay/run-browser

The simplest way to run testling type tests in the browser
https://github.com/forbeslindesay/run-browser

Last synced: 3 days ago
JSON representation

The simplest way to run testling type tests in the browser

Awesome Lists containing this project

README

        

# run-browser

The simplest way to run testling type tests in the browser

[![Dependency Status](https://img.shields.io/david/ForbesLindesay/run-browser.svg)](https://david-dm.org/ForbesLindesay/run-browser)
[![NPM version](https://img.shields.io/npm/v/run-browser.svg)](https://www.npmjs.com/package/run-browser)

## Installation

npm install run-browser -g

## Usage

run-browser

Options:
-p --port The port number to run the server on (default: 3000)
-b --phantom Use the phantom headless browser to run tests and then exit with the correct status code (if tests output TAP)
-r --report Generate coverage Istanbul report. Repeat for each type of coverage report desired. (default: text only)
-t --timeout Global timeout in milliseconds for tests to finish. (default: Infinity)

Example:
run-browser test-file.js --port 3030 --report text --report html --report=cobertura

## API Usage

Basic usage:

```js
var runBrowser = require('run-browser');

var server = runBrowser('tests/test.js');
server.listen(3000);
```

Advanced Usage:

```js
var runBrowser = require('run-browser');

var handler = runBrowser.createHandler('tests/test.js');
var server = http.createServer(function (req, res) {
if (runBrowser.handles(req)) {
return handler(req, res);
}
// any other server logic here
});
server.listen(3000);
```

For advanced phantomjs usage, just read the source in `./bin/cli.js`

## License

MIT