https://github.com/shinnn/istanbul-coveralls

A simple alias for istanbul + node-coveralls
https://github.com/shinnn/istanbul-coveralls

cli command-line coverage coveralls javascript report

Last synced: 16 days ago
JSON representation

A simple alias for istanbul + node-coveralls

• Host: GitHub
• URL: https://github.com/shinnn/istanbul-coveralls
• Owner: shinnn
• License: mit
• Created: 2014-08-27T07:15:01.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-01-09T04:51:28.000Z (almost 6 years ago)
• Last Synced: 2024-12-03T07:41:22.553Z (20 days ago)
• Topics: cli, command-line, coverage, coveralls, javascript, report
• Language: JavaScript
• Homepage:
• Size: 16.6 KB
• Stars: 21
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# istanbul-coveralls 

[![NPM version](https://img.shields.io/npm/v/istanbul-coveralls.svg)](https://www.npmjs.com/package/istanbul-coveralls)

[![Build Status](https://travis-ci.org/shinnn/istanbul-coveralls.svg?branch=master)](https://travis-ci.org/shinnn/istanbul-coveralls)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/istanbul-coveralls.svg)](https://coveralls.io/r/shinnn/istanbul-coveralls?branch=master)

[![Dependency Status](https://david-dm.org/shinnn/istanbul-coveralls.svg)](https://david-dm.org/shinnn/istanbul-coveralls)

[![devDependency Status](https://david-dm.org/shinnn/istanbul-coveralls/dev-status.svg)](https://david-dm.org/shinnn/istanbul-coveralls#info=devDependencies)

A simple alias for [istanbul](https://github.com/gotwarlost/istanbul) + [node-coveralls](https://github.com/cainus/node-coveralls)

```sh

istanbul cover test.js && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage

```

↓

```sh

istanbul cover test.js && istanbul-coveralls

```

## Installation

[Use npm](https://docs.npmjs.com/cli/install).

```sh

npm install --save-dev istanbul istanbul-coveralls

```

## Usage

1. Write a coverage information file under `./coverage` by using [`istanbul cover` command](https://github.com/gotwarlost/istanbul#the-cover-command) or [the API of istanbul](https://github.com/gotwarlost/istanbul#api).

2. Run `istanbul-coveralls` command. See [the docs of node-coveralls](https://github.com/cainus/node-coveralls#usage) for more information about its usage.

### Option

#### `--no-rm`

By default, it removes `./coverage` after coverage reporting. If `--no-rm` flag is enabled, it doesn't remove the directory.

```sh

istanbul cover test.js && istanbul-coveralls --no-rm

```

## Example

### [Mocha](http://mochajs.org/)

```sh

istanbul cover ./node_modules/.bin/_mocha && ./node_modules/.bin/istanbul-coveralls

```

If you run the test as a [npm script](https://docs.npmjs.com/misc/scripts), [you can omit directory names from the command](https://docs.npmjs.com/misc/scripts#path).

```sh

istanbul cover _mocha && istanbul-coveralls

```

## License

Copyright (c) 2014 - 2016 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT LIcense](./LICENSE).