Skip to content

Commit d4a55de

Browse files
committed
docs: fix generator
1 parent 7dde3b8 commit d4a55de

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

docs/.vitepress/scripts/cli-generator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const skipConfig = new Set([
4242
'browser.name',
4343
'browser.fileParallelism',
4444
'clearCache',
45-
'tag',
45+
'tagsFilter',
4646
])
4747

4848
function resolveOptions(options: CLIOptions<any>, parentName?: string) {

docs/guide/cli-generated.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -518,12 +518,26 @@ Default hook timeout in milliseconds (default: `10000`). Use `0` to disable time
518518

519519
Stop test execution when given number of tests have failed (default: `0`)
520520

521-
### retry
521+
### retry.count
522522

523-
- **CLI:** `--retry <times>`
524-
- **Config:** [retry](/config/retry)
523+
- **CLI:** `--retry.count <times>`
524+
- **Config:** [retry.count](/config/retry#retry-count)
525525

526-
Retry the test specific number of times if it fails (default: `0`)
526+
Number of times to retry a test if it fails (default: `0`)
527+
528+
### retry.delay
529+
530+
- **CLI:** `--retry.delay <ms>`
531+
- **Config:** [retry.delay](/config/retry#retry-delay)
532+
533+
Delay in milliseconds between retry attempts (default: `0`)
534+
535+
### retry.condition
536+
537+
- **CLI:** `--retry.condition <pattern>`
538+
- **Config:** [retry.condition](/config/retry#retry-condition)
539+
540+
Regex pattern to match error messages that should trigger a retry. Only errors matching this pattern will cause a retry (default: retry on all errors)
527541

528542
### diff.aAnnotation
529543

@@ -798,6 +812,19 @@ Start Vitest without running tests. Tests will be running only on change. This o
798812

799813
Delete all Vitest caches, including `experimental.fsModuleCache`, without running any tests. This will reduce the performance in the subsequent test run.
800814

815+
### tagsFilter
816+
817+
- **CLI:** `--tagsFilter <expression>`
818+
819+
Run only tests with the specified tags. You can use logical operators `&&` (and), `||` (or) and `!` (not) to create complex expressions, see [Test Tags](/guide/test-tags#syntax) for more information.
820+
821+
### strictTags
822+
823+
- **CLI:** `--strictTags`
824+
- **Config:** [strictTags](/config/stricttags)
825+
826+
Should Vitest throw an error if test has a tag that is not defined in the config. (default: `true`)
827+
801828
### experimental.fsModuleCache
802829

803830
- **CLI:** `--experimental.fsModuleCache`

packages/vitest/src/node/cli/cli-config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -789,7 +789,7 @@ export const cliOptionsConfig: VitestCLIOptions = {
789789
description: 'Delete all Vitest caches, including `experimental.fsModuleCache`, without running any tests. This will reduce the performance in the subsequent test run.',
790790
},
791791
tagsFilter: {
792-
description: 'Run only tests with the specified tags. You can use logical operators `&&` (and), `||` (or) and `!` (not) to create complex expressions, see: https://vitest.dev/guide/test-tags#syntax for more information.',
792+
description: 'Run only tests with the specified tags. You can use logical operators `&&` (and), `||` (or) and `!` (not) to create complex expressions, see [Test Tags](https://vitest.dev/guide/test-tags#syntax) for more information.',
793793
argument: '<expression>',
794794
array: true,
795795
},

0 commit comments

Comments
 (0)