Skip to content
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

docs: deprecate benchmark.outputFile option #6591

Merged
merged 2 commits into from
Sep 30, 2024
Merged

docs: deprecate benchmark.outputFile option #6591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7e5d77
docs: deprecate `benchmark.outputFile` option
hi-ogawa Sep 29, 2024
ba6e05c
docs: tweak
hi-ogawa Sep 29, 2024
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
7 changes: 1 addition & 6 deletions docs/config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,12 +305,7 @@ Custom reporter for output. Can contain one or more built-in report names, repor

#### benchmark.outputFile

- **Type:** `string | Record<string, string>`

Write benchmark results to a file when the `--reporter=json` option is also specified.
By providing an object instead of a string you can define individual outputs when using multiple reporters.

To provide object via CLI command, use the following syntax: `--outputFile.json=./path --outputFile.junit=./other-path`.
Deprecated in favor of `benchmark.outputJson`.

#### benchmark.outputJson {#benchmark-outputJson}

Expand Down
3 changes: 1 addition & 2 deletions packages/vitest/src/node/types/benchmark.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ export interface BenchmarkUserOptions {
reporters?: Arrayable<BenchmarkBuiltinReporters | Reporter>

/**
* Write test results to a file when the `--reporter=json` option is also specified.
* Also definable individually per reporter by using an object instead.
* @deprecated Use `benchmark.outputJson` instead
*/
outputFile?:
| string
Expand Down