| commit | 9a43df0db1e7271140bc24a72400e038492798d4 | [log] [tgz] |
|---|---|---|
| author | Elijah Luckey <luckeyelijah112@gmail.com> | Wed Feb 02 18:24:43 2022 -0500 |
| committer | GitHub <noreply@github.com> | Wed Feb 02 15:24:43 2022 -0800 |
| tree | 3754c6f21535ff49f35c721fdfb1623ce2424c44 | |
| parent | b264f8423ae47d1d5bb2d5426360244eb4b72f4a [diff] |
updates readme documentation (#363)
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.
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 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.
// 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.