grunt-karma-coveralls

An npm module for using Karma and Coveralls with Grunt

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
grunt-karma-coveralls
3512.5.47 years ago9 years agoMinified + gzip package size for grunt-karma-coveralls in KB

Readme

Build Status
grunt-karma-coveralls

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-karma-coveralls --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-karma-coveralls');

Grunt Configuration Example:

coveralls: {
    options: {
        debug: true,
        coverageDir: 'directory name',
        dryRun: true,
        force: true,
        recursive: true
    }
}

Optional Configuration Options

dryRun: [boolean]

Using this option you can run coverage without sending data to the coveralls service and instead writing the results to coveralls.json.
force: [boolean]

Using this option you can ensure that if there is a failure, ie: the coveralls service is down, your grunt tasks will continue to run and not terminate due to the error.
recursive: [boolean]

This option defaults to `true. If it is set to true coverageDir will be searched recursively for lcov.info`. Otherwise the subdirectories will be ignored.
If you haven't used Karma before, check out the video on the homepage.

Karma Configuration Example:

reporters: ['coverage'],
preprocessors: {
    "**/lib/*js": "coverage"
},
coverageReporter: {
    type: "lcov",
    dir: "coverage/"
},
plugins: [
    'karma-coverage',
]