# grunt-lcov-merge2

> Grunt plugin to merge lcov files from multiple test runs.

Latest version **2.0.0** (published 2016-08-09) · 0 weekly downloads

## Install

```sh
npm install grunt-lcov-merge2
pnpm add grunt-lcov-merge2
yarn add grunt-lcov-merge2
bun add grunt-lcov-merge2
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-08-09 |
| First published | 2016-08-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | jemonjam |
| Maintainers | scttdavs |
| Keywords | gruntplugin, lcov, coverage |

## Links

- npm: https://www.npmjs.com/package/grunt-lcov-merge2
- Repository: https://github.com/jacob-meacham/grunt-lcov-merge
- Homepage: https://github.com/scttdavs/grunt-lcov-merge
- Issues: https://github.com/scttdavs/grunt-lcov-merge/issues
- npm.io page: https://npm.io/package/grunt-lcov-merge2

## Dependencies (6)

- [async](https://npm.io/package/async.md) 0.9.0
- [chalk](https://npm.io/package/chalk.md) 0.5.1
- [vinyl](https://npm.io/package/vinyl.md) 0.4.6
- [through2](https://npm.io/package/through2.md) 0.6.3
- [vinyl-fs](https://npm.io/package/vinyl-fs.md) 0.3.13
- [lcov-result-merger](https://npm.io/package/lcov-result-merger.md) 1.0.2

## Recent versions

- 2.0.0 (latest) — 2016-08-09

## README

# grunt-lcov-merge
[![Build Status](https://travis-ci.org/scttdavs/grunt-lcov-merge.svg?branch=master)](https://travis-ci.org/scttdavs/grunt-lcov-merge)

> Grunt plugin to merge lcov files from multiple test runs, for use with a tool like [coveralls](coveralls.io).

### This fork is intended to update grunt to 1.x since the original repo seems dead.

## Getting Started
This plugin requires Grunt `0.4.0`

To install, add grunt-lcov-merge to your package.json. The easiest way to do that is

```shell
npm install grunt-lcov-merge --save-dev
```

Once the plugin has been installed, you'll need to enable it in your Gruntfile by adding

```js
grunt.loadNpmTasks('grunt-lcov-merge');
```

You can then run with
```shell
grunt lcovMerge
```

## Options
#### emitters
Type: `Array`
Default: `['file']`

What emitters to send the merged data to. Supported emitters are 'file', which sends the merged data to a file, and 'event', which sends it out to the 'coverage' event and can be listened to with

```js
grunt.event.on('coverage', function(lcov, done) {});
```

#### outputFile
Type: `String`
Default `coverage/lcov-merge.info`

If a file emitter is specified, this is the output file to pipe data to.

### Example
```js
    grunt.initConfig({
    jshint: {
        src: ['Gruntfile.js', 'tasks/**/*.js', 'test/**/*.js'],
        options: {
            jshintrc: true
        }
    },

    mocha_istanbul: {
      coverage: {
          src: 'test/**/*.spec.js',
          options: {
              coverageFolder: 'build/coverage',
              reportFormats: ['lcov'],
          }
      }
    },

    lcovMerge: {
      options: {
          emitters: ['event', 'file'],
          outputFile: 'mergeLcov.info'
      },
      src: ['build/coverage/*.info', 'build/coverage/**/*.info']
    }
  });

  grunt.event.on('coverage', function(lcov, done) {
    // See below
    done();
  });

  grunt.loadNpmTasks('grunt-lcov-merge');
```

Note that grunt-lcov-merge allows for source files to be specified via any [file format](http://gruntjs.com/configuring-tasks#files).

## Event emitter
One of the most useful ways to consume this plugin is to use the coverage event to send the lcov data to a service like coveralls:

```js
grunt.event.on('coverage', function(lcov, done) {
    require('coveralls').handleInput(lcov, function(err) {
        if (err) {
          return done(err);
        }
        done();
    });
```

Using the coveralls module means that Travis-CI can automatically send your merged LCOV to coveralls.

## Version History
* 0.1.0 - Initial version
* 0.1.1 - Trim down the number of files in the distribution
* 0.1.2. - Update dependencies, work around coveralls issue.
* 0.1.3 - Documentation updates
* 1.0.0 - Official release

---
_Source: https://npm.io/package/grunt-lcov-merge2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._