codecov

What is codecov?

The codecov npm package is a tool for uploading code coverage reports to Codecov, a service that provides hosted coverage reports with detailed insights and visualizations. It integrates with various CI/CD pipelines to automate the process of collecting and uploading coverage data.

What are codecov's main functionalities?

Upload Coverage Reports

This feature allows you to upload your code coverage reports to Codecov. You need to provide your Codecov token and the path to the coverage report file.

const codecov = require('codecov');
codecov.upload({ token: 'your-codecov-token', file: 'path/to/coverage.xml' });

CI/CD Integration

This feature demonstrates how to integrate Codecov with your CI/CD pipeline. It uses environment variables to dynamically set the token, branch, and commit information.

const codecov = require('codecov');
codecov.upload({ token: process.env.CODECOV_TOKEN, file: 'coverage.xml', branch: process.env.CI_BRANCH, commit: process.env.CI_COMMIT });

Custom Flags

This feature allows you to add custom flags to your coverage reports. Flags can be used to differentiate between different types of tests or coverage reports.

const codecov = require('codecov');
codecov.upload({ token: 'your-codecov-token', file: 'coverage.xml', flags: 'unittests' });

Other packages similar to codecov

coveralls

Coveralls is another popular service for code coverage reporting. It provides similar functionalities to Codecov, such as uploading coverage reports and integrating with CI/CD pipelines. However, Coveralls has a different user interface and may offer different integrations and features.

nyc

NYC is a code coverage tool built on top of Istanbul. While it primarily focuses on generating coverage reports locally, it can be used in conjunction with services like Codecov or Coveralls to upload reports. NYC provides detailed coverage information and supports various reporting formats.

jest

Jest is a JavaScript testing framework that includes built-in code coverage reporting. While Jest itself does not upload coverage reports to external services, it can generate coverage data that can be uploaded to Codecov or Coveralls using additional tools or scripts.

README

Codecov NodeJS Uploader

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, Travis, Appveyor, CircleCI, Cirrus CI, Codeship, Drone, Jenkins, Shippable, Semaphore, Wercker, Snap CI, Buildkite, AWS 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

With Mocha:

istanbul cover ./node_modules/mocha/bin/_mocha -- -R spec
./node_modules/.bin/codecov

With Jasmine:

istanbul cover jasmine-node --captureExceptions spec/
./node_modules/.bin/codecov

With Tape:

istanbul cover test.js
./node_modules/.bin/codecov

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

Changelog

3.8.3

Fixes

• #329 fix: Test if response has two lines

Dependencies

• #306 Bump eslint-config-prettier from 7.2.0 to 8.3.0
• #305 Bump eslint from 7.21.0 to 7.25.0
• #302 Bump mock-fs from 4.13.0 to 4.14.0
• #308 Bump lodash from 4.17.19 to 4.17.21
• #309 Bump ignore-walk from 3.0.3 to 3.0.4
• #310 Bump hosted-git-info from 2.8.8 to 2.8.9
• #325 Bump prettier from 2.2.1 to 2.3.2
• #326 Bump actions/setup-node from 2.1.5 to 2.2.0
• #328 Bump lint-staged from 10.5.4 to 11.0.1
• #330 Bump eslint from 7.25.0 to 7.31.0
• #331 Bump ws from 7.3.1 to 7.5.3
• #332 Bump urlgrey from 0.4.4 to 1.0.0
• #334 Bump husky from 6.0.0 to 7.0.1
• #333 Bump teeny-request from 7.0.1 to 7.1.1