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.

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: update doc on option.outputFile #999

Merged
merged 3 commits into from
Mar 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`) |
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/node/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)')
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/types/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down