summaryrefslogtreecommitdiff
path: root/docs/testing/coverage.md
diff options
context:
space:
mode:
authorCasper Beyer <caspervonb@pm.me>2021-07-10 06:52:31 +0800
committerGitHub <noreply@github.com>2021-07-10 00:52:31 +0200
commit6aad9749d2b5203faf164cc33328174047c287e8 (patch)
treefeed74daa3b58a383e9caacab4e1ba7c3bc34111 /docs/testing/coverage.md
parentab079a8d63e9a32d2ddae1071797f57823357967 (diff)
docs(manual): split testing into multiple chapters (#11067)
Co-authored-by: Bartek IwaƄczuk <biwanczuk@gmail.com>
Diffstat (limited to 'docs/testing/coverage.md')
-rw-r--r--docs/testing/coverage.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/testing/coverage.md b/docs/testing/coverage.md
new file mode 100644
index 000000000..0899c7cbd
--- /dev/null
+++ b/docs/testing/coverage.md
@@ -0,0 +1,36 @@
+# Test coverage
+
+Deno will collect test coverage into a directory for your code if you specify
+the `--coverage` flag when starting `deno test`.
+
+This coverage information is acquired directly from the JavaScript engine (V8)
+which is very accurate.
+
+This can then be further processed from the internal format into well known
+formats by the `deno coverage` tool.
+
+```bash
+# Go into your project's working directory
+git clone https://github.com/oakserver/oak && cd oak
+
+# Collect your coverage profile with deno test --coverage=<output_directory>
+deno test --coverage=cov_profile
+
+# From this you can get a pretty printed diff of uncovered lines
+deno coverage cov_profile
+
+# Or generate an lcov report
+deno coverage cov_profile --lcov > cov_profile.lcov
+
+# Which can then be further processed by tools like genhtml
+genhtml -o cov_profile/html cov_profile.lcov
+```
+
+By default, `deno coverage` will exclude any files matching the regular
+expression `test\.(js|mjs|ts|jsx|tsx)` and only consider including specifiers
+matching the regular expression `^file:` - ie. remote files will be excluded
+from coverage report.
+
+These filters can be overridden using the `--exclude` and `--include` flags. A
+module specifier must _match_ the include_regular expression and _not match_ the
+exclude_ expression for it to be a part of the report.