deno coverage
Command line usage
deno coverage [OPTIONS] [files]...Print coverage reports from coverage profiles.
Collect a coverage profile with deno test:
deno test --coverage=cov_profile
Print a report to stdout:
deno coverage cov_profile
Include urls that start with the file schema and exclude files ending with test.ts and test.js,
for an url to match it must match the include pattern and not match the exclude pattern:
deno coverage --include="^file:" --exclude="test\.(ts|js)" cov_profile
Write a report using the lcov format:
deno coverage --lcov --output=cov.lcov cov_profile/
Generate html reports from lcov:
genhtml -o html_cov cov.lcov
Options Jump to heading
--detailed Jump to heading
Output coverage report in detailed format in the terminal.
--exclude Jump to heading
Exclude source files from the report.
--html Jump to heading
Output coverage report in HTML format in the given directory.
--ignore Jump to heading
Ignore coverage files.
--include Jump to heading
Include source files in the report.
--lcov Jump to heading
Output coverage report in lcov format.
--output Jump to heading
Exports the coverage report in lcov format to the given file.
If no --output arg is specified then the report is written to stdout.
Inclusions and Exclusions Jump to heading
By default coverage includes any of your code that exists on the local file system, and it's imports.
You can customize the inclusions and exclusions by using the --include and
--exclude options.
You can expand the coverage to include files that are not on the local file
system by using the --include option and customizing the regex pattern.
deno coverage --include="^file:|https:"
The default inclusion pattern should be sufficient for most use cases, but you can customize it to be more specific about which files are included in your coverage report.
Files that contain test.js, test.ts, test.jsx, or test.tsx in their name
are excluded by default.
This is equivalent to:
deno coverage --exclude="test\.(js|mjs|ts|jsx|tsx)$"
This default setting prevents your test code from contributing to your coverage report. For a URL to match it must match the include pattern and not match the exclude pattern.
Ignoring Code Jump to heading
Code can be ignored in generated coverage reports by adding coverage ignore comments. Branches and lines in ignored code will be excluded from the report. Ignored branches and lines do not count as covered lines. Instead, ignored lines of code are treated as empty lines.
To ignore an entire file, add a // deno-coverage-ignore-file comment at the
top of the file.
// deno-coverage-ignore-file
// all code in this file is ignored
Ignored files will not appear in the coverage report.
To ignore a single line, add a // deno-coverage-ignore-next comment on the
line above the code you want to ignore.
// deno-coverage-ignore-next
console.log("this line is ignored");
To ignore multiple lines, add a // deno-coverage-ignore-start comment above
the code you want to ignore and a // deno-coverage-ignore-stop comment below.
// deno-coverage-ignore-start
if (condition) {
console.log("both the branch and lines are ignored");
}
// deno-coverage-ignore-stop
All code after a // deno-coverage-ignore-start comment is ignored until a
// deno-coverage-ignore-stop is reached. However, if there are multiple
consecutive start comments, each of these must be terminated by a corresponding
stop comment.
// deno-coverage-ignore-start
if (condition) {
// deno-coverage-ignore-start
console.log("this line is ignored");
// deno-coverage-ignore-stop
console.log("this line is also ignored");
}
// deno-coverage-ignore-stop
console.log("this line is not ignored");
Only white space may precede the coverage directive in a coverage comment. However, any text may trail the directive.
// deno-coverage-ignore-next Trailing text is allowed.
console.log("This line is ignored");
// But leading text isn't. deno-coverage-ignore-next
console.log("This line is not ignored");
Coverage comments must start with //. Comments starting with /* are not
valid coverage comments.
// deno-coverage-ignore-next
console.log("This line is ignored");
/* deno-coverage-ignore-next */
console.log("This line is not ignored");
Output Formats Jump to heading
By default we support Deno's own coverage format - but you can also output coverage reports in the lcov format, or in html.
deno coverage --lcov --output=cov.lcov
This lcov file can be used with other tools that support the lcov format.
deno coverage --html
This will output a coverage report as a html file
Examples Jump to heading
Generate a coverage report from the default coverage profile in your workspace
deno test --coverage
deno coverage
Generate a coverage report from a coverage profile with a custom name
deno test --coverage=custom_profile_name
deno coverage custom_profile_name
Only include coverage that matches a specific pattern - in this case, only include tests from main.ts
deno coverage --include="main.ts"
Export test coverage from the default coverage profile to an lcov file
deno test --coverage
deno coverage --lcov --output=cov.lcov