Skip to content

Commit fd33850

Browse files
committed
docs(vitest): coverage
1 parent f60e0df commit fd33850

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docusaurus/docs/vitest/cookbook.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,14 @@ To run a subset of your test suite you can use the `KNAPSACK_PRO_TEST_FILE_*` en
1212
- [`KNAPSACK_PRO_TEST_FILE_PATTERN`](reference.md#knapsack_pro_test_file_pattern)
1313
- [`KNAPSACK_PRO_TEST_FILE_EXCLUDE_PATTERN`](reference.md#knapsack_pro_test_file_exclude_pattern)
1414
- [`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE`](reference.md#knapsack_pro_test_file_list_source_file)
15+
16+
## Test coverage
17+
18+
Use the [blob reporter](https://vitest.dev/guide/reporters.html#blob-reporter) without specifying an `outputFile`. Later, execute `vitest --merge-reports` to output coverage or any aggregated reports you need (e.g., `json`):
19+
20+
```bash
21+
npx @knapsack-pro/vitest --reporter=blob
22+
npx vitest --merge-reports --coverage
23+
```
24+
25+
Knapsack Pro generates one blob file per batch of tests executed named as follows: `.vitest-reports/blob-[NODE_INDEX]-[NODE_TOTAL]-[UUID].json` (e.g., `.vitest-reports/blob-0-1-UUID.json`).

docusaurus/docs/vitest/reference.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,6 @@ You don't need to set it if either:
8585
- Your CI is one of the [supported CIs](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core/src/ci-providers)
8686
- Your CI has git installed so that Knapsack Pro can retrieve it
8787

88-
## `KNAPSACK_PRO_COVERAGE_DIRECTORY`
89-
90-
The directory where Vitest writes coverage reports.
91-
92-
Default: if not specified, it falls back to [Vitest `coverage.reportsDirectory`](https://vitest.dev/config/#coverage-reportsdirectory)
93-
9488
## `KNAPSACK_PRO_ENDPOINT` (Internal)
9589

9690
Default: `https://api.knapsackpro.com`

0 commit comments

Comments
 (0)