Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codecov/codecov-node
Global coverage report uploader for Codecov in NodeJS
https://github.com/codecov/codecov-node
codecov coverage node
Last synced: 3 months ago
JSON representation
Global coverage report uploader for Codecov in NodeJS
- Host: GitHub
- URL: https://github.com/codecov/codecov-node
- Owner: codecov
- License: mit
- Archived: true
- Created: 2015-10-16T08:27:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T06:01:14.000Z (about 2 years ago)
- Last Synced: 2024-10-15T09:17:08.207Z (3 months ago)
- Topics: codecov, coverage, node
- Language: JavaScript
- Homepage: https://codecov.io
- Size: 1.47 MB
- Stars: 294
- Watchers: 14
- Forks: 114
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-nodejs - codecov - Global coverage report uploader for Codecov in NodeJS.  (Repository / Testing)
- awesome-nodejs - codecov - 一款测试覆盖率检测软件包 (Uncategorized / Uncategorized)
README
🚨🚨 Deprecation Notice 🚨🚨
This uploader is being deprecated by the Codecov team. We recommend migrating to our [new uploader](https://docs.codecov.com/docs/codecov-uploader) as soon as possible to prevent any lapses in coverage. [The new uploader is open source](https://github.com/codecov/uploader), and we highly encourage submitting Issues and Pull Requests.
You can visit our blog post to learn more about our [deprecation plan](https://about.codecov.io/blog/codecov-uploader-deprecation-plan/)
**On February 1, 2022 this uploader will be completely deprecated and will no longer be able to upload coverage to Codecov.**
# Codecov NodeJS Uploader
[](https://codecov.io/github/codecov/codecov-node?branch=master)
[![NPM version][npm-image]][npm-url]
[![Build Status][github-actions-image]][github-actions-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][depstat-image]][depstat-url]
[![Dev Dependency Status][devdepstat-image]][devdepstat-url]
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-node?ref=badge_shield)
[Codecov.io](https://codecov.io/) support for node.js.
## Installation:
Add the latest version of `codecov` to your package.json:
```
npm install codecov --save-dev
```
or
```
yarn add codecov --dev
```
## Usage:
This script ( `bin/codecov` ) detect your CI provider and all coverage reports and uploads them to Codecov.
Once your app is instrumented for coverage, and building, simply call `./node_modules/.bin/codecov`.
This library currently supports the following CI companies: [Travis CI](https://travis-ci.org/), [Travis](https://travis-ci.com/), [Appveyor](https://appveyor.com/), [CircleCI](https://circleci.com/), [Cirrus CI](https://cirrus-ci.org/), [Codeship](https://codeship.io/), [Drone](https://drone.io/), [Jenkins](http://jenkins-ci.org/), [Shippable](https://shippable.com/), [Semaphore](https://semaphoreapp.com/), [Wercker](https://wercker.com/), [Snap CI](https://snap-ci.com/), [Buildkite](https://buildkite.com/), [AWS CodeBuild](https://aws.amazon.com/codebuild/).
#### Upload repo tokens
> Repo tokens are **not** required for public repos tested on Travis-Org, CircleCI or AppVeyor.
Repo tokens are necessary to distinguish your repository from others. You can find your repo token on your repository page at Codecov. Set this unique uuid to `CODECOV_TOKEN` in your environment variables.
```
export CODECOV_TOKEN=":uuid-repo-token"
# or
./node_modules/.bin/codecov --token=:token
# or
./node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/codecov --pipe
```
#### [Istanbul](https://github.com/gotwarlost/istanbul)
**With Mocha:**
```sh
istanbul cover ./node_modules/mocha/bin/_mocha -- -R spec
./node_modules/.bin/codecov
```
**With Jasmine:**
```sh
istanbul cover jasmine-node --captureExceptions spec/
./node_modules/.bin/codecov
```
**With Tape:**
```sh
istanbul cover test.js
./node_modules/.bin/codecov
```
[appveyor-url]: https://ci.appveyor.com/project/eddiemoore/codecov-node-s38o6/branch/master
[github-actions-image]: https://github.com/codecov/codecov-node/workflows/Node%20CI/badge.svg
[github-actions-url]: https://github.com/codecov/codecov-node/actions?query=workflow%3A%22Node+CI%22
[travis-image]: https://travis-ci.org/codecov/codecov-node.svg?branch=master
[travis-url]: https://travis-ci.org/codecov/codecov-node
[npm-url]: https://npmjs.org/package/codecov
[npm-image]: https://img.shields.io/npm/v/codecov.svg
[depstat-url]: https://david-dm.org/codecov/codecov-node
[depstat-image]: https://david-dm.org/codecov/codecov-node/status.svg
[devdepstat-url]: https://david-dm.org/codecov/codecov-node?type=dev
[devdepstat-image]: https://david-dm.org/codecov/codecov-node/dev-status.svg
**With NYC**
```
nyc npm test
nyc report --reporter=lcov
./node_modules/.bin/codecov
```
## Troubleshooting
If you're seeing an **HTTP 400 error when uploading reports to S3**, make sure you've updated to at least version 3.7.0.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-node?ref=badge_large)