Merge branch 'main' of github.com:vitest-dev/vitest into feat/provide-signal

Author: sheremet-va

docs/advanced/runner.md

@@ -209,7 +209,7 @@ interface Test<ExtraContext = object> extends TaskBase {
    */
   file: File
   /**
-   * Whether the task was skipped by calling `t.skip()`.
+   * Whether the task was skipped by calling `context.skip()`.
    */
   pending?: boolean
   /**

docs/api/index.md

@@ -167,7 +167,7 @@ test('skipped test', (context) => {
 })
 ```
 
-Since Vitest 3.1, if the condition is unknonwn, you can provide it to the `skip` method as the first arguments:
+Since Vitest 3.1, if the condition is unknown, you can provide it to the `skip` method as the first arguments:
 
 ```ts
 import { assert, test } from 'vitest'
@@ -1279,16 +1279,6 @@ test('performs an organization query', async () => {
 
 ::: tip
 This hook is always called in reverse order and is not affected by [`sequence.hooks`](/config/#sequence-hooks) option.
-
-<!-- TODO: should it be called? https://github.com/vitest-dev/vitest/pull/7069 -->
-Note that this hook is not called if test was skipped with a dynamic `ctx.skip()` call:
-
-```ts{2}
-test('skipped dynamically', (t) => {
-  onTestFinished(() => {}) // not called
-  t.skip()
-})
-```
 :::
 
 ### onTestFailed

docs/guide/browser/commands.md

@@ -11,7 +11,7 @@ Command is a function that invokes another function on the server and passes dow
 
 ### Files Handling
 
-You can use `readFile`, `writeFile` and `removeFile` API to handle files inside your browser tests. All paths are resolved relative to the test file even if they are called in a helper function located in another file.
+You can use the `readFile`, `writeFile`, and `removeFile` APIs to handle files in your browser tests. Since Vitest 3.2, all paths are resolved relative to the [project](/guide/workspace) root (which is `process.cwd()`, unless overriden manually). Previously, paths were resolved relative to the test file.
 
 By default, Vitest uses `utf-8` encoding but you can override it with options.
 

docs/guide/cli-generated.md

@@ -761,6 +761,13 @@ Omit annotation lines from the output (default: `false`)
 
 Print basic prototype Object and Array (default: `true`)
 
+### diff.maxDepth
+
+- **CLI:** `--diff.maxDepth <maxDepth>`
+- **Config:** [diff.maxDepth](/config/#diff-maxdepth)
+
+Limit the depth to recurse when printing nested objects (default: `20`)
+
 ### diff.truncateThreshold
 
 - **CLI:** `--diff.truncateThreshold <threshold>`

docs/guide/test-context.md

@@ -22,11 +22,11 @@ it('should work', ({ task }) => {
 
 ## Built-in Test Context
 
-#### `context.task`
+#### `task`
 
 A readonly object containing metadata about the test.
 
-#### `context.expect`
+#### `expect`
 
 The `expect` API bound to the current test:
 
@@ -52,7 +52,12 @@ it.concurrent('math is hard', ({ expect }) => {
 })
 ```
 
-#### `context.skip`
+#### `skip`
+
+```ts
+function skip(note?: string): never
+function skip(condition: boolean, note?: string): void
+```
 
 Skips subsequent test execution and marks test as skipped:
 
@@ -65,6 +70,15 @@ it('math is hard', ({ skip }) => {
 })
 ```
 
+Since Vitest 3.1, it accepts a boolean parameter to skip the test conditionally:
+
+```ts
+it('math is hard', ({ skip, mind }) => {
+  skip(mind === 'foggy')
+  expect(2 + 2).toBe(5)
+})
+```
+
 #### `context.signal` <Version>3.2.0</Version> {#context-signal}
 
 An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can be aborted by Vitest. The signal is aborted in these situations:
@@ -80,6 +94,14 @@ it('stop request when test times out', async ({ signal }) => {
 }, 2000)
 ```
 
+#### `onTestFailed`
+
+The [`onTestFailed`](/api/#ontestfailed) hook bound to the current test. This API is useful if you are running tests concurrently and need to have a special handling only for this specific test.
+
+#### `onTestFinished`
+
+The [`onTestFinished`](/api/#ontestfailed) hook bound to the current test. This API is useful if you are running tests concurrently and need to have a special handling only for this specific test.
+
 ## Extend Test Context
 
 Vitest provides two different ways to help you extend the test context.
@@ -88,15 +110,15 @@ Vitest provides two different ways to help you extend the test context.
 
 Like [Playwright](https://playwright.dev/docs/api/class-test#test-extend), you can use this method to define your own `test` API with custom fixtures and reuse it anywhere.
 
-For example, we first create `myTest` with two fixtures, `todos` and `archive`.
+For example, we first create the `test` collector with two fixtures: `todos` and `archive`.
 
 ```ts [my-test.ts]
-import { test } from 'vitest'
+import { test as baseTest } from 'vitest'
 
 const todos = []
 const archive = []
 
-export const myTest = test.extend({
+export const test = baseTest.extend({
   todos: async ({}, use) => {
     // setup the fixture before each test function
     todos.push(1, 2, 3)
@@ -115,16 +137,16 @@ Then we can import and use it.
 
 ```ts [my-test.test.ts]
 import { expect } from 'vitest'
-import { myTest } from './my-test.js'
+import { test } from './my-test.js'
 
-myTest('add items to todos', ({ todos }) => {
+test('add items to todos', ({ todos }) => {
   expect(todos.length).toBe(3)
 
   todos.push(4)
   expect(todos.length).toBe(4)
 })
 
-myTest('move items from todos to archive', ({ todos, archive }) => {
+test('move items from todos to archive', ({ todos, archive }) => {
   expect(todos.length).toBe(3)
   expect(archive.length).toBe(0)
 
@@ -134,10 +156,12 @@ myTest('move items from todos to archive', ({ todos, archive }) => {
 })
 ```
 
-We can also add more fixtures or override existing fixtures by extending `myTest`.
+We can also add more fixtures or override existing fixtures by extending our `test`.
 
 ```ts
-export const myTest2 = myTest.extend({
+import { test as todosTest } from './my-test.js'
+
+export const test = todosTest.extend({
   settings: {
     // ...
   }
@@ -149,34 +173,35 @@ export const myTest2 = myTest.extend({
 Vitest runner will smartly initialize your fixtures and inject them into the test context based on usage.
 
 ```ts
-import { test } from 'vitest'
+import { test as baseTest } from 'vitest'
 
-async function todosFn({ task }, use) {
-  await use([1, 2, 3])
-}
-
-const myTest = test.extend({
-  todos: todosFn,
+const test = baseTest.extend<{
+  todos: number[]
+  archive: number[]
+}>({
+  todos: async ({ task }, use) => {
+    await use([1, 2, 3])
+  },
   archive: []
 })
 
-// todosFn will not run
-myTest('', () => {})
-myTest('', ({ archive }) => {})
+// todos will not run
+test('skip', () => {})
+test('skip', ({ archive }) => {})
 
-// todosFn will run
-myTest('', ({ todos }) => {})
+// todos will run
+test('run', ({ todos }) => {})
 ```
 
 ::: warning
 When using `test.extend()` with fixtures, you should always use the object destructuring pattern `{ todos }` to access context both in fixture function and test function.
 
 ```ts
-myTest('context must be destructured', (context) => { // [!code --]
+test('context must be destructured', (context) => { // [!code --]
   expect(context.todos.length).toBe(2)
 })
 
-myTest('context must be destructured', ({ todos }) => { // [!code ++]
+test('context must be destructured', ({ todos }) => { // [!code ++]
   expect(todos.length).toBe(2)
 })
 ```
@@ -331,19 +356,46 @@ interface MyFixtures {
   archive: number[]
 }
 
-const myTest = test.extend<MyFixtures>({
+const test = baseTest.extend<MyFixtures>({
   todos: [],
   archive: []
 })
 
-myTest('types are defined correctly', ({ todos, archive }) => {
+test('types are defined correctly', ({ todos, archive }) => {
   expectTypeOf(todos).toEqualTypeOf<number[]>()
   expectTypeOf(archive).toEqualTypeOf<number[]>()
 })
 ```
 
+::: info Type Infering
+Note that Vitest doesn't support infering the types when the `use` function is called. It is always preferable to pass down the whole context type as the generic type when `test.extend` is called:
+
+```ts
+import { test as baseTest } from 'vitest'
+
+const test = baseTest.extend<{
+  todos: number[]
+  schema: string
+}>({
+  todos: ({ schema }, use) => use([]),
+  schema: 'test'
+})
+
+test('types are correct', ({
+  todos, // number[]
+  schema, // string
+}) => {
+  // ...
+})
+```
+:::
+
 ### `beforeEach` and `afterEach`
 
+::: danger Deprecated
+This is an outdated way of extending context and it will not work when the `test` is extended with `test.extend`.
+:::
+
 The contexts are different for each test. You can access and extend them within the `beforeEach` and `afterEach` hooks.
 
 ```ts
@@ -361,7 +413,7 @@ it('should work', ({ foo }) => {
 
 #### TypeScript
 
-To provide property types for all your custom contexts, you can aggregate the `TestContext` type by adding
+To provide property types for all your custom contexts, you can augment the `TestContext` type by adding
 
 ```ts
 declare module 'vitest' {

docs/package.json

@@ -20,8 +20,8 @@
   "devDependencies": {
     "@iconify-json/carbon": "catalog:",
     "@iconify-json/logos": "catalog:",
-    "@shikijs/transformers": "^3.2.2",
-    "@shikijs/vitepress-twoslash": "^3.2.2",
+    "@shikijs/transformers": "^3.3.0",
+    "@shikijs/vitepress-twoslash": "^3.3.0",
     "@unocss/reset": "catalog:",
     "@vite-pwa/assets-generator": "^0.2.6",
     "@vite-pwa/vitepress": "^0.5.4",
@@ -32,7 +32,7 @@
     "unplugin-vue-components": "catalog:",
     "vite": "^5.2.8",
     "vite-plugin-pwa": "^0.21.2",
-    "vitepress": "2.0.0-alpha.4",
+    "vitepress": "2.0.0-alpha.5",
     "vitepress-plugin-group-icons": "^1.5.2",
     "vitepress-plugin-tabs": "^0.7.0",
     "workbox-window": "^7.3.0"

examples/lit/package.json

@@ -19,7 +19,7 @@
   "devDependencies": {
     "@vitest/browser": "latest",
     "jsdom": "latest",
-    "playwright": "^1.51.1",
+    "playwright": "^1.52.0",
     "vite": "latest",
     "vitest": "latest"
   },

examples/workspace/package.json

@@ -13,7 +13,7 @@
     "@testing-library/react": "^13.4.0",
     "@testing-library/user-event": "^14.6.1",
     "@types/react": "^19.1.2",
-    "@vitejs/plugin-react": "^4.3.4",
+    "@vitejs/plugin-react": "^4.4.1",
     "@vitest/ui": "latest",
     "fastify": "^4.29.0",
     "jsdom": "^24.1.3",

package.json

@@ -1,9 +1,9 @@
 {
   "name": "@vitest/monorepo",
   "type": "module",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "private": true,
-  "packageManager": "pnpm@10.8.1",
+  "packageManager": "pnpm@10.9.0",
   "description": "Next generation testing framework powered by Vite",
   "engines": {
     "node": "^18.0.0 || >=20.0.0"
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@antfu/eslint-config": "^4.12.0",
     "@antfu/ni": "^24.3.0",
-    "@playwright/test": "^1.51.1",
+    "@playwright/test": "^1.52.0",
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
@@ -50,8 +50,8 @@
     "@vitest/ui": "workspace:*",
     "bumpp": "^10.1.0",
     "changelogithub": "^13.13.0",
-    "esbuild": "^0.25.2",
-    "eslint": "^9.24.0",
+    "esbuild": "^0.25.3",
+    "eslint": "^9.26.0",
     "magic-string": "^0.30.17",
     "pathe": "^2.0.3",
     "rimraf": "^6.0.1",
@@ -61,11 +61,11 @@
     "tinyglobby": "catalog:",
     "tsx": "^4.19.3",
     "typescript": "^5.8.3",
-    "unplugin-isolated-decl": "^0.13.6",
-    "unplugin-oxc": "^0.3.3",
+    "unplugin-isolated-decl": "^0.13.9",
+    "unplugin-oxc": "^0.3.5",
     "vite": "^6.2.0",
     "vitest": "workspace:*",
-    "zx": "^8.5.2"
+    "zx": "^8.5.3"
   },
   "pnpm": {
     "overrides": {

packages/browser/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/browser",
   "type": "module",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Browser running for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -103,17 +103,17 @@
     "@vitest/ui": "workspace:*",
     "@vitest/ws-client": "workspace:*",
     "@wdio/protocols": "^9.12.5",
-    "@wdio/types": "^9.12.3",
+    "@wdio/types": "^9.12.6",
     "birpc": "catalog:",
     "flatted": "catalog:",
     "ivya": "^1.6.0",
     "mime": "^4.0.7",
     "pathe": "catalog:",
     "periscopic": "^4.0.2",
-    "playwright": "^1.51.1",
-    "playwright-core": "^1.51.1",
+    "playwright": "^1.52.0",
+    "playwright-core": "^1.52.0",
     "safaridriver": "^1.0.0",
     "vitest": "workspace:*",
-    "webdriverio": "^9.12.5"
+    "webdriverio": "^9.12.7"
   }
 }