docs: deprecate benchmark.outputFile option (#6591)

vitest-dev · Sep 30, 2024 · 891d6fe · 891d6fe
1 parent 4ce99b3
commit 891d6fe
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 8 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -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}
 

diff --git a/packages/vitest/src/node/types/benchmark.ts b/packages/vitest/src/node/types/benchmark.ts
@@ -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