Codecov NodeJS / Javascript Example
You can install Codecov by adding
npm install -g codecovAdd the following to your .travis.yml:
language:
node_js
before_install:
- npm install -g codecov
script:
- istanbul cover ./node_modules/mocha/bin/_mocha --reporter lcovonly -- -R spec
- codecov
The first script line will change depending on your coverage collecting tool, see below.
- Install blanket.js
- Configure blanket according to docs.
- Run your tests with a command like this:
NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
--require blanket \
--reporter mocha-lcov-reporter
codecovInstrumenting 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 build would look something like this:
YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha test -R mocha-lcov-reporterWith Mocha:
nyc --reporter=lcov mocha && codecovWith Jasmine:
istanbul cover ./node_modules/jasmine/bin/jasmine.jsWith Karma:
The lcov.info can be used as in other configurations. Some projects experienced better results using json output but it is no longer enabled by default. In karma.config.js both can be enabled:
module.exports = function karmaConfig (config) {
config.set({
...
reporters: [
...
// Reference: https://github.com/karma-runner/karma-coverage
// Output code coverage files
'coverage'
],
// Configure code coverage reporter
coverageReporter: {
reporters: [
// generates ./coverage/lcov.info
{type:'lcovonly', subdir: '.'},
// generates ./coverage/coverage-final.json
{type:'json', subdir: '.'},
]
},
...
});
};In package.json supply either lcov.info or coverage-final.json to codecov:
{
"scripts": {
"report-coverage": "codecov",
...
}
...
}Depend on nodeunit and jscoverage:
npm install nodeunit jscoverage codecov --save-devAdd a codecov script to "scripts" in your package.json:
"scripts": {
"test": "nodeunit test",
"codecov": "jscoverage lib && YOURPACKAGE_COVERAGE=1 nodeunit --reporter=lcov test && codecov"
}Ensure your app requires instrumented code when process.env.YOURPACKAGE_COVERAGE variable is defined.
Run your tests with a command like this:
npm run codecov- name: Codecov
uses: codecov/codecov-action@v2
with:
token: ${{ secrets.CODECOV_TOKEN }}
flags: unittestsClient-side JS code coverage using PhantomJS, Mocha and Blanket:
- Configure Mocha for browser
- Mark target script(s) with
data-coverhtml-attribute - Run your tests with a command like this:
./node_modules/.bin/poncho -R lcov test/test.html && codecovistanbul cover ./node_modules/lab/bin/lab --report lcovonly -- -l && codecov{
"scripts": {
"report-coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
...
}
...
}Run
jest --ci --coverage && codecovor you can add it in your package.json:
"jest": {
"coverageDirectory": "./coverage/",
"collectCoverage": true
}Jest will now generate coverage files into coverage/ and you can run your tests with a command like this:
jest && codecovThere have been reports of gotwarlost/istanbul not working properly with JSX files, which provide inaccurate coverage results. Please try using ambitioninc/babel-istanbul.
istanbul cover node_modules/.bin/tape ./test/*.js
Or simply run:
istanbul cover ./test/*.js
Or add in package.json:
"test": "istanbul cover test/*.js",
After test:
codecov --token=:token
Repository tokens are required for (a) all private repos, (b) public repos not using Travis-CI, CircleCI or AppVeyor. Find your repository token at Codecov and provide via codecov --token=:token or export CODECOV_TOKEN=":token"
When using mock-fs make sure to run mock.restore() when your tests are done running, or else the reports wont get generated on the CI.
- Q: Is there a TypeScript example?
A: Yes codecov/example-typescript.
- More documentation at https://docs.codecov.io
- Configure codecov through the
codecov.ymlhttps://docs.codecov.io/docs/codecov-yaml
We are happy to help if you have any questions. Please contact email our Support at support@codecov.io