commit | 0790b229c3f59c1b5db762a505bc06a0484733a8 | [log] [tgz] |
---|---|---|
author | Liam Appelbe <liama@google.com> | Thu Mar 24 14:54:00 2022 -0700 |
committer | GitHub <noreply@github.com> | Thu Mar 24 14:54:00 2022 -0700 |
tree | 53893e21ffa896d35b8ecc0afa053a9bd47a7f25 | |
parent | aab92ee30434f131719aae0314cf5413b4997f2d [diff] |
Prepare for 1.2.0 release (#373)
Coverage provides coverage data collection, manipulation, and formatting for Dart.
collect_coverage
collects coverage JSON from the Dart VM Service. format_coverage
formats JSON coverage data into either LCOV or pretty-printed format.
dart pub global activate coverage
Consider adding the pub global run
executables directory to your path. See Running a script from your PATH for more details.
dart --pause-isolates-on-exit --disable-service-auth-codes --enable-vm-service=NNNN script.dart pub global run coverage:collect_coverage --uri=http://... -o coverage.json --resume-isolates
or if the pub global run
executables are on your PATH,
collect_coverage --uri=http://... -o coverage.json --resume-isolates
where --uri
specifies the Dart VM Service URI emitted by the VM.
If collect_coverage
is invoked before the script from which coverage is to be collected, it will wait until it detects a VM observatory to which it can connect. An optional --connect-timeout
may be specified (in seconds). The --wait-paused
flag may be enabled, causing collect_coverage
to wait until all isolates are paused before collecting coverage.
pub global run coverage:format_coverage --packages=app_package/.packages -i coverage.json
or if the pub global run
exectuables are on your PATH,
format_coverage --packages=app_package/.packages -i coverage.json
where app_package
is the path to the package whose coverage is being collected. If --sdk-root
is set, Dart SDK coverage will also be output.
// coverage:ignore-line
to ignore one line.// coverage:ignore-start
and // coverage:ignore-end
to ignore range of lines inclusive.// coverage:ignore-file
to ignore the whole file.To gather function level coverage information, pass --function-coverage
to collect_coverage:
dart --pause-isolates-on-exit --disable-service-auth-codes --enable-vm-service=NNNN script.dart pub global run coverage:collect_coverage --uri=http://... -o coverage.json --resume-isolates --function-coverage
To gather branch level coverage information, pass --branch-coverage
to both collect_coverage and the Dart command you're gathering coverage from:
dart --pause-isolates-on-exit --disable-service-auth-codes --enable-vm-service=NNNN --branch-coverage script.dart pub global run coverage:collect_coverage --uri=http://... -o coverage.json --resume-isolates --branch-coverage
Branch coverage requires Dart VM 2.17.0, with service API v3.56. Function, branch, and line coverage can all be gathered at the same time, by combining those flags:
dart --pause-isolates-on-exit --disable-service-auth-codes --enable-vm-service=NNNN --branch-coverage script.dart pub global run coverage:collect_coverage --uri=http://... -o coverage.json --resume-isolates --function-coverage --branch-coverage