stryker-html-reporter/README.md

An html reporter for the JavaScript mutation testing framework Stryker

[![Build Status](https://travis-ci.org/stryker-mutator/stryker.svg?branch=master)](https://travis-ci.org/stryker-mutator/stryker)
[![NPM](https://img.shields.io/npm/dm/stryker-html-reporter.svg)](https://www.npmjs.com/package/stryker-html-reporter)
[![Node version](https://img.shields.io/node/v/stryker-html-reporter.svg)](https://img.shields.io/node/v/stryker-html-reporter.svg)
[![Gitter](https://badges.gitter.im/stryker-mutator/stryker.svg)](https://gitter.im/stryker-mutator/stryker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# Stryker HTML Reporter

An HTML Reporter for the JavaScript mutation testing framework [Stryker](https://stryker-mutator.io)

## Example

Click on the image below to see a real-life example of a report generated from a test run on stryker itself!

[![example](https://github.com/stryker-mutator/stryker/blob/html-docs/packages/stryker-html-reporter/example.png)](https://stryker-mutator.io/stryker-html-reporter)

## Install

Install stryker-html-reporter from your project folder:

```bash
npm i --save-dev stryker-html-reporter
```

## Configuring

You can either configure the html reporter from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.

### Load the plugin

In order to use the `stryker-html-reporter` it must be loaded in the stryker mutation testing framework via the stryker configuration. 
Easiest is to *leave out* the `plugins` section from your config entirely. That way, all node_modules starting with `stryker-` will be loaded.

If you do descide to choose specific modules, don't forget to add `'stryker-html-reporter'` to the list of plugins to load.

### Use the reporter

In order to use the reporter, you must add `'html'` to the reporters. For example: `reporters: ['html', 'progress']`.

### Options

You can configure the html reporter by adding a `htmlReporter` object to your config.

#### htmlReporter.baseDir

Configure the base directory to write the html report to. 

### Full config example

```javascript
// stryker.conf.js
exports = function(config){
    config.set({
        // ...
        reporters: ['html'], // You may also want to specify other reporters
        htmlReporter: {
            baseDir: 'reports/mutation/html' // this is the default
        },
        plugins: ['stryker-html-reporter'] // Or leave out the plugin list entirely to load all stryker-* plugins directly
        // ...
    });
}
```

## Usage

Use Stryker as you normally would. The report will be available where you have configured it, or in the `reports/mutation/html` as a default.
See [https://stryker-mutator.io](https://stryker-mutator.io) for more info.