istanbul-reporter-clover-limits

An istanbul report implementation that produces a clover xml file and summary test coverage json file with configurable watermarks.

Usage

Register

Register the report using the istanbul Report factory.

var cloverLimitsReport = require('istanbul-reporter-clover-limits');
var istanbul = require('istanbul');
istanbul.Report.register(cloverLimitsReport);

Create

Create a report after istanbul has collected coverage information.

var report = require('istanbul').Report.create('clover-limits');

API

istanbul-reporter-clover-limits : name

An istanbul report implementation that produces a clover xml file and summary test coverage json file with configurable watermarks..

Extends: istanbul.Report

| Param | Type | Description | | --- | --- | --- | | opts | Object | optional | | [opts.dir] | String | the directory in which to the clover report will be written | | [opts.file] | String | the file name for the coverage report, defaulted to config attribute or "clover.xml" | | [opts.testDir] | String | the directory in which to the summary coverage test report will be written | | [opts.testFile] | String | the file name for the summary coverage test report, defaulted to config attribute or "clover-tests.json" | | [opts.watermarks] | Object | watermarks with three limits for the coverage report and summary coverage test report. 1) lower limit for html report and minimum code coverage test 2) mid limit for html report 3) skipped limit for maximum skipped code test Only the lower limit [index 0] and skipped [index 2] is used by the summary coverage test report. Example watermark object: { statements: [ 50, 80, 20 ], lines: [ 50, 80, 20], functions: [ 50, 80, 20], branches: [ 50, 80, 20 ] } |

• istanbul-reporter-clover-limits : name
  • ~writeFile(file, callback)
  • ~copyFile(source, dest)
  • ~done()

istanbul-reporter-clover-limits~writeFile(file, callback)

allows writing content to a file using a callback that is passed a content writer

Kind: inner method of istanbul-reporter-clover-limits

| Param | Description | | --- | --- | | file | the name of the file to write | | callback | the callback that is called as callback(contentWriter) |

istanbul-reporter-clover-limits~copyFile(source, dest)

copies a file from source to destination

Kind: inner method of istanbul-reporter-clover-limits

| Param | Description | | --- | --- | | source | the file to copy, found on the file system | | dest | the destination path |

istanbul-reporter-clover-limits~done()

marker method to indicate that the caller is done with this writer object The writer is expected to emit a done event only after this method is called and it is truly done.

Kind: inner method of istanbul-reporter-clover-limits

documented by jsdoc-to-markdown.

Changelog

License

MIT License (MIT). All rights not explicitly granted in the license are reserved.

Copyright (c) 2015 John Barry

Dependencies

[email protected] - "MIT License (MIT)", documented by npm-licenses.