node-coveralls

[![Build Status][ci-image]][ci-url] [![Coverage Status][coveralls-image]][coveralls-url]

Coveralls.io support for Node.js. Get the great coverage reporting of coveralls.io and add a cool coverage button (like the one above) to your README.

Supported CI services:

* Travis CI
* CodeShip
* CircleCI
* Jenkins
* Gitlab CI
* AppVeyor
* Buildkite
* GitHub Actions CI
* CodeFresh

Installation:

Add the latest version of coveralls to your package.json:

``shell
npm install coveralls --save-dev
`

If you're using mocha, add mocha-lcov-reporter to your package.json:

`shell
npm install mocha-lcov-reporter --save-dev
`

Usage:

This script bin/coveralls.js can take standard input from any tool that emits the lcov data format (including mocha's LCOV reporter) and send it to coveralls.io to report your code coverage there.

Once your app is instrumented for coverage, and building, you need to pipe the lcov output to ./node_modules/coveralls/bin/coveralls.js.

This library currently supports Travis CI with no extra effort beyond piping the lcov output to coveralls. However, if you're using a different build system, there are a few necessary environment variables:

- COVERALLS_SERVICE_NAME (the name of your build system)
- COVERALLS_REPO_TOKEN (the secret repo token from coveralls.io)
- COVERALLS_GIT_BRANCH (the branch name)

There are optional environment variables for other build systems as well:

- COVERALLS_FLAG_NAME (a flag name to differentiate jobs, e.g. Unit, Functional, Integration)
- COVERALLS_SERVICE_NUMBER (a number that uniquely identifies the build)
- COVERALLS_SERVICE_JOB_ID (an ID that uniquely identifies the build's job)
- COVERALLS_SERVICE_JOB_NUMBER (a number that uniquely identifies the build's job)
- COVERALLS_RUN_AT (a date string for the time that the job ran. RFC 3339 dates work. This defaults to your build system's date/time if you don't set it)
- COVERALLS_PARALLEL (set to true when running jobs in parallel, requires a completion webhook. More info here: )

$3

If you are using GitHub Actions CI, you should look into coverallsapp/github-action.

Parallel runs example workflow.yml

$3

Here's our Orb for quick integration: coveralls/coveralls

Workflow example: config.yml

$3

Parallel jobs example: .travis.yml

$3

- Install jest
- Use the following to run tests and push files to coveralls on success:

`sh
jest --coverage && coveralls < coverage/lcov.info
`

Check out an example here which makes use of Travis CI build stages

$3

- Install blanket.js
- Configure blanket according to docs.
- Run your tests with a command like this:

`sh
NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
--require blanket \
--reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
`

$3

Instrumenting your app for coverage is probably harder than it needs to be (read here), but that's also a necessary step.

In mocha, if you've got your code instrumented for coverage, the command for a Travis CI build would look something like this:

`sh
YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha test -R mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
`

Check out an example Makefile from one of my projects for an example, especially the test-coveralls build target. Note: Travis CI runs npm test, so whatever target you create in your Makefile must be the target that npm test runs (This is set in package.json's scripts property).

$3

#### With Mocha:

`sh
istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
`

#### With Jasmine:

`sh
istanbul cover jasmine-node --captureExceptions spec/ && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
`

$3

Depend on nodeunit, jscoverage, and coveralls:

`sh
npm install nodeunit jscoverage coveralls --save-dev
`

Add a coveralls script to "scripts" in your package.json:

`json
"scripts": {
"test": "nodeunit test",
"coveralls": "jscoverage lib && YOURPACKAGE_COVERAGE=1 nodeunit --reporter=lcov test | coveralls"
}
`

Ensure your app requires instrumented code when process.env.YOURPACKAGE_COVERAGE variable is defined.

Run your tests with a command like this:

`sh
npm run coveralls
`

For detailed instructions on requiring instrumented code, running on Travis CI and submitting to coveralls see this guide.

$3

Client-side JS code coverage using PhantomJS, Mocha and Blanket:

- Configure Mocha for browser
- Mark target script(s) with data-cover HTML attribute
- Run your tests with a command like this:

`sh
./node_modules/.bin/poncho -R lcov test/test.html | ./node_modules/coveralls/bin/coveralls.js
`

$3

`sh
lab -r lcov | ./node_modules/.bin/coveralls
`

$3

Works with almost any testing framework. Simply execute
npm test with the nyc bin followed by running its reporter:

`shell
nyc npm test && nyc report --reporter=text-lcov | coveralls
`

$3

Simply run your tap tests with the COVERALLS_REPO_TOKEN environment
variable set and tap will automatically use nyc to report
coverage to coveralls.

$3

`shell
Usage: coveralls.js [-v] filepath
`

#### Optional arguments:

- -v, --verbose
- filepath - optionally defines the base filepath of your source files.

Running locally

If you're running locally, you must have a .coveralls.yml file, as documented in their documentation, with your repo_token in it; or, you must provide a COVERALLS_REPO_TOKEN environment variable on the command-line.

If you want to send commit data to coveralls, you can set the COVERALLS_GIT_COMMIT environment-variable to the commit hash you wish to reference. If you don't want to use a hash, you can set it to HEAD` to supply coveralls with the latest commit data. This requires git to be installed and executable on the current PATH.

Contributing

I generally don't accept pull requests that are untested or break the build, because I'd like to keep the quality high (this is a coverage tool after all!).

I also don't care for "soft-versioning" or "optimistic versioning" (dependencies that have ^, x, > in them, or anything other than numbers and dots). There have been too many problems with bad semantic versioning in dependencies, and I'd rather have a solid library than a bleeding-edge one.

[ci-image]: https://github.com/nickmerwin/node-coveralls/workflows/Tests/badge.svg
[ci-url]: https://github.com/nickmerwin/node-coveralls/actions?workflow=Tests

[coveralls-image]: https://coveralls.io/repos/nickmerwin/node-coveralls/badge.svg?branch=master&service=github
[coveralls-url]: https://coveralls.io/github/nickmerwin/node-coveralls?branch=master