web-component-tester-istanbulcoverage
v1.0.3
Published
Instanbul coverage reporting for projects being tested by web-component-tester. Web-component-tester version should be greater than 6.4.0
Downloads
10
Maintainers
Readme
Web-Component-Tester-Istanbul
This NPM package is published into https://github.com/AnguloHerrera/web-component-tester-istanbul/tree/npm, because master branch is reserved to the PR to the original repository, and it is pending to merge.
Istanbul coverage plugin for web-component-tester.
Use this plugin to collect and report test coverage (via istanbul) for your project on each test run.
Installation
npm install web-component-tester-istanbulcoverage --save-dev
Basic Usage
Add the following configuration to web-component-tester's config file.
Example
module.exports = {
plugins: {
istanbulcoverage: {
dir: "./coverage",
reporters: ["text-summary", "lcov"],
include: [
"**/*.js"
],
exclude: [
"polymer/polymer.js",
"platform/platform.js"
]
}
}
}
Options
Below are the available configuration options:
dir
The directory to write coverage reports to.
reporters
An array of istanbul reporters to use.
include
Files to include in instrumentation.
exclude
Files to exclude from instrumentation (this trumps files 'included' with the option above).
Coverage Thresholds
In addition to measuring coverage, this plugin can be used to enforce coverage thresholds. If coverage does not meet the configured thresholds, then the test run will fail, even if all tests passed.
This requires specifying the thresholds
option for the plugin
Example
The following configuration will cause the test run to fail if less than 100% of the statements in instrumented files are covered by tests.
module.exports = {
plugins: {
istanbulcoverage: {
dir: "./coverage",
reporters: ["text-summary", "lcov"],
include: [
"**/*.js"
],
exclude: [
"polymer/polymer.js",
"platform/platform.js"
],
thresholds: {
global: {
statements: 100
}
}
}
}
}