npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

karma-iced-coffee-coverage

v1.1.2

Published

Plugins for Karma to use the iced-coffee-coverage tool

Downloads

7

Readme

karma-iced-coffee-coverage

Build Status Coverage Status Dependency Status devDependency Status Downloads

A set of plugins for the Karma Test Runner to support iced-coffee-coverage

NPM

Preprocessor

Use the iced-coffee-coverage preprocessor in place of karma-coffee-preprocessor to compile coffee to js that will also be instrumented for karma-coverage to use.

Usage

In your karma.conf.*

// instrument `coffee` files on the fly
preprocessors: [
    '**/*.coffee': ['iced-coffee-coverage']
],

// configure the processor plugin to use `istanbul` style
icedCoffeeCoverage: {
    preprocessor: {
        instrumentor: 'istanbul'
    }
}

Options

You can pass anything that you would pass to the iced-coffee-coverage constructor. Most notably the instrumentor option.

Framework Plugin

What problem is this solving??

Say you have foo.coffee and bar.coffee as client side files. You only have written tests for foo.coffee and, therefore, have not included bar.coffee in your karma config's files list. If you cover, say, 80% of foo.coffee in your tests, your report will mirror that. However, you haven't tested bar.coffee at all! A more realistic report would be to say you have covered 80% of foo.coffee, and 0% of bar.coffee. Therefore, your overall coverage report should say 40%. How to fix that? Use this plugin to create an initial empty coverage object that contains empty entries for all the sources you would like to report on (usually your entire client side source).

What the plugin will do is run iced-coffee-coverage on basePath, and generate a javascript file containing all the coverage intialization code for that directory. You can then include this file in your config files property, and will thus include the zero counts in any reports your generate. karma-coverage will merge this with any actual counts that are covered during the tests.

This is useful in conjunction with browserify-iced-coffee-coverage

Usage

In your karma.conf.*

// add `karma-iced-coffee-coverage` framework plugin
frameworks: ['iced-coffee-coverage'],

// configure the framework plugin
icedCoffeeCoverage: {
    framework: {
        initAllSources: true,
        sourcesBasePath: 'assets',
        dest: 'build-test/coverage-init.js',
        instrumentor: 'istanbul'
    }
},

// Then ensure that `dest` is included in our `files`
files: ['build-test/coverage-init.js', '**/*Test.js']

Options

You can pass anything that you would pass to the iced-coffee-coverage constructor, as well as these options.

icedCoffeeCoverage.framework.initAllSources

This needs to be true for the plugin to run.

icedCoffeeCoverage.framework.sourcesBasePath

The root directory which you would like to generate initialization coverage for.

icedCoffeeCoverage.framework.dest

The .js file destination to write out the initialization javascript. Include this in your karma files config.

NOTES

Should be used in conjunction with a coverage reporter that supports istanbul or jscoverage, such as karma-coverage.

Can use both framework and preprocessor plugins together.