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.
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' });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 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 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.
Codecov.io support for node.js.
Add the latest version of codecov to your package.json:
npm install codecov --save-dev
or
yarn add codecov --dev
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.
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
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=text-lcov > coverage.lcov
./node_modules/.bin/codecov
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.
--pipe, -l3.7.2
FAQs
Uploading report to Codecov: https://codecov.io
The npm package codecov receives a total of 561,097 weekly downloads. As such, codecov popularity was classified as popular.
We found that codecov demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.