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

Jump to bottom

fix(vitest): Define nested CAC options #3983

Closed
wants to merge 14 commits into from
Closed

fix(vitest): Define nested CAC options #3983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1f24433
fix: thresholdAutoUpdate being passed as a string instead of as a boo…
LorenzoBloedow Aug 18, 2023
34db6b9
Improve readability of `thresholdAutoUpdate` code
LorenzoBloedow Aug 21, 2023
bdf1afc
fix the thresholdAutoUpdate problem natively with cac
LorenzoBloedow Aug 21, 2023
aa731cf
Add nested Vitest options to cac
LorenzoBloedow Aug 25, 2023
85f7471
Omit nested help options by default and enable them when using the VE…
LorenzoBloedow Aug 25, 2023
34f9b92
Show nested options on an ad hoc basis by using sub-commands
LorenzoBloedow Aug 28, 2023
bf656d7
Write subcommand without hyphen
LorenzoBloedow Aug 28, 2023
9b1067b
Change --verbose subcommand to --expand-help
LorenzoBloedow Dec 19, 2023
31e302c
Fix wrong 'api' CLI option
LorenzoBloedow Jan 13, 2024
330445e
Create tests for --help and --expand-help options
LorenzoBloedow Jan 13, 2024
c6ce321
Fix wrong CAC argument type for CLI option
LorenzoBloedow Jan 13, 2024
b9c7514
Add nested options to the docs
LorenzoBloedow Jan 13, 2024
43b7768
Fix wrong coverage options
LorenzoBloedow Jan 14, 2024
3c5acff
chore: fix issues
sheremet-va Feb 6, 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
51 changes: 46 additions & 5 deletions docs/guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ Run only [benchmark](https://vitest.dev/guide/features.html#benchmarking-experim
| `--dir <path>`| Base directory to scan for the test files |
| `--ui` | Enable UI |
| `--open` | Open the UI automatically if enabled (default: `true`) |
| `--api [api]` | Serve API, available options: `--api.port <port>`, `--api.host [host]` and `--api.strictPort` |
| `--api [port], --api.port [port]` | Specify server port. Note if the port is already being used, Vite will automatically try the next available port |
| `--api.host [host]` | Specify which IP addresses the server should listen on. Set this to 0.0.0.0 or true to listen on all addresses, including LAN and public addresses |
| `--api.strictPort` | Set to true to exit if port is already in use, instead of automatically trying the next available port |
| `--pool <pool>` | Specify pool, if not running in the browser (default: `threads`) |
| `--poolOptions <options>` | Specify pool options |
| `--poolOptions.threads.isolate` | Isolate tests in threads pool (default: `true`) |
Expand All @@ -78,23 +80,58 @@ Run only [benchmark](https://vitest.dev/guide/features.html#benchmarking-experim
| `--minWorkers <workers>` | Minimum number of workers to run tests in |
| `--silent` | Silent console output from tests |
| `--reporter <name>` | Select reporter: `default`, `verbose`, `dot`, `junit`, `json`, or a path to a custom reporter |
| `--outputFile <filename/-s>` | Write test results to a file when the `--reporter=json` or `--reporter=junit` option is also specified <br /> Via [cac's dot notation] you can specify individual outputs for multiple reporters |
| `--outputFile <filename/-s>` | Write test results to a file when the `--reporter=json` or `--reporter=junit` option is also specified <br /> Via [cac's dot notation](https://github.com/cacjs/cac#dot-nested-options) you can specify individual outputs for multiple reporters |
| `--coverage` | Enable coverage report |
| `--coverage.all` | Whether to include all files, including the untested ones into report (default: `true`) |
| `--coverage.provider` | Select the tool for coverage collection, available values are: "v8", "istanbul" and "custom" |
| `--coverage.enabled` | Enables coverage collection. Can be overridden using the --coverage CLI option. This option is not available for custom providers (default: false) |
| `--coverage.include` | Files included in coverage as glob patterns. May be specified more than once when using multiple patterns. This option is not available for custom providers (default: **) |
| `--coverage.extension` | Extension to be included in coverage. May be specified more than once when using multiple extensions. This option is not available for custom providers (default: `[".js", ".cjs", ".mjs", ".ts", ".mts", ".cts", ".tsx", ".jsx", ".vue", ".svelte"]`) |
| `--coverage.exclude` | Files to be excluded in coverage. May be specified more than once when using multiple extensions. This option is not available for custom providers (default: Visit https://vitest.dev/config/#coverage-exclude)
| `--coverage.clean` | Clean coverage results before running tests. This option is not available for custom providers (default: true) |
| `coverage.cleanOnRerun` | Clean coverage report on watch rerun. This option is not available for custom providers (default: true) |
| `coverage.reportsDirectory` | Directory to write coverage report to. This option is not available for custom providers (default: ./coverage) |
| `--coverage.reporter` | Coverage reporters to use. Visit [https://vitest.dev/config/#coverage-reporter](https://vitest.dev/config/#coverage-reporter) for more information. This option is not available for custom providers (default: `["text", "html", "clover", "json"]`) |
| `--coverage.reportOnFailure` | Generate coverage report even when tests fail. This option is not available for custom providers (default: `false`) |
| `--coverage.allowExternal` | Collect coverage of files outside the project root. This option is not available for custom providers (default: `false`) |
| `--coverage.skipFull` | Do not show files with 100% statement, branch, and function coverage. This option is not available for custom providers (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. This option is not available for custom providers (default: `false`) |
| `--coverage.thresholds.autoUpdate` | Update threshold values: "lines", "functions", "branches" and "statements" to configuration file when current coverage is above the configured thresholds. This option is not available for custom providers (default: `false`) |
| `--coverage.thresholds.lines` | Threshold for lines. Visit [https://github.com/istanbuljs/nyc#coverage-thresholds](https://github.com/istanbuljs/nyc#coverage-thresholds) for more information. This option is not available for custom providers |
| `--coverage.thresholds.functions` | Threshold for functions. Visit [https://github.com/istanbuljs/nyc#coverage-thresholds](https://github.com/istanbuljs/nyc#coverage-thresholds) for more information. This option is not available for custom providers |
| `--coverage.thresholds.branches` | Threshold for branches. Visit [https://github.com/istanbuljs/nyc#coverage-thresholds](https://github.com/istanbuljs/nyc#coverage-thresholds) for more information. This option is not available for custom providers |
| `--coverage.thresholds.statements` | Threshold for statements. Visit [https://github.com/istanbuljs/nyc#coverage-thresholds](https://github.com/istanbuljs/nyc#coverage-thresholds) for more information. This option is not available for custom providers |
| `--coverage.thresholds.100` | Shortcut to set all coverage thresholds to 100. This option is only available for the v8 provider (default: `false`) |
| `--coverage.ignoreClassMethods` | Array of class method names to ignore for coverage. Visit [https://github.com/istanbuljs/nyc#ignoring-methods](https://github.com/istanbuljs/nyc#ignoring-methods) for more information. This option is only available for the istanbul providers (default: `[]`) |
| `--coverage.watermarks` | Watermarks for statements, lines, branches and functions. Visit [https://github.com/istanbuljs/nyc#high-and-low-watermarks](https://github.com/istanbuljs/nyc#high-and-low-watermarks) for more information. This option is not available for custom providers (default: Visit [https://vitest.dev/config/#coverage-watermarks](https://vitest.dev/config/#coverage-watermarks)) |
| `--coverage.customProviderModule` | Specifies the module name or path for the custom coverage provider module. Visit [https://vitest.dev/guide/coverage.html#custom-coverage-provider](https://vitest.dev/guide/coverage.html#custom-coverage-provider) for more information. This option is only available for custom providers |
| `--run` | Do not watch |
| `--isolate` | Run every test file in isolation. To disable isolation, use --no-isolate (default: `true`) |
| `--mode <name>` | Override Vite mode (default: `test`) |
| `--workspace <path>` | Path to a workspace configuration file |
| `--globals` | Inject APIs globally |
| `--dom` | Mock browser API with happy-dom |
| `--browser [options]` | Run tests in [the browser](/guide/browser) (default: `false`) |
| `--browser.enabled` | Run all tests inside a browser by default. Can be overriden with the poolMatchGlobs configuration file option (default: false) |
| `--browser.name <name>` | Run all tests in a specific browser. Some browsers are only available for specific providers (see --browser.provider). Visit https://vitest.dev/config/#browser-name for more information |
| `--browser.headless` | Run the browser in headless mode (i.e. without opening the GUI (Graphical User Interface)). If you are running Vitest in CI, it will be enabled by default (default: process.env.CI) |
| `--browser.api [port]` | Specify server port. Note if the port is already being used, Vite will automatically try the next available port so this may not be the actual port the server ends up listening on. Does not affect the --api option. If true will be set to ${defaultBrowserPort} (default: ${defaultBrowserPort}) |
| `--browser.api.port <port>` | Specify server port. Note if the port is already being used, Vite will automatically try the next available port so this may not be the actual port the server ends up listening on. Does not affect the --api.port option |
| `--browser.api.host [host]` | Specify which IP addresses the server should listen on. Set this to 0.0.0.0 or true to listen on all addresses, including LAN and public addresses. Does not affect the --api.host option |
| `--browser.provider` | Provider used to run browser tests. Some browsers are only available for specific providers. Can be "webdriverio", "playwright", or the path to a custom provider. Visit https://vitest.dev/config/#browser-provider for more information (default: "webdriverio") |
| `--browser.slowHijackESM` | Let Vitest use its own module resolution on the browser to enable APIs such as vi.mock and vi.spyOn. Visit https://vitest.dev/config/#browser-slowhijackesm for more information (default: true) |
| `--environment <env>` | Runner environment (default: `node`) |
| `--passWithNoTests` | Pass when no tests found |
| `--logHeapUsage` | Show the size of heap for each test |
| `--allowOnly` | Allow tests and suites that are marked as `only` (default: false in CI, true otherwise) |
| `--dangerouslyIgnoreUnhandledErrors` | Ignore any unhandled errors that occur |
| `--changed [since]` | Run tests that are affected by the changed files (default: false). See [docs](#changed) |
| `--shard <shard>` | Execute tests in a specified shard |
| `--sequence` | Define in what order to run tests. Use [cac's dot notation] to specify options (for example, use `--sequence.shuffle` to run tests in random order or `--sequence.shuffle --sequence.seed SEED_ID` to run a specific order) |
| `--sequence` | Define in what order to run tests. Use [cac's dot notation](https://github.com/cacjs/cac#dot-nested-options) to specify options (for example, use `--sequence.shuffle` to run tests in random order or `--sequence.shuffle --sequence.seed SEED_ID` to run a specific order) |
| `--sequence.concurrent [concurrent]` | Make tests run in parallel (default: false) |
| `--sequence.seed <seed>` | Set the randomization seed. This option will have no effect if --sequence.shuffle is falsy. Visit https://en.wikipedia.org/wiki/Random_seed for more information |
| `--sequence.hooks <order>` | Changes the order in which hooks are executed. Accepted values are: "stack", "list" and "parallel". Visit https://vitest.dev/config/#sequence-hooks for more information (default: "parallel") |
| `--sequence.setupFiles <order>` | Changes the order in which setup files are executed. Accepted values are: "list" and "parallel". If set to "list", will run setup files in the order they are defined. If set to "parallel", will run setup files in parallel (default: "parallel") |
| `--no-color` | Removes colors from the console output |
| `--inspect` | Enables Node.js inspector |
| `--inspect-brk` | Enables Node.js inspector with break |
Expand Down Expand Up @@ -126,6 +163,12 @@ Boolean options can be negated with `no-` prefix. Specifying the value as `false
vitest --no-api
vitest --api=false
```

By default, Vitest only prints non-nested commands. To see all possible options, use `--expand-help` when calling `--help`:

```
vitest --help --expand-help
```
:::

### changed
Expand Down Expand Up @@ -160,5 +203,3 @@ vitest --api=false
:::warning
You cannot use this option with `--watch` enabled (enabled in dev by default).
:::

[cac's dot notation]: https://github.com/cacjs/cac#dot-nested-options
Loading
Loading