@vitest/runner 4.1.10: getCurrentSuite

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify @vitest/runner.getCurrentSuite in pkg:npm/%40vitest/runner@4.1.10
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40vitest/runner@4.1.10
Demonstrate these symbols/APIs:
  - @vitest/runner.getCurrentSuite
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:eba474364382aa0d46c2b7e7fc6982a01a9d1a2e076e9235359e933ac1d746f1","constraints":{"executionContext":"node"},"contract":["getCurrentSuite throws an informative error when called outside of test collection context","getCurrentSuite returns the default root suite collector with empty name at top-level file collection","getCurrentSuite returns the active suite collector with matching name and options inside a suite definition","getCurrentSuite resolves the active suite across nested hierarchies and links child suites into parent collector tasks","getCurrentSuite reflects suite modifier execution modes including skip, only, and todo","getCurrentSuite enables direct task creation via test method and tracks child tasks in its tasks array","getCurrentSuite enables direct lifecycle hook registration via on method for suite-level execution"],"goal":"verify @vitest/runner.getCurrentSuite in pkg:npm/%40vitest/runner@4.1.10","kind":"HOW","packages":["pkg:npm/%40vitest/runner@4.1.10"],"schemaVersion":1,"symbols":["@vitest/runner.getCurrentSuite"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40vitest/runner@4.1.10"],"schemaVersion":1,"subject":"pkg:npm/%40vitest/runner@4.1.10","symbols":["@vitest/runner.getCurrentSuite"],"verifierAdapter":"node-typescript@1"}

import {
  getCurrentSuite,
  startTests,
  suite,
  describe,
  it,
  test,
} from '@vitest/runner';

/**
 * Creates an in-memory VitestRunner configuration for programmatic test execution.
 *
 * @param {Function} importHandler - Callback executed during test file loading/collection
 * @param {Object} [configOverrides] - Optional runner configuration overrides
 * @returns {Object} Configured VitestRunner object
 */
export function createTestRunner(importHandler, configOverrides = {}) {
  return {
    config: {
      root: process.cwd(),
      setupFiles: [],
      name: 'in-memory-runner',
      passWithNoTests: true,
      testNamePattern: undefined,
      allowOnly: true,
      sequence: {
        seed: 12345,
        hooks: 'stack',
        setupFiles: 'list',
      },
      chaiConfig: undefined,
      maxConcurrency: 5,
      testTimeout: 5000,
      hookTimeout: 5000,
      retry: 0,
      includeTaskLocation: false,
      tags: [],
      tagsFilter: undefined,
      strictTags: false,
      ...configOverrides,
    },
    importFile: async (filepath) => {
      if (typeof importHandler === 'function') {
        await importHandler(filepath);
      }
    },
  };
}

/**
 * Executes a test suite collection and run phase using @vitest/runner startTests.
 *
 * @param {Function} collectFn - Function defining suites and tests
 * @param {string} [specName='contract.spec.js'] - Virtual spec file name
 * @param {Object} [configOverrides] - Optional runner configuration overrides
 * @returns {Promise<Array>} Array of executed File task results
 */
export async function executeCollection(collectFn, specName = 'contract.spec.js', configOverrides = {}) {
  const runner = createTestRunner(async () => {
    await collectFn();
  }, configOverrides);

  return await startTests([specName], runner);
}

export {
  getCurrentSuite,
  startTests,
  suite,
  describe,
  it,
  test,
};

{
  "name": "sample-vitest-runner-get-current-suite",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-vitest-runner-get-current-suite",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@vitest/runner": "4.1.10"
      }
    },
    "node_modules/@vitest/pretty-format": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.10.tgz",
      "integrity": "sha512-W1HsjSH4MXQ9YfmmhLAoIYf1HRfekQCGngeIgcei6MP5QQGWUe0gkopdZQaVCFO+JDJMrAJGwa5pRpNpvy4P8Q==",
      "license": "MIT",
      "dependencies": {
        "tinyrainbow": "^3.1.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/runner": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.10.tgz",
      "integrity": "sha512-IKI6kpIH+LmpROplyLwBBaCfMgOZOMsygVa6BARD6ahA04VRuJSa6OaVG7kRvSEMD870Vd91rSSw0eegtWyLGg==",
      "license": "MIT",
      "dependencies": {
        "@vitest/utils": "4.1.10",
        "pathe": "^2.0.3"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/utils": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.10.tgz",
      "integrity": "sha512-fy9am/HWxbaGt/Sawrp90vt6Y6jQwf1RX77cz3uwoJwJVMli/e1IEwRPnMNJ7vKfPTwo0diXifkpPvwH9v7nGA==",
      "license": "MIT",
      "dependencies": {
        "@vitest/pretty-format": "4.1.10",
        "convert-source-map": "^2.0.0",
        "tinyrainbow": "^3.1.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/convert-source-map": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz",
      "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==",
      "license": "MIT"
    },
    "node_modules/pathe": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",
      "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==",
      "license": "MIT"
    },
    "node_modules/tinyrainbow": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.1.tgz",
      "integrity": "sha512-yau8yJdTt989Mm0Bd/236QnzEiPf2xLLTqUZRUJOo/3CB078LSwzei343DgtJVmfJKJE3TMINY1u42SQsP6mXw==",
      "license": "MIT",
      "engines": {
        "node": ">=14.0.0"
      }
    }
  }
}

{
  "name": "sample-vitest-runner-get-current-suite",
  "version": "1.0.0",
  "description": "Clean-room verification sample for @vitest/runner.getCurrentSuite",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "@vitest/runner": "4.1.10"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @vitest/runner.getCurrentSuite in pkg:npm/%40vitest/runner@4.1.10",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40vitest/runner@4.1.10"
  ],
  "symbols": [
    "@vitest/runner.getCurrentSuite"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';
import {
  getCurrentSuite,
  executeCollection,
  suite,
  describe,
  it,
  test,
} from '../index.mjs';

const require = createRequire(import.meta.url);

// 0. Module and package verification
{
  const pkg = require('@vitest/runner/package.json');
  assert.equal(pkg.name, '@vitest/runner');
  assert.equal(pkg.version, '4.1.10');
  assert.equal(typeof getCurrentSuite, 'function');
}

// 1. getCurrentSuite throws an informative error when called outside of test collection context
{
  assert.throws(
    () => getCurrentSuite(),
    (err) => {
      assert(err instanceof Error);
      assert.match(err.message, /Vitest failed to find the current suite/);
      return true;
    }
  );
}

// 2. getCurrentSuite returns the default root suite collector with empty name at top-level file collection
{
  let topLevelSuite;
  const files = await executeCollection(() => {
    topLevelSuite = getCurrentSuite();
  }, 'top-level.spec.js');

  assert.equal(typeof topLevelSuite, 'object');
  assert.equal(topLevelSuite.type, 'collector');
  assert.equal(topLevelSuite.name, '');
  assert.equal(topLevelSuite.mode, 'run');
  assert.ok(Array.isArray(topLevelSuite.tasks));
  assert.equal(typeof topLevelSuite.test, 'function');
  assert.equal(typeof topLevelSuite.on, 'function');
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
}

// 3. getCurrentSuite returns the active suite collector with matching name and options inside a suite definition
{
  let capturedSuite;
  const suiteOptions = { retry: 3 };
  const files = await executeCollection(() => {
    suite('Core Processing Unit', suiteOptions, () => {
      capturedSuite = getCurrentSuite();
    });
  }, 'suite-options.spec.js');

  assert.equal(capturedSuite.type, 'collector');
  assert.equal(capturedSuite.name, 'Core Processing Unit');
  assert.equal(capturedSuite.mode, 'run');
  assert.deepEqual(capturedSuite.options, suiteOptions);
  assert.equal(typeof capturedSuite.test, 'function');
  assert.equal(typeof capturedSuite.on, 'function');
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
}

// 4. getCurrentSuite resolves the active suite across nested hierarchies and links child suites into parent collector tasks
{
  let parentCollector;
  let childCollector;
  const files = await executeCollection(() => {
    suite('Parent Suite', () => {
      parentCollector = getCurrentSuite();
      suite('Child Suite', () => {
        childCollector = getCurrentSuite();
        it('child test case', () => {
          assert.equal(10 > 5, true);
        });
      });
    });
  }, 'nested-scope.spec.js');

  assert.equal(parentCollector.name, 'Parent Suite');
  assert.equal(childCollector.name, 'Child Suite');
  assert.ok(parentCollector.tasks.includes(childCollector));
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
  assert.equal(files[0].tasks[0].name, 'Parent Suite');
  assert.equal(files[0].tasks[0].tasks[0].name, 'Child Suite');
  assert.equal(files[0].tasks[0].tasks[0].tasks[0].name, 'child test case');
  assert.equal(files[0].tasks[0].tasks[0].tasks[0].result?.state, 'pass');
}

// 5. getCurrentSuite reflects suite modifier execution modes including skip, only, and todo
{
  const modes = {};
  const files = await executeCollection(() => {
    suite.skip('Skipped Suite', () => {
      modes.skip = getCurrentSuite().mode;
      it('noop skip', () => {});
    });
    suite.only('Focused Suite', () => {
      modes.only = getCurrentSuite().mode;
      it('focused test', () => {});
    });
    suite.todo('Todo Suite', () => {
      modes.todo = getCurrentSuite().mode;
    });
  }, 'suite-modes.spec.js');

  assert.equal(modes.skip, 'skip');
  assert.equal(modes.only, 'only');
  assert.equal(modes.todo, 'todo');
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
}

// 6. getCurrentSuite enables direct task creation via test method and tracks child tasks in its tasks array
{
  let capturedChildTaskNames;
  const files = await executeCollection(() => {
    suite('Task Container Suite', () => {
      const current = getCurrentSuite();
      current.test('dynamically appended test', () => {
        assert.equal(1 + 1, 2);
      });
      it('standard test declaration', () => {
        assert.equal(3 * 3, 9);
      });
      capturedChildTaskNames = current.tasks.map(t => t.name);
    });
  }, 'task-creation.spec.js');

  assert.deepEqual(capturedChildTaskNames, [
    'dynamically appended test',
    'standard test declaration',
  ]);
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
  assert.equal(files[0].tasks[0].tasks.length, 2);
  assert.equal(files[0].tasks[0].tasks[0].name, 'dynamically appended test');
  assert.equal(files[0].tasks[0].tasks[0].result?.state, 'pass');
  assert.equal(files[0].tasks[0].tasks[1].name, 'standard test declaration');
  assert.equal(files[0].tasks[0].tasks[1].result?.state, 'pass');
}

// 7. getCurrentSuite enables direct lifecycle hook registration via on method for suite-level execution
{
  let beforeEachCount = 0;
  let afterEachCount = 0;
  const files = await executeCollection(() => {
    suite('Hook Registration Suite', () => {
      const current = getCurrentSuite();
      current.on('beforeEach', () => {
        beforeEachCount += 1;
      });
      current.on('afterEach', () => {
        afterEachCount += 1;
      });
      it('primary test run', () => {
        assert.equal(beforeEachCount, 1);
      });
      it('secondary test run', () => {
        assert.equal(beforeEachCount, 2);
      });
    });
  }, 'hook-registration.spec.js');

  assert.equal(beforeEachCount, 2);
  assert.equal(afterEachCount, 2);
  assert.equal(files.length, 1);
  assert.equal(files[0].result?.state, 'pass');
}

console.log('All @vitest/runner.getCurrentSuite contract assertions passed.');