docs: update doc on option.outputFile (#999)

vitest-dev · Mar 22, 2022 · c9b49b7 · c9b49b7
1 parent 00a1763
commit c9b49b7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -107,8 +107,8 @@ You can specify additional CLI options like `--port` or `--https`. For a full li
 | `--threads` | Enable Threads (default: `true`) |
 | `--silent` | Silent console output from tests |
 | `--isolate` | Isolate environment for each test file (default: `true`) |
-| `--reporter <name>` | Select reporter: `default`, `verbose`, `dot` or `json` |
-| `--outputFile <filename>` | Write test results to a file when the `--reporter=json` option is also specified |
+| `--reporter <name>` | Select reporter: `default`, `verbose`, `dot`, `junit` or `json` |
+| `--outputFile <filename>` | Write test results to a file when the `--reporter=json` or `--reporter=junit` option is also specified |
 | `--coverage` | Use c8 for coverage |
 | `--run` | Do not watch |
 | `--mode <name>` | Override Vite mode (default: `test`) |

diff --git a/packages/vitest/src/node/cli.ts b/packages/vitest/src/node/cli.ts
@@ -23,7 +23,7 @@ cli
  .option('--isolate', 'isolate environment for each test file (default: true)')
  .option('--reporter <name>', 'reporter')
  .option('--outputTruncateLength <length>', 'diff output length')
- .option('--outputFile <filename>', 'write test results to a file when the --reporter=json option is also specified')
+ .option('--outputFile <filename>', 'write test results to a file when the --reporter=json or --reporter=junit option is also specified')
  .option('--coverage', 'use c8 for coverage')
  .option('--run', 'do not watch')
  .option('--mode <name>', 'override Vite mode (default: test)')

diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -143,7 +143,7 @@ export interface InlineConfig {
  outputTruncateLength?: number
 
  /**
- * Write test results to a file when the --reporter=json option is also specified
+ * Write test results to a file when the --reporter=json` or `--reporter=junit` option is also specified.
  */
  outputFile?: string