Skip to content

Document V8 coverage in Vitest integration #33387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dario-piotrowicz wants to merge 1 commit into
base: production
Choose a base branch
from
+15 −5
Draft

Document V8 coverage in Vitest integration #33387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/content/docs/workers/testing/vitest-integration/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ products:
- workers
---

import { Details } from "~/components";
import { Details, PackageManagers } from "~/components";

The Workers Vitest integration provides additional configuration on top of Vitest's usual options using the `cloudflareTest()` Vite plugin.

Expand All @@ -36,6 +36,20 @@ Custom Vitest `environment`s or `runner`s are not supported when using the Worke

:::

## Code coverage

The Workers Vitest integration supports Vitest's V8 and Istanbul coverage providers for tests that run locally. Vitest uses V8 by default.

To collect V8 coverage, install the provider that matches your Vitest version:

<PackageManagers pkg="@vitest/coverage-v8@^4.1.0" dev />

Then, run Vitest with coverage enabled:

<PackageManagers type="exec" pkg="vitest" args="run --coverage" />

The Workers Vitest integration automatically applies the compatibility settings required for local V8 coverage. For coverage options, refer to the [Vitest coverage documentation](https://v4.vitest.dev/guide/coverage).

## APIs

The following APIs are exported from the `@cloudflare/vitest-plugin` package.
Expand Down
4 changes: 0 additions & 4 deletions src/content/docs/workers/testing/vitest-integration/known-issues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ products:

The Workers Vitest plugin has the following known issues:

### Coverage

Native code coverage via [V8](https://v8.dev/blog/javascript-code-coverage) is not supported. You must use instrumented code coverage via [Istanbul](https://istanbul.js.org/) instead. Refer to the [Vitest Coverage documentation](https://vitest.dev/guide/coverage) for setup instructions.

### Fake timers

Vitest's [fake timers](https://vitest.dev/guide/mocking.html#timers) do not apply to KV, R2 and cache simulators. For example, you cannot expire a KV key by advancing fake time.
Expand Down