| commit | 8213b2bd7ee2d7650777641405584b3fb40cfe94 | [log] [tgz] |
|---|---|---|
| author | Chris Bracken <chris@bracken.jp> | Fri Aug 09 13:10:05 2019 -0700 |
| committer | GitHub <noreply@github.com> | Fri Aug 09 13:10:05 2019 -0700 |
| tree | c70885e2b736805551a2a01b1755d4ca106cb288 | |
| parent | f55a498ab3f33361a6dbca8d7c570fd80a936a6d [diff] |
Document includeDart parameter on collect() (#266) includeDart was added in 67b8249 (#257) as a means of controlling whether coverage is collected for `dart:` libraries and should generally be defaulted to false. This adds documentation for the parameter.
Coverage provides coverage data collection, manipulation, and formatting for Dart.
collect_coverage collects coverage JSON from the Dart VM Observatory. format_coverage formats JSON coverage data into either LCOV or pretty-printed format.
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 --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 Observatory 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.