@vitest/expect 2.1.9: getState

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/expect.getState in pkg:npm/%40vitest/expect@2.1.9
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40vitest/expect@2.1.9
Demonstrate these symbols/APIs:
  - @vitest/expect.getState
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:2ba759fe943fe54a14d853fb98d569f39f003ad52c3a558b752e1015161437e6","constraints":{"executionContext":"node"},"contract":["assert getState returns undefined for uninitialized expect targets","assert getState returns state object updated by setState for specified expect target","assert getState preserves existing state properties across partial updates from setState","assert getState isolates state between different expect targets","assert getState returns undefined when passed non-object or undefined targets","assert getState preserves property descriptors defined via setState","assert getState integrates with matcher execution context to provide lifecycle state"],"goal":"verify @vitest/expect.getState in pkg:npm/%40vitest/expect@2.1.9","kind":"HOW","packages":["pkg:npm/%40vitest/expect@2.1.9"],"schemaVersion":1,"symbols":["@vitest/expect.getState"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","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/expect@2.1.9"],"schemaVersion":1,"subject":"pkg:npm/%40vitest/expect@2.1.9","symbols":["@vitest/expect.getState"],"verifierAdapter":"node-typescript@1"}

import * as chai from 'chai';
import {
  getState,
  setState,
  JestChaiExpect,
  JestAsymmetricMatchers,
  JestExtend,
} from '@vitest/expect';

/**
 * Retrieves the internal matcher state for a given expect instance or target.
 *
 * @param {unknown} target - The expect instance or target object.
 * @returns {object|undefined} The current state object, or undefined if not set.
 */
export function getExpectState(target) {
  return getState(target);
}

/**
 * Updates or initializes the internal matcher state for a given expect target.
 *
 * @param {object|Function} target - The target expect instance or context object.
 * @param {object} state - The state properties to assign.
 */
export function setExpectState(target, state) {
  setState(state, target);
}

/**
 * Creates and configures a chai expect instance with Vitest matchers and extensions.
 *
 * @returns {Function} Configured expect function.
 */
export function createConfiguredExpect() {
  chai.use(JestChaiExpect);
  chai.use(JestAsymmetricMatchers);
  chai.use(JestExtend);
  return chai.expect;
}

export {
  getState,
  setState,
  JestChaiExpect,
  JestAsymmetricMatchers,
  JestExtend,
};

{
  "name": "sample-vitest-expect-get-state",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-vitest-expect-get-state",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@vitest/expect": "2.1.9"
      }
    },
    "node_modules/@vitest/expect": {
      "version": "2.1.9",
      "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.9.tgz",
      "integrity": "sha512-UJCIkTBenHeKT1TTlKMJWy1laZewsRIzYighyYiJKZreqtdxSos/S1t+ktRMQWu2CKqaarrkeszJx1cgC5tGZw==",
      "license": "MIT",
      "dependencies": {
        "@vitest/spy": "2.1.9",
        "@vitest/utils": "2.1.9",
        "chai": "^5.1.2",
        "tinyrainbow": "^1.2.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/pretty-format": {
      "version": "2.1.9",
      "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.9.tgz",
      "integrity": "sha512-KhRIdGV2U9HOUzxfiHmY8IFHTdqtOhIzCpd8WRdJiE7D/HUcZVD0EgQCVjm+Q9gkUXWgBvMmTtZgIG48wq7sOQ==",
      "license": "MIT",
      "dependencies": {
        "tinyrainbow": "^1.2.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/spy": {
      "version": "2.1.9",
      "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.9.tgz",
      "integrity": "sha512-E1B35FwzXXTs9FHNK6bDszs7mtydNi5MIfUWpceJ8Xbfb1gBMscAnwLbEu+B44ed6W3XjL9/ehLPHR1fkf1KLQ==",
      "license": "MIT",
      "dependencies": {
        "tinyspy": "^3.0.2"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/utils": {
      "version": "2.1.9",
      "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.9.tgz",
      "integrity": "sha512-v0psaMSkNJ3A2NMrUEHFRzJtDPFn+/VWZ5WxImB21T9fjucJRmS7xCS3ppEnARb9y11OAzaD+P2Ps+b+BGX5iQ==",
      "license": "MIT",
      "dependencies": {
        "@vitest/pretty-format": "2.1.9",
        "loupe": "^3.1.2",
        "tinyrainbow": "^1.2.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/assertion-error": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz",
      "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==",
      "license": "MIT",
      "engines": {
        "node": ">=12"
      }
    },
    "node_modules/chai": {
      "version": "5.3.3",
      "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz",
      "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==",
      "license": "MIT",
      "dependencies": {
        "assertion-error": "^2.0.1",
        "check-error": "^2.1.1",
        "deep-eql": "^5.0.1",
        "loupe": "^3.1.0",
        "pathval": "^2.0.0"
      },
      "engines": {
        "node": ">=18"
      }
    },
    "node_modules/check-error": {
      "version": "2.1.3",
      "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz",
      "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==",
      "license": "MIT",
      "engines": {
        "node": ">= 16"
      }
    },
    "node_modules/deep-eql": {
      "version": "5.0.2",
      "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz",
      "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==",
      "license": "MIT",
      "engines": {
        "node": ">=6"
      }
    },
    "node_modules/loupe": {
      "version": "3.2.1",
      "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz",
      "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==",
      "license": "MIT"
    },
    "node_modules/pathval": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz",
      "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==",
      "license": "MIT",
      "engines": {
        "node": ">= 14.16"
      }
    },
    "node_modules/tinyrainbow": {
      "version": "1.2.0",
      "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-1.2.0.tgz",
      "integrity": "sha512-weEDEq7Z5eTHPDh4xjX789+fHfF+P8boiFB+0vbWzpbnbsEr/GRaohi/uMKxg8RZMXnl1ItAi/IUHWMsjDV7kQ==",
      "license": "MIT",
      "engines": {
        "node": ">=14.0.0"
      }
    },
    "node_modules/tinyspy": {
      "version": "3.0.2",
      "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-3.0.2.tgz",
      "integrity": "sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==",
      "license": "MIT",
      "engines": {
        "node": ">=14.0.0"
      }
    }
  }
}

{
  "name": "sample-vitest-expect-get-state",
  "version": "1.0.0",
  "description": "Clean-room verification sample for @vitest/expect getState",
  "type": "module",
  "main": "index.mjs",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "license": "MIT-0",
  "dependencies": {
    "@vitest/expect": "2.1.9"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @vitest/expect.getState in pkg:npm/%40vitest/expect@2.1.9",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40vitest/expect@2.1.9"
  ],
  "symbols": [
    "@vitest/expect.getState"
  ],
  "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 {
  getState,
  setState,
  getExpectState,
  setExpectState,
  createConfiguredExpect,
} from '../index.mjs';

async function runContract() {
  // 1. assert getState returns undefined for uninitialized expect targets
  const uninitializedTarget = {};
  assert.strictEqual(getState(uninitializedTarget), undefined);

  const uninitializedFn = () => {};
  assert.strictEqual(getState(uninitializedFn), undefined);
  assert.strictEqual(getExpectState(uninitializedTarget), undefined);

  // 2. assert getState returns state object updated by setState for specified expect target
  const targetA = {};
  const initialData = { currentTestName: 'test auth flow', assertionCount: 1, isNot: false };
  setState(initialData, targetA);
  const stateA1 = getState(targetA);
  assert.notStrictEqual(stateA1, undefined);
  assert.strictEqual(stateA1.currentTestName, 'test auth flow');
  assert.strictEqual(stateA1.assertionCount, 1);
  assert.strictEqual(stateA1.isNot, false);
  assert.strictEqual(getExpectState(targetA), stateA1);

  // 3. assert getState preserves existing state properties across partial updates from setState
  setExpectState(targetA, { assertionCount: 2, testPath: '/tests/auth.test.ts' });
  const stateA2 = getState(targetA);
  assert.strictEqual(stateA2.currentTestName, 'test auth flow');
  assert.strictEqual(stateA2.assertionCount, 2);
  assert.strictEqual(stateA2.testPath, '/tests/auth.test.ts');
  assert.strictEqual(stateA2.isNot, false);

  // 4. assert getState isolates state between different expect targets
  const targetB = {};
  setState({ currentTestName: 'test payment flow', assertionCount: 42 }, targetB);
  assert.strictEqual(getState(targetB).currentTestName, 'test payment flow');
  assert.strictEqual(getState(targetB).assertionCount, 42);
  assert.strictEqual(getState(targetA).currentTestName, 'test auth flow');
  assert.strictEqual(getState(targetA).assertionCount, 2);

  // 5. assert getState returns undefined when passed non-object or undefined targets
  assert.strictEqual(getState(undefined), undefined);
  assert.strictEqual(getState(null), undefined);
  assert.strictEqual(getState(123), undefined);
  assert.strictEqual(getState('non-object-string'), undefined);
  assert.strictEqual(getState(true), undefined);
  assert.strictEqual(getState(Symbol('test-key')), undefined);

  // 6. assert getState preserves property descriptors defined via setState
  const targetC = {};
  const descriptorSource = {};
  let getterInvocations = 0;
  Object.defineProperty(descriptorSource, 'dynamicCounter', {
    get() {
      getterInvocations += 1;
      return getterInvocations;
    },
    enumerable: true,
    configurable: true,
  });
  setState(descriptorSource, targetC);
  const stateC = getState(targetC);
  assert.notStrictEqual(stateC, undefined);
  assert.strictEqual(stateC.dynamicCounter, 1);
  assert.strictEqual(stateC.dynamicCounter, 2);

  // 7. assert getState integrates with matcher execution context to provide lifecycle state
  const expect = createConfiguredExpect();
  setState({ currentTestName: 'lifecycle-integration-test', assertionCount: 50 }, expect);
  assert.strictEqual(getState(expect).currentTestName, 'lifecycle-integration-test');

  expect.extend(expect, {
    toInspectCurrentState(received) {
      const currentState = getState(expect);
      const pass =
        this.currentTestName === 'lifecycle-integration-test' &&
        currentState.assertionCount === 50 &&
        received === true;
      return {
        pass,
        message: () => `expected state to match matcher context, got: ${JSON.stringify(currentState)}`,
      };
    },
  });

  expect(true).toInspectCurrentState();

  console.log('Contract assertions passed successfully.');
}

runContract().catch((err) => {
  console.error('Contract test failed:', err);
  process.exit(1);
});