From 486fd1169a7ce6735a259e1dd49290b0a9934882 Mon Sep 17 00:00:00 2001 From: Vladimir Date: Thu, 20 Jun 2024 14:15:38 +0200 Subject: [PATCH] fix(types): mark pool options as not available in project config (#5934) --- docs/config/index.md | 6 +++--- packages/vitest/src/types/config.ts | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/config/index.md b/docs/config/index.md index eee75fb48c71..94d4a34e7706 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -900,7 +900,7 @@ Pass additional arguments to `node` process in the VM context. See [Command-line Be careful when using, it as some options may crash worker, e.g. --prof, --title. See https://github.com/nodejs/node/issues/41103. ::: -### fileParallelism {#fileparallelism} +### fileParallelism {#fileparallelism} - **Type:** `boolean` - **Default:** `true` @@ -912,13 +912,13 @@ Should all test files run in parallel. Setting this to `false` will override `ma This option doesn't affect tests running in the same file. If you want to run those in parallel, use `concurrent` option on [describe](/api/#describe-concurrent) or via [a config](#sequence-concurrent). ::: -### maxWorkers {#maxworkers} +### maxWorkers {#maxworkers} - **Type:** `number` Maximum number of workers to run tests in. `poolOptions.{threads,vmThreads}.maxThreads`/`poolOptions.forks.maxForks` has higher priority. -### minWorkers {#minworkers} +### minWorkers {#minworkers} - **Type:** `number` diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts index c3ab0da0315b..b77748a87fb2 100644 --- a/packages/vitest/src/types/config.ts +++ b/packages/vitest/src/types/config.ts @@ -1041,6 +1041,9 @@ export type ProjectConfig = Omit< | 'inspectBrk' | 'deps' | 'coverage' + | 'maxWorkers' + | 'minWorkers' + | 'fileParallelism' > & { sequencer?: Omit deps?: Omit