🚨🚨 Deprecation Notice 🚨🚨

This uploader is being deprecated by the Codecov team. We recommend migrating to our new uploader as soon as possible to prevent any lapses in coverage. The new uploader is open source, and we highly encourage submitting Issues and Pull Requests.

You can visit our blog post to learn more about our deprecation plan

On February 1, 2022 this uploader will be completely deprecated and will no longer be able to upload coverage to Codecov.

Dart Code Coverage Generator

Generate code coverage for Dart projects. Output can be lcov format or an HTML report.

This project includes a codecov executable that runs one or many test files and uses the coverage package to collect coverage for each file and format the coverage into the desired output format.

Prerequisites

Depends on the following utilities:

genhtml (brew install lcov on a mac)
lsof (standard unix utility)

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  coverage: "^0.7.0"
  codecov: "^0.4.0"

Install:

pub get --packages-dir

Usage

pub run codecov

Configuration

By default, this tool runs every test file in the test/ directory. You can explicitly specify the directories or files like so:

pub run codecov test/my_test.dart

Options

--report-on: Which directories or files to report coverage on. For example, --report-on=lib/.

Flags

--html: Whether or not to generate the HTML report. Defaults to true.
--lcov: Whether or not to generate the .lcov file. Defaults to true.
--verbose: Toggle verbose output to stdout.

Notice

The tooling currently relies on the deprecated packages directories generated by pub. If the .packages file should be used instead, modify the call to pub run coverage:format_coverage in bin/src/coverage.dart, replacing --package-root=packages with --packages=.packages.

codecov / dart