istanbul-coveralls
Version:
A simple alias for istanbul + coveralls
63 lines (40 loc) ⢠2.23 kB
Markdown
# istanbul-coveralls
[](https://www.npmjs.com/package/istanbul-coveralls)
[](https://travis-ci.org/shinnn/istanbul-coveralls)
[](https://coveralls.io/r/shinnn/istanbul-coveralls?branch=master)
[](https://david-dm.org/shinnn/istanbul-coveralls)
[](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 - 2015 [Shinnosuke Watanabe](https://github.com/shinnn)
Licensed under [the MIT LIcense](./LICENSE).