Package detail

@stryker-mutator/html-reporter

stryker-mutator18.9kApache-2.03.1.0

An html reporter for the JavaScript mutation testing framework Stryker

stryker, html, report, mutation, testing

readme

DEPRECATED: Starting from @stryker-mutator/core version 3.0.0 the HTML reporter is included with Stryker and enabled by default. There is no reason to install this package.

Stryker HTML Reporter

An HTML Reporter for the JavaScript mutation testing framework Stryker

Example

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

Install

Install @stryker-mutator/html-reporter from your project folder:

npm i --save-dev @stryker-mutator/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-mutator/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-mutator/* will be loaded.

If you do descide to choose specific modules, don't forget to add '@stryker-mutator/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

// 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-mutator/html-reporter'] // Or leave out the plugin list entirely to load all @stryker-mutator/* 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 for more info.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.1.0 (2020-03-29)

Note: Version bump only for package @stryker-mutator/html-reporter

3.0.2 (2020-03-13)

Bug Fixes

nodejs requirement: set NodeJS requirement to at least Node 10 (8c08059)

3.0.1 (2020-03-12)

Note: Version bump only for package @stryker-mutator/html-reporter

3.0.0 (2020-03-11)

Features

HtmlReporter: include the html reporter in the core package and add it to the default reporters (#2036) (09702d9), closes #1919
promisified fs: use node 10 promisified functions (#2028) (1c57d8f)

BREAKING CHANGES

HtmlReporter: the html reporter is now enabled by default. If you don't want to use it, be sure to override the reporters configuration option.

{
  "reporters": ["progress", "clear-text"]
}

promisified fs: removed fsAsPromised from @stryker-mutator/util

2.5.0 (2020-01-12)

Note: Version bump only for package @stryker-mutator/html-reporter

2.4.0 (2019-11-24)

Note: Version bump only for package @stryker-mutator/html-reporter

2.3.0 (2019-11-13)

Note: Version bump only for package @stryker-mutator/html-reporter

2.2.1 (2019-11-06)

Note: Version bump only for package @stryker-mutator/html-reporter

2.2.0 (2019-11-06)

Note: Version bump only for package @stryker-mutator/html-reporter

2.1.0 (2019-09-08)

Note: Version bump only for package @stryker-mutator/html-reporter

2.0.2 (2019-07-11)

Note: Version bump only for package @stryker-mutator/html-reporter

2.0.1 (2019-07-02)

Bug Fixes

html: set utf-8 charset (#1592) (fb858ca)

2.0.0 (2019-05-17)

Features

node 6: drop support for node 6 (#1517) (801d7cd)

BREAKING CHANGES

node 6: support for Node 6 has been dropped. Node 8 or higher is now required.

1.3.1 (2019-04-26)

Note: Version bump only for package @stryker-mutator/html-reporter

1.3.0 (2019-04-24)

Bug Fixes

html: load report json from a js file (#1485) (9bee2a7), closes #1482

1.2.0 (2019-04-02)

Features

html-reporter: use mutation-testing-elements (2f6df38)
peer-dep: update stryker core to v1.2 (d798b19)

1.1.1 (2019-03-21)

Note: Version bump only for package @stryker-mutator/html-reporter

1.1.0 (2019-03-04)

Note: Version bump only for package @stryker-mutator/html-reporter

1.0.3 (2019-02-26)

Note: Version bump only for package @stryker-mutator/html-reporter

1.0.2 (2019-02-13)

Bug Fixes

stryker init: update metadata for stryker init command (#1403) (38f269b), closes #1402

1.0.1 (2019-02-13)

Note: Version bump only for package @stryker-mutator/html-reporter

1.0.0 (2019-02-13)

Features

rename: rename stryker-xxx-xxx -> [@stryker-mutator](https://github.com/stryker-mutator)/xxx-xxx (1bbd6ff)

BREAKING CHANGES

rename: The core package and plugins have been renamed: stryker-html-reporter -> @stryker-mutator/html-reporter

0.18.1 (2019-02-12)

Note: Version bump only for package stryker-html-reporter

0.18.0 (2019-02-08)

Features

html-reporter: Remove side effects from html reporter (#1314) (66d65f7)

0.17.0 (2018-12-23)

Features

stryker-api: Support stryker-api 0.23 (#1293) (10720ad)

0.16.10 (2018-12-12)

Note: Version bump only for package stryker-html-reporter

0.16.9 (2018-11-29)

Bug Fixes

stryker-api: Update stryker-api peer dependency version (677fc28)

0.16.8 (2018-11-29)

Note: Version bump only for package stryker-html-reporter

0.16.7 (2018-11-13)

Note: Version bump only for package stryker-html-reporter

0.16.6 (2018-11-07)

Note: Version bump only for package stryker-html-reporter

0.16.5 (2018-10-15)

Bug Fixes

any-promise: Don't register a promise implementation (#1180) (1d3e2f6)

0.16.4 (2018-10-03)

Note: Version bump only for package stryker-html-reporter

0.16.3 (2018-09-30)

Note: Version bump only for package stryker-html-reporter

0.16.2 (2018-09-14)

Note: Version bump only for package stryker-html-reporter

0.16.1 (2018-08-21)

Note: Version bump only for package stryker-html-reporter

0.16.0 (2018-08-19)

Features

stryker config: rename config setting reporter to reporters (#1088) (584218a), closes #793

0.15.3 (2018-08-17)

Bug Fixes

dependencies: support stryker-api 0.19.0 (#1087) (44ce923)

0.15.2 (2018-08-17)

Note: Version bump only for package stryker-html-reporter

0.15.1 (2018-08-03)

Note: Version bump only for package stryker-html-reporter

0.15.0 (2018-07-20)

Bug Fixes

Dependencies: Pin all deps on minor version (#974) (f0a7e5a), closes #954 #967

Features

logging: Allow log to a file (#954) (c2f6b82), closes #748

0.14.3 (2018-07-04)

Note: Version bump only for package stryker-html-reporter

0.14.2 (2018-05-31)

Note: Version bump only for package stryker-html-reporter

0.14.1 (2018-05-21)

Note: Version bump only for package stryker-html-reporter

0.14.0 (2018-04-30)

Features

node version: drop node 4 support (#724) (a038931)

BREAKING CHANGES

node version: Node 4 is no longer supported.

0.13.3 (2018-04-20)

Note: Version bump only for package stryker-html-reporter

0.13.2 (2018-04-12)

Note: Version bump only for package stryker-html-reporter

0.13.1 (2018-04-11)

Bug Fixes

Support stryker-api 0.16.0 (#691) (b2b019d)

0.13.0 (2018-04-04)

Note: Version bump only for package stryker-html-reporter

0.12.4 (2018-03-22)

Bug Fixes

peerDependency: update stryker-api requirement to ^0.14.0 (3ce04d4)

0.12.3 (2018-03-22)

Note: Version bump only for package stryker-html-reporter

0.12.2 (2018-03-21)

Note: Version bump only for package stryker-html-reporter

0.12.1 (2018-02-07)

Bug Fixes

dependencies: update stryker-api requirement to ^0.13.0 (8eba6d4)

0.12.0 (2018-02-07)

Features

coverage analysis: Support transpiled code (#559) (7c351ad)

0.11.5 (2018-01-24)

Note: Version bump only for package stryker-html-reporter

0.11.4 (2017-12-21)

Note: Version bump only for package stryker-html-reporter

0.11.3 (2017-12-05)

Note: Version bump only for package stryker-html-reporter

0.11.2 (2017-11-27)

Note: Version bump only for package stryker-html-reporter

0.11.1 (2017-11-13)

Note: Version bump only for package stryker-html-reporter

0.11.0 (2017-10-29)

Features

html reporter: Make report gh-pages compatible (#432) (cfc1fb2), closes #420

0.10.2 (2017-10-26)

Bug Fixes

html report: Add consistency in numbering of mutants (#431) (67be708), closes #422

0.10.1 (2017-10-24)

Note: Version bump only for package stryker-html-reporter

0.10.0 (2017-10-20)

Note: Version bump only for package stryker-html-reporter

0.9.1 (2017-10-11)

Bug Fixes

readme: Remove old warning and update the example image (#416) (7e66214)

0.9.0 (2017-10-10)

Features

html-report: Revamp html report (#399) (5390d15), closes #386 #385 #383

0.8.0 (2017-09-19)

Features

typescript: Add support for TypeScript mutation testing (#376) (ba78168)

BREAKING CHANGES

typescript: * Hoist the Mutator interface to a higher abstraction. With this interface it was possible to add mutators for specific ES5 AST nodes. As we're moving away from ES5, this plugin abstraction had to be hoisted to a higher level. It is no longer possible to plugin a specific ES5 node mutator.
Update report interface: Rename MutantState.Error => MutantState.RuntimeError.

0.7.2 (2017-09-09)

Bug Fixes

one file directories: Add support single file dirs (#377) (27c3e10)

0.7.1 (2017-09-03)

Note: Version bump only for package stryker-html-reporter

0.7.0 (2017-08-25)

Code Refactoring

change ConfigWriter interface name to ConfigEditor (#357) (ec4ae03)

BREAKING CHANGES

Public api for ConfigWriter is renamed to ConfigEditor. The corresponding write method is renamed to edit. If you're using custom ConfigWriter plugins you should rename the write method to edit. Please update the stryker-mocha-framework and stryker-karma-runner to the latest versions as they provide the new ConfigEditor plugin.

0.6.0 (2017-08-11)

Features

ci-integration: Configurable thresholds based on mutation score (#355) (93f28cc), closes #220
IsolatedTestRunner: Handle promise rejections (#351) (f596993)

0.5.0 (2017-08-04)

Features

html-reporter: Score result as single source of truth (#341) (47b3295), closes #335

0.4.7 (2017-07-14)

0.4.6 (2017-06-16)

Bug Fixes

npmignore: Align npm ignores (#321) (db2a56e)
Manual version bump (a67d90b)

0.4.3 (2017-06-08)

0.4.2 (2017-06-05)

Bug Fixes

deps: Alter stryker-api to be a peerDependency (340487f)
deps: Set version of stryker-api (cf1f125)

0.3.0 (2016-11-20)

Features

error-result: Show error and other statistics (#7) (3d61cee)

0.2.2 (2016-10-06)

Bug Fixes

file-report: Remove strikethrough extra char (#6) (4cd02be)

0.2.1 (2016-10-03)

Bug Fixes

deps: Set version of stryker-api (b31d963)

Features

ts2.0: Migrate to typescript 2.0 (#4) (0b0109f)

0.1.1 (2016-07-19)

Bug Fixes

file-utils: Fix error in recursive dir cleaning (00fb284)
html-reporter: Create file system (8120977)
stryker-test: Removed useless assertion (bf98da2)
stryker-test: Test on unix (0be41d2)
stryker-test: Test on unix (6a89f02)
stryker-test: Test on unix (f65cef6)

0.1.0 (2016-07-08)

Bug Fixes

deps: Alter stryker-api to be a peerDependency (7fce9f5)