Helper-coverage NPM

helper-coverage

Template helper for including a code coverage report generated by istanbul.

Install

Install with npm:

$ npm i helper-coverage --save

Usage

var coverage = require('helper-coverage');

// specify the file to include (generated by istanbul)
coverage('coverage/summary.txt');

Live examples

See fixtures/expected.txt for a full example of the rendered result.
See a live example on the template-helpers readme (generated by verb)

Registering the helper

Handlebars

var handlebars = require('handlebars');
handlebars.registerHelper('coverage', require('helper-coverage'));
handlebars.compile('{{coverage "coverage/summary.txt"}}')();

Verb

var verb = require('verb');
verb.helper('coverage', require('helper-coverage'));
verb.render('{%= coverage("coverage/summary.txt") %}');

Related projects

Use the helper with one of these great projects:

assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage
templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more | homepage
update: Easily keep anything in your project up-to-date by installing the updaters you want to use… more | homepage
verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

engine-base: Default engine for Template. | homepage
engine-handlebars: Handlebars engine, consolidate.js style but with enhancements. This works with Assemble, express.js, engine-cache or any… more | homepage
engine-lodash: Lo-Dash engine, consolidate.js style but with enhancements. Works with Assemble, express.js, engine-cache or any application… more | homepage
handlebars: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration | homepage
lodash: Lodash modular utilities. | homepage

Or any other engine that has support for helper functions.

Related projects

assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage
handlebars-helpers: 120+ Handlebars helpers in ~20 categories, for Assemble, YUI, Ghost or any Handlebars project. Includes… more | homepage
template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
update: Easily keep anything in your project up-to-date by installing the updaters you want to use… more | homepage
verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage