57 lines
1.7 KiB
JavaScript
57 lines
1.7 KiB
JavaScript
/*
|
|
Copyright 2012-2015, Yahoo Inc.
|
|
Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* @module Exports
|
|
*/
|
|
|
|
const summarizer = require('./lib/summarizer');
|
|
const context = require('./lib/context');
|
|
const watermarks = require('./lib/watermarks');
|
|
|
|
module.exports = {
|
|
/**
|
|
* returns a reporting context for the supplied options
|
|
* @param {Object} [opts=null] opts
|
|
* @returns {Context}
|
|
*/
|
|
createContext(opts) {
|
|
return context.create(opts);
|
|
},
|
|
/**
|
|
* returns the default watermarks that would be used when not
|
|
* overridden
|
|
* @returns {Object} an object with `statements`, `functions`, `branches`,
|
|
* and `line` keys. Each value is a 2 element array that has the low and
|
|
* high watermark as percentages.
|
|
*/
|
|
getDefaultWatermarks() {
|
|
return watermarks.getDefault();
|
|
}
|
|
};
|
|
/**
|
|
* standard summary functions
|
|
*/
|
|
module.exports.summarizers = {
|
|
/**
|
|
* a summarizer that creates a flat tree with one root node and bunch of
|
|
* files directly under it
|
|
*/
|
|
flat: summarizer.createFlatSummary,
|
|
/**
|
|
* a summarizer that creates a hierarchical tree where the coverage summaries
|
|
* of each directly reflect the summaries of all subdirectories and files in it
|
|
*/
|
|
nested: summarizer.createNestedSummary,
|
|
/**
|
|
* a summarizer that creates a tree in which directories are not nested.
|
|
* Every subdirectory is a child of the root node and only reflects the
|
|
* coverage numbers for the files in it (i.e. excludes subdirectories).
|
|
* This is the default summarizer.
|
|
*/
|
|
pkg: summarizer.createPackageSummary
|
|
};
|