feat(vitest): allow conditional context.skip(boolean) (#7659)

Co-authored-by: Ari Perkkiö <[email protected]>

Author: sheremet-va

docs/api/index.md

@@ -129,6 +129,18 @@ 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:
+
+```ts
+import { assert, test } from 'vitest'
+
+test('skipped test', (context) => {
+  context.skip(Math.random() < 0.5, 'optional message')
+  // Test skipped, no error
+  assert.equal(Math.sqrt(4), 3)
+})
+```
+
 ### test.skipIf
 
 - **Alias:** `it.skipIf`

packages/runner/src/context.ts

@@ -104,10 +104,18 @@ export function createTestContext(
 
   context.task = test
 
-  context.skip = (note?: string) => {
+  context.skip = (condition?: boolean | string, note?: string): never => {
+    if (condition === false) {
+      // do nothing
+      return undefined as never
+    }
     test.result ??= { state: 'skip' }
     test.result.pending = true
-    throw new PendingError('test is skipped; abort execution', test, note)
+    throw new PendingError(
+      'test is skipped; abort execution',
+      test,
+      typeof condition === 'string' ? condition : note,
+    )
   }
 
   context.onTestFailed = (handler, timeout) => {

packages/runner/src/types/tasks.ts

@@ -658,7 +658,10 @@ export interface TestContext {
    * Mark tests as skipped. All execution after this call will be skipped.
    * This function throws an error, so make sure you are not catching it accidentally.
    */
-  skip: (note?: string) => never
+  skip: {
+    (note?: string): never
+    (condition: boolean, note?: string): void
+  }
 }
 
 /**

test/cli/fixtures/fails/skip-conditional.test.ts

@@ -0,0 +1,11 @@
+import { expect, it } from 'vitest';
+
+it('skips correctly', (t) => {
+  t.skip(true)
+  expect.unreachable()
+})
+
+it('doesnt skip correctly', (t) => {
+  t.skip(false)
+  throw new Error('doesnt skip')
+})

test/cli/test/__snapshots__/fails.test.ts.snap

@@ -74,6 +74,8 @@ Error: expect.poll(assertion).toBe() was not awaited. This assertion is asynchro
 
 exports[`should fail primitive-error.test.ts 1`] = `"Unknown Error: 42"`;
 
+exports[`should fail skip-conditional.test.ts 1`] = `"Error: doesnt skip"`;
+
 exports[`should fail snapshot-with-not.test.ts 1`] = `
 "Error: toThrowErrorMatchingInlineSnapshot cannot be used with "not"
 Error: toThrowErrorMatchingSnapshot cannot be used with "not"

test/reporters/fixtures/default/a.test.ts

@@ -24,3 +24,17 @@ describe('a failed', () => {
     })
   })
 })
+
+describe('a skipped', () => {
+  test('skipped with note', (t) => {
+    t.skip('reason')
+  })
+
+  test('condition', (t) => {
+    t.skip(true)
+  })
+
+  test('condition with note', (t) => {
+    t.skip(true, 'note')
+  })
+})

test/reporters/tests/default.test.ts

@@ -63,10 +63,12 @@ describe('default reporter', async () => {
       reporters: 'none',
     })
 
-    expect(stdout).contain('✓ a passed > a1 test')
-    expect(stdout).contain('✓ a passed > nested a > nested a3 test')
-    expect(stdout).contain('× a failed > a failed test')
-    expect(stdout).contain('nested a failed 1 test')
+    expect(stdout).toContain('✓ a passed > a1 test')
+    expect(stdout).toContain('✓ a passed > nested a > nested a3 test')
+    expect(stdout).toContain('× a failed > a failed test')
+    expect(stdout).toContain('nested a failed 1 test')
+    expect(stdout).toContain('[note]')
+    expect(stdout).toContain('[reason]')
   })
 
   test('rerun should undo', async () => {

test/reporters/tests/junit.test.ts

@@ -120,8 +120,8 @@ test('options.classname changes classname property', async () => {
 
   // All classname attributes should have the custom value
   expect(xml.match(/<testcase classname="a\.test\.ts"/g)).toBeNull()
-  expect(xml.match(/<testcase classname="/g)).toHaveLength(13)
-  expect(xml.match(/<testcase classname="some-custom-classname"/g)).toHaveLength(13)
+  expect(xml.match(/<testcase classname="/g)).toHaveLength(16)
+  expect(xml.match(/<testcase classname="some-custom-classname"/g)).toHaveLength(16)
 })
 
 test('options.suiteName changes name property', async () => {