feat: allow a custom note when calling ctx.skip() dynamically

vitest-dev · Oct 28, 2024 · 9e58f74 · 9e58f74
1 parent 47d7c0a
commit 9e58f74
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/packages/runner/src/context.ts b/packages/runner/src/context.ts
@@ -67,9 +67,9 @@ export function createTestContext<T extends Test | Custom>(
 
   context.task = test
 
-  context.skip = () => {
+  context.skip = (note?: string) => {
     test.pending = true
-    throw new PendingError('test is skipped; abort execution', test)
+    throw new PendingError('test is skipped; abort execution', test, note)
   }
 
   context.onTestFailed = (fn) => {

diff --git a/packages/runner/src/errors.ts b/packages/runner/src/errors.ts
@@ -4,7 +4,7 @@ export class PendingError extends Error {
   public code = 'VITEST_PENDING'
   public taskId: string
 
-  constructor(public message: string, task: TaskBase) {
+  constructor(public message: string, task: TaskBase, public note: string | undefined) {
     super(message)
     this.taskId = task.id
   }

diff --git a/packages/runner/src/run.ts b/packages/runner/src/run.ts
@@ -246,7 +246,7 @@ export async function runTest(test: Test | Custom, runner: VitestRunner): Promis
       // skipped with new PendingError
       if (test.pending || test.result?.state === 'skip') {
         test.mode = 'skip'
-        test.result = { state: 'skip' }
+        test.result = { state: 'skip', note: test.result?.note }
         updateTask(test, runner)
         setCurrentTest(undefined)
         return
@@ -334,6 +334,7 @@ export async function runTest(test: Test | Custom, runner: VitestRunner): Promis
 function failTask(result: TaskResult, err: unknown, diffOptions?: DiffOptions) {
   if (err instanceof PendingError) {
     result.state = 'skip'
+    result.note = err.note
     return
   }
 

diff --git a/packages/runner/src/types/tasks.ts b/packages/runner/src/types/tasks.ts
@@ -147,6 +147,8 @@ export interface TaskResult {
    * `repeats` option is set. This number also contains `retryCount`.
    */
   repeatCount?: number
+  /** @private */
+  note?: string
 }
 
 /**
@@ -611,7 +613,7 @@ export interface TaskContext<Task extends Custom | Test = Custom | Test> {
    * 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: () => void
+  skip: (note?: string) => void
 }
 
 export type ExtendedContext<T extends Custom | Test> = TaskContext<T> &

diff --git a/packages/vitest/src/node/reporters/renderers/listRenderer.ts b/packages/vitest/src/node/reporters/renderers/listRenderer.ts
@@ -144,7 +144,8 @@ function renderTree(
     }
 
     if (task.mode === 'skip' || task.mode === 'todo') {
-      suffix += ` ${c.dim(c.gray('[skipped]'))}`
+      const note = task.result?.note || 'skipped'
+      suffix += ` ${c.dim(c.gray(`[${note}]`))}`
     }
 
     if (

diff --git a/packages/vitest/src/node/state.ts b/packages/vitest/src/node/state.ts
@@ -40,6 +40,7 @@ export class StateManager {
         task.mode = 'skip'
         task.result ??= { state: 'skip' }
         task.result.state = 'skip'
+        task.result.note = _err.note
       }
       return
     }