Skip to content

Commit

Permalink
chore: update cli table
Browse files Browse the repository at this point in the history
  • Loading branch information
sheremet-va committed Apr 23, 2024
1 parent ac7a882 commit bd22220
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
7 changes: 4 additions & 3 deletions docs/guide/cli-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
| `--coverage.cleanOnRerun` | Clean coverage report on watch rerun (default: true) |
| `--coverage.reportsDirectory <path>` | Directory to write coverage report to (default: ./coverage) |
| `--coverage.reporter <name>` | Coverage reporters to use. Visit [`coverage.reporter`](https://vitest.dev/config/#coverage-reporter) for more information (default: `["text", "html", "clover", "json"]`) |
| `--coverage.reportOnFailure` | Generate coverage report even when tests fail (default: false) |
| `--coverage.allowExternal` | Collect coverage of files outside the project root (default: false) |
| `--coverage.skipFull` | Do not show files with 100% statement, branch, and function coverage (default: false) |
| `--coverage.reportOnFailure` | Generate coverage report even when tests fail (default: `false`) |
| `--coverage.allowExternal` | Collect coverage of files outside the project root (default: `false`) |
| `--coverage.skipFull` | Do not show files with 100% statement, branch, and function coverage (default: `false`) |
| `--coverage.thresholds.100` | Shortcut to set all coverage thresholds to 100 (default: `false`) |
| `--coverage.thresholds.perFile` | Check thresholds per file. See `--coverage.thresholds.lines`, `--coverage.thresholds.functions`, `--coverage.thresholds.branches` and `--coverage.thresholds.statements` for the actual thresholds (default: `false`) |
| `--coverage.thresholds.autoUpdate` | Update threshold values: "lines", "functions", "branches" and "statements" to configuration file when current coverage is above the configured thresholds (default: `false`) |
Expand Down Expand Up @@ -119,3 +119,4 @@
| `--segfaultRetry <times>` | Retry the test suite if it crashes due to a segfault (default: `true`) |
| `--no-color` | Removes colors from the console output |
| `--clearScreen` | Clear terminal screen when re-running tests during watch mode (default: `true`) |
| `--standalone` | Start Vitest without running tests. File filters will be ignored, tests will be running only on change (default: `false`) |
8 changes: 4 additions & 4 deletions packages/vitest/src/node/cli/cli-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,13 @@ export const cliOptionsConfig: VitestCLIOptions = {
array: true,
},
reportOnFailure: {
description: 'Generate coverage report even when tests fail (default: false)',
description: 'Generate coverage report even when tests fail (default: `false`)',
},
allowExternal: {
description: 'Collect coverage of files outside the project root (default: false)',
description: 'Collect coverage of files outside the project root (default: `false`)',
},
skipFull: {
description: 'Do not show files with 100% statement, branch, and function coverage (default: false)',
description: 'Do not show files with 100% statement, branch, and function coverage (default: `false`)',
},
thresholds: {
description: null,
Expand Down Expand Up @@ -602,7 +602,7 @@ export const cliOptionsConfig: VitestCLIOptions = {
description: 'Clear terminal screen when re-running tests during watch mode (default: `true`)',
},
standalone: {
description: 'Start Vitest without running tests. File filters will be ignored, tests will be running only on change (default: false)',
description: 'Start Vitest without running tests. File filters will be ignored, tests will be running only on change (default: `false`)',
},

// disable CLI options
Expand Down

0 comments on commit bd22220

Please sign in to comment.