buster extension for istanbul code coverage.
npm install buster-istanbulbusterjs coverage extension
Add buster-istanbul as a dependency in your package.json file.
``json`
{
"name": "awesome name",
...
"dependencies": {
"buster-istanbul": "*"
}
}
Configure buster to use buster-istanbul as extension
`javascript
module.exports.tests = {
environment: "node",
rootPath : "./",
sources: [
"src/*/.js"
],
tests : [
"test/*/-test.js"
],
"buster-istanbul": {
outputDirectory: "coverage",
format: "lcov",
excludes: ["*/.json"]
},
extensions: [
require('buster-istanbul')
]
};
`
Buster JS options
sources will be the files that will be instrumented.
buster-istanbul options
outputDirectory is path to where the files will be written to.
Defaults to the current working directory.
format is a _string_ or a _list_ of formats to generate.
Currently supported formats:
* lcov
* cobertura
* json
* text
* text-summary
if text and text-summary formats are given, coverage.txt and coverage-summary.txt
files will be generated besides being output to the console at the same time.
silent is a flag to turn off reporting at the end of the test run.true
Valid values is or false. Defaults to false.
instrument is a flag to turn off instrumentation of your source file.true
You will need to handle this yourself. Defaults to .
excludes` is an array of glob paths that will be excluded from instrumentation.
This can be helpful if your sources include non-js files that needed to be excluded, such as .html or .json files.
Consult node-glob for more information on globs.
Write your buster test as usual.
Example project: buster-istanbul-demo