wct-istanbub
v0.2.10
Published
Instanbuljs coverage reporting for projects being tested by web-component-tester
Downloads
333
Maintainers
Readme
WCT-istanbub
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.
In order to use this coverage plugin use at least version 6.4.0 of web-component-tester
Check out this test repository for an example with 'app' and travis build
Installation
npm install wct-istanbub --save-dev
Basic Usage
Add the following configuration to web-component-tester's config file.
Example
module.exports = {
plugins: {
istanbub: {
reporters: ["text-summary", "lcov"],
include: [
"**/*.html"
],
exclude: [
"**/test/**"
]
}
}
}
Options
Below are the available configuration options:
reporters
An array of istanbul reporters to use.
include
Files to include in instrumentation, default the basepath will be added - /components/${packagename}/{includepaths}
exclude
Files to exclude from instrumentation (this trumps files 'included' with the option above).
By default the '/test/' is excluded as istanbub crashes on some of the test tooling used by most projects and testing the coverage of your test files is not really useful.
default the basepath will be added - /components/${packagename}/{excludepaths}
configFile
Path to an Istanbul configuration file.
configOverrides
Overrides for the default Istanbul configuration. Check the default configuration for all available options.
ignoreBasePath
Don't add the basepath to the include & exclude array's for specific use-cases
npm
Support for npm based on where to retrieve basic assets from node_modules
instead of bower_components
moduleResolution
Define support module import (node) or none, allowed values: node
and none
Defaults to none if npm false
or node if npm is true
isComponentRequestOverride
Override the componentRequest check
babelPlugins
Add babel plugins to default set: [importMeta
, asyncGenerators
, dynamicImport
, objectRestSpread
, optionalCatchBinding
, flow
, jsx
],
for example [dotallRegex
]. Duplicates will be filtered out
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
writeOnlyOnSuccess false
Set to true
to write coverage only if all tests pass
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: {
istanbub: {
dir: "./coverage",
reporters: ["text-summary", "lcov"],
include: [
"**/*.html"
],
exclude: [
"**/test/**"
],
thresholds: {
global: {
statements: 100
}
}
}
}
}