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

	Type	ID	Summary
Version: 0.1.14 - released 2016-07-14
	Non-functional	MDCOVSM-24	Package: Update package dependencies
Version: 0.1.13 - released 2016-06-22
	Non-functional	MDCOVSM-23	Package: Update package dependencies
Version: 0.1.12 - released 2016-03-20
	Non-functional	MDCOVSM-22	Package: Update package dependencies
Version: 0.1.11 - released 2016-02-16
	Non-functional	MDCOVSM-21	Package: Update package dependencies
Version: 0.1.10 - released 2015-11-27
	Non-functional	MDCOVSM-20	Package: Update package dependencies
Version: 0.1.9 - released 2015-11-13
	Non-functional	MDCOVSM-19	Package: Update package dependencies
Version: 0.1.8 - released 2015-08-25
	Non-functional	MDCOVSM-18	Package: Update development dependencies and configure for travis-ci
Version: 0.1.7 - released 2015-05-24
	Non-functional	MDCOVSM-17	Package: Update development dependencies
Version: 0.1.6 - released 2015-05-21
	Non-functional	MDCOVSM-15	Package: Update jsdoc2markdown and regenerate documentation
	Non-functional	MDCOVSM-16	Package: Update dependencies
	Non-functional	MDCOVSM-14	Package: Update eslint configuration, test.js runner and dev dependencies
	Non-functional	MDCOVSM-13	Package: Update eslint configuration, test.js runner and dev dependencies
	Non-functional	MDCOVSM-10	Package: Migrate from jshint to eslint static code analysis
	Non-functional	MDCOVSM-9	Package: Remove all gulp tasks except 'test' and update readme docs
Version: 0.1.5 - released 2014-09-02
	Bug	MDCOVSM-8	Clover-limits: Fix pending statistic output from '5' to '0'.
Version: 0.1.4 - released 2014-09-01
	Feature	MDCOVSM-6	Clover-limits: Add skipped code coverage limits and tests to report. As a developer I can get clover-style json summary report for Atlassian Bamboo Test Mocha Parser with configurable limits including skipped code using Istanbul ignore directives So that I can get more efficient and accurate code coverage reporting
Version: 0.1.3 - released 2014-09-01
	Bug	MDCOVSM-7	Clover-limits: Fix NaN error in lines of code report output.
Version: 0.1.2 - released 2014-08-21
	Non-functional	MDCOVSM-5	Package: Update dependencies.
Version: 0.1.1 - released 2014-08-20
	Bug	MDCOVSM-4	Package: Fix path to main script in package.json.
Version: 0.1.0 - released 2014-08-20
	Feature	MDCOVSM-3	Package: Develop clover-style json report with configurable limits for istanbul. As a developer I can get clover-style json summary report for Atlassian Bamboo Test Mocha Parser with configurable limits including skipped code using Istanbul ignore directives So that I can get more efficient and accurate code coverage reporting

License

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

Copyright (c) 2015 John Barry

Dependencies

istanbul-reporter-clover-limits@0.1.13 - "MIT License (MIT)", documented by npm-licenses.