1 | # node-coveralls
|
2 |
|
3 | [![Build Status][ci-image]][ci-url] [![Coverage Status][coveralls-image]][coveralls-url]
|
4 |
|
5 | [Coveralls.io](https://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.
|
6 |
|
7 | Supported CI services: [Travis CI](https://travis-ci.org/), [CodeShip](https://codeship.com/), [CircleCI](https://circleci.com/), [Jenkins](https://jenkins.io/), [Gitlab CI](https://gitlab.com/), [AppVeyor](https://www.appveyor.com/), [Buildkite](https://buildkite.com/), [GitHub Actions CI](https://github.com/features/actions), [CodeFresh](https://codefresh.io)
|
8 |
|
9 | ## Installation:
|
10 |
|
11 | Add the latest version of `coveralls` to your package.json:
|
12 |
|
13 | ```shell
|
14 | npm install coveralls --save-dev
|
15 | ```
|
16 |
|
17 | If you're using mocha, add `mocha-lcov-reporter` to your package.json:
|
18 |
|
19 | ```shell
|
20 | npm install mocha-lcov-reporter --save-dev
|
21 | ```
|
22 |
|
23 | ## Usage:
|
24 |
|
25 | This script `bin/coveralls.js` can take standard input from any tool that emits the lcov data format (including [mocha](https://mochajs.org/)'s [LCOV reporter](https://npmjs.org/package/mocha-lcov-reporter)) and send it to coveralls.io to report your code coverage there.
|
26 |
|
27 | Once your app is instrumented for coverage, and building, you need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
|
28 |
|
29 | This library currently supports [Travis CI](https://travis-ci.org/) with no extra effort beyond piping the lcov output to coveralls. However, if you're using a different build system, there are a few environment variables that are necessary:
|
30 |
|
31 | - `COVERALLS_SERVICE_NAME` (the name of your build system)
|
32 | - `COVERALLS_REPO_TOKEN` (the secret repo token from coveralls.io)
|
33 | - `COVERALLS_GIT_BRANCH` (the branch name)
|
34 |
|
35 | There are optional environment variables for other build systems as well:
|
36 |
|
37 | - `COVERALLS_SERVICE_NUMBER` (an id that uniquely identifies the build)
|
38 | - `COVERALLS_SERVICE_JOB_ID` (an id that uniquely identifies the build's job)
|
39 | - `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.)
|
40 | - `COVERALLS_PARALLEL` (more info here: <https://docs.coveralls.io/parallel-build-webhook>)
|
41 |
|
42 | ### GitHub Actions CI
|
43 |
|
44 | If you are using GitHub Actions CI, you should look into [coverallsapp/github-action](https://github.com/coverallsapp/github-action).
|
45 |
|
46 | If you prefer to use this package you can do it like this:
|
47 |
|
48 | ```yml
|
49 | env:
|
50 | COVERALLS_REPO_TOKEN: "${{ secrets.COVERALLS_REPO_TOKEN }}"
|
51 | COVERALLS_GIT_BRANCH: "${{ github.ref }}"
|
52 | ```
|
53 |
|
54 | ### [Jest](https://jestjs.io/)
|
55 |
|
56 | - Install [jest](https://jestjs.io/docs/en/getting-started)
|
57 | - Use the following to run tests and push files to coveralls on success:
|
58 |
|
59 | ```sh
|
60 | jest --coverage && coveralls < coverage/lcov.info
|
61 | ```
|
62 |
|
63 | Check out an example [here](https://github.com/Ethan-Arrowood/harperdb-connect/blob/master/.travis.yml) which makes use of Travis CI build stages
|
64 |
|
65 | ### [Mocha](https://mochajs.org/) + [Blanket.js](https://github.com/alex-seville/blanket)
|
66 |
|
67 | - Install [blanket.js](https://github.com/alex-seville/blanket)
|
68 | - Configure blanket according to [docs](https://github.com/alex-seville/blanket/blob/master/docs/getting_started_node.md).
|
69 | - Run your tests with a command like this:
|
70 |
|
71 | ```sh
|
72 | NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
|
73 | --require blanket \
|
74 | --reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
|
75 | ```
|
76 |
|
77 | ### [Mocha](https://mochajs.org/) + [JSCoverage](https://github.com/fishbar/jscoverage)
|
78 |
|
79 | Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://seejohncode.com/2012/03/13/setting-up-mocha-jscoverage//)), but that's also a necessary step.
|
80 |
|
81 | In mocha, if you've got your code instrumented for coverage, the command for a Travis CI build would look something like this:
|
82 |
|
83 | ```sh
|
84 | YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha test -R mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
|
85 | ```
|
86 |
|
87 | Check out an example [Makefile](https://github.com/cainus/urlgrey/blob/master/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).
|
88 |
|
89 | ### [Istanbul](https://github.com/gotwarlost/istanbul)
|
90 |
|
91 | #### With Mocha:
|
92 |
|
93 | ```sh
|
94 | istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
|
95 | ```
|
96 |
|
97 | #### With Jasmine:
|
98 |
|
99 | ```sh
|
100 | istanbul cover jasmine-node --captureExceptions spec/ && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
|
101 | ```
|
102 |
|
103 | ### [Nodeunit](https://github.com/caolan/nodeunit) + [JSCoverage](https://github.com/fishbar/jscoverage)
|
104 |
|
105 | Depend on nodeunit, jscoverage and coveralls:
|
106 |
|
107 | ```sh
|
108 | npm install nodeunit jscoverage coveralls --save-dev
|
109 | ```
|
110 |
|
111 | Add a coveralls script to "scripts" in your `package.json`:
|
112 |
|
113 | ```json
|
114 | "scripts": {
|
115 | "test": "nodeunit test",
|
116 | "coveralls": "jscoverage lib && YOURPACKAGE_COVERAGE=1 nodeunit --reporter=lcov test | coveralls"
|
117 | }
|
118 | ```
|
119 |
|
120 | Ensure your app requires instrumented code when `process.env.YOURPACKAGE_COVERAGE` variable is defined.
|
121 |
|
122 | Run your tests with a command like this:
|
123 |
|
124 | ```sh
|
125 | npm run coveralls
|
126 | ```
|
127 |
|
128 | For detailed instructions on requiring instrumented code, running on Travis CI and submitting to coveralls [see this guide](https://github.com/alanshaw/nodeunit-lcov-coveralls-example).
|
129 |
|
130 | ### [Poncho](https://github.com/deepsweet/poncho)
|
131 |
|
132 | Client-side JS code coverage using [PhantomJS](https://github.com/ariya/phantomjs), [Mocha](https://mochajs.org/) and [Blanket](https://github.com/alex-seville/blanket):
|
133 |
|
134 | - [Configure](https://mochajs.org/#running-mocha-in-the-browser) Mocha for browser
|
135 | - [Mark](https://github.com/deepsweet/poncho#usage) target script(s) with `data-cover` HTML attribute
|
136 | - Run your tests with a command like this:
|
137 |
|
138 | ```sh
|
139 | ./node_modules/.bin/poncho -R lcov test/test.html | ./node_modules/coveralls/bin/coveralls.js
|
140 | ```
|
141 |
|
142 | ### [Lab](https://github.com/hapijs/lab)
|
143 |
|
144 | ```sh
|
145 | lab -r lcov | ./node_modules/.bin/coveralls
|
146 | ```
|
147 |
|
148 | ### [nyc](https://github.com/istanbuljs/nyc)
|
149 |
|
150 | Works with almost any testing framework. Simply execute
|
151 | `npm test` with the `nyc` bin followed by running its reporter:
|
152 |
|
153 | ```shell
|
154 | nyc npm test && nyc report --reporter=text-lcov | coveralls
|
155 | ```
|
156 |
|
157 | ### [TAP](https://github.com/isaacs/node-tap)
|
158 |
|
159 | Simply run your tap tests with the `COVERALLS_REPO_TOKEN` environment
|
160 | variable set and tap will automatically use `nyc` to report
|
161 | coverage to coveralls.
|
162 |
|
163 | ### Command Line Parameters
|
164 |
|
165 | ```shell
|
166 | Usage: coveralls.js [-v] filepath
|
167 | ```
|
168 |
|
169 | #### Optional arguments:
|
170 |
|
171 | - `-v`, `--verbose`
|
172 | - `filepath` - optionally defines the base filepath of your source files.
|
173 |
|
174 | ## Running locally
|
175 |
|
176 | If you're running locally, you must have a `.coveralls.yml` file, as documented in [their documentation](https://docs.coveralls.io/ruby-on-rails#configuration), with your `repo_token` in it; or, you must provide a `COVERALLS_REPO_TOKEN` environment variable on the command-line.
|
177 |
|
178 | 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.
|
179 |
|
180 | ## Contributing
|
181 |
|
182 | 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!).
|
183 |
|
184 | 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.
|
185 |
|
186 |
|
187 | [ci-image]: https://github.com/nickmerwin/node-coveralls/workflows/Tests/badge.svg
|
188 | [ci-url]: https://github.com/nickmerwin/node-coveralls/actions?workflow=Tests
|
189 |
|
190 | [coveralls-image]: https://coveralls.io/repos/nickmerwin/node-coveralls/badge.svg?branch=master&service=github
|
191 | [coveralls-url]: https://coveralls.io/github/nickmerwin/node-coveralls?branch=master
|