jest-util 30.4.1: ErrorWithStack

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 jest-util.ErrorWithStack in pkg:npm/jest-util@30.4.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/jest-util@30.4.1
Demonstrate these symbols/APIs:
  - jest-util.ErrorWithStack

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:61eaa99aae522b9b094d4fddd7b9ae17389fa4c8fff4764c49308d3c5a4ca4cc","contract":["ErrorWithStack inherits from JavaScript Error class and preserves provided message and error prototype chain","ErrorWithStack captures stack trace starting above the specified callsite function in V8 environments","ErrorWithStack captures stack trace at invocation site when callsite parameter is omitted","ErrorWithStack accepts optional stackLimit parameter to expand capture depth and restores original stackTraceLimit","ErrorWithStack instances can be thrown and caught in try-catch blocks like standard Error objects","jest-util exports ErrorWithStack in both CommonJS and ECMAScript module formats"],"goal":"verify jest-util.ErrorWithStack in pkg:npm/jest-util@30.4.1","kind":"HOW","packages":["pkg:npm/jest-util@30.4.1"],"schemaVersion":1,"symbols":["jest-util.ErrorWithStack"]},"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/jest-util@30.4.1"],"schemaVersion":1,"subject":"pkg:npm/jest-util@30.4.1","symbols":["jest-util.ErrorWithStack"],"verifierAdapter":"node-typescript@1"}

import { ErrorWithStack } from 'jest-util';
import { createRequire } from 'node:module';

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

export { ErrorWithStack };

/**
 * Creates an ErrorWithStack instance with the provided message, callsite, and optional stackLimit.
 */
export function createErrorWithStack(message, callsite, stackLimit) {
  return new ErrorWithStack(message, callsite, stackLimit);
}

/**
 * Helper function that creates an ErrorWithStack hiding itself from the stack trace.
 */
export function createHiddenCallsiteError(message, stackLimit) {
  return new ErrorWithStack(message, createHiddenCallsiteError, stackLimit);
}

/**
 * Returns package metadata for jest-util.
 */
export function getJestUtilInfo() {
  const pkgPath = require.resolve('jest-util/package.json');
  const pkg = require(pkgPath);
  return {
    name: pkg.name,
    version: pkg.version,
    exports: pkg.exports,
  };
}

{
  "name": "sample-jest-util-error-with-stack",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-jest-util-error-with-stack",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "jest-util": "30.4.1"
      }
    },
    "node_modules/@jest/pattern": {
      "version": "30.4.0",
      "resolved": "https://registry.npmjs.org/@jest/pattern/-/pattern-30.4.0.tgz",
      "integrity": "sha512-RAWn3+f9u8BsHijKJ71uHcFp6vmyEt6VvoWXkl6hKF3qVIuWNmudVjg12DlBPGup/frIl5UcUlH5HfEuvHpEXg==",
      "license": "MIT",
      "dependencies": {
        "@types/node": "*",
        "jest-regex-util": "30.4.0"
      },
      "engines": {
        "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
      }
    },
    "node_modules/@jest/schemas": {
      "version": "30.4.1",
      "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-30.4.1.tgz",
      "integrity": "sha512-i6b4qw5qnP8c5FEeBJg/uZQ4ddrkN6Ca8qISJh0pr7a5hfn3h3v5x60BEbOC7OYAGZNMs1LfFLwnW2CuK8F57Q==",
      "license": "MIT",
      "dependencies": {
        "@sinclair/typebox": "^0.34.0"
      },
      "engines": {
        "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
      }
    },
    "node_modules/@jest/types": {
      "version": "30.4.1",
      "resolved": "https://registry.npmjs.org/@jest/types/-/types-30.4.1.tgz",
      "integrity": "sha512-f1x/vJXIfjOlEmejYpbkbgw1gOqpPECwMvMEtBqe47j7H2Hg8h8w3o3ikhSXq3MI15kg+oQ0exWO0uCtTNJLoQ==",
      "license": "MIT",
      "dependencies": {
        "@jest/pattern": "30.4.0",
        "@jest/schemas": "30.4.1",
        "@types/istanbul-lib-coverage": "^2.0.6",
        "@types/istanbul-reports": "^3.0.4",
        "@types/node": "*",
        "@types/yargs": "^17.0.33",
        "chalk": "^4.1.2"
      },
      "engines": {
        "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
      }
    },
    "node_modules/@sinclair/typebox": {
      "version": "0.34.52",
      "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.34.52.tgz",
      "integrity": "sha512-XiMQh7qqVlxZzcVD+kkGMNGMzcTrDMLWI7S4x7z1MkCkbDPrekpZXEUK0eZqZFMuHQg2a2DZOcDIh9o5v3Gonw==",
      "license": "MIT"
    },
    "node_modules/@types/istanbul-lib-coverage": {
      "version": "2.0.6",
      "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz",
      "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==",
      "license": "MIT"
    },
    "node_modules/@types/istanbul-lib-report": {
      "version": "3.0.3",
      "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz",
      "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==",
      "license": "MIT",
      "dependencies": {
        "@types/istanbul-lib-coverage": "*"
      }
    },
    "node_modules/@types/istanbul-reports": {
      "version": "3.0.4",
      "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz",
      "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==",
      "license": "MIT",
      "dependencies": {
        "@types/istanbul-lib-report": "*"
      }
    },
    "node_modules/@types/node": {
      "version": "26.4.1",
      "resolved": "https://registry.npmjs.org/@types/node/-/node-26.4.1.tgz",
      "integrity": "sha512-k97ENvZWtvA6yqz5/FS6a7duDgOPEeOQOc2iKS/nY6mX6qJUKtLnWzQS+Xj6tXweyj6ZcTAK2Qecetnvi9nCLA==",
      "license": "MIT",
      "dependencies": {
        "undici-types": "~8.3.0"
      }
    },
    "node_modules/@types/yargs": {
      "version": "17.0.35",
      "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.35.tgz",
      "integrity": "sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg==",
      "license": "MIT",
      "dependencies": {
        "@types/yargs-parser": "*"
      }
    },
    "node_modules/@types/yargs-parser": {
      "version": "21.0.3",
      "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz",
      "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==",
      "license": "MIT"
    },
    "node_modules/ansi-styles": {
      "version": "4.3.0",
      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
      "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
      "license": "MIT",
      "dependencies": {
        "color-convert": "^2.0.1"
      },
      "engines": {
        "node": ">=8"
      },
      "funding": {
        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
      }
    },
    "node_modules/chalk": {
      "version": "4.1.2",
      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
      "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
      "license": "MIT",
      "dependencies": {
        "ansi-styles": "^4.1.0",
        "supports-color": "^7.1.0"
      },
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/chalk/chalk?sponsor=1"
      }
    },
    "node_modules/ci-info": {
      "version": "4.4.0",
      "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.4.0.tgz",
      "integrity": "sha512-77PSwercCZU2Fc4sX94eF8k8Pxte6JAwL4/ICZLFjJLqegs7kCuAsqqj/70NQF6TvDpgFjkubQB2FW2ZZddvQg==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/sibiraj-s"
        }
      ],
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/color-convert": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
      "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
      "license": "MIT",
      "dependencies": {
        "color-name": "~1.1.4"
      },
      "engines": {
        "node": ">=7.0.0"
      }
    },
    "node_modules/color-name": {
      "version": "1.1.4",
      "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
      "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
      "license": "MIT"
    },
    "node_modules/graceful-fs": {
      "version": "4.2.11",
      "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
      "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
      "license": "ISC"
    },
    "node_modules/has-flag": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
      "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/jest-regex-util": {
      "version": "30.4.0",
      "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-30.4.0.tgz",
      "integrity": "sha512-mWlvLviKIgIQ8VCuM1xRdD0TWp3zlzionlmDBjuXVBs+VkmXq6FgW9T4Emr7oGz/Rk6feDCGyiugolcQEyp3mg==",
      "license": "MIT",
      "engines": {
        "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
      }
    },
    "node_modules/jest-util": {
      "version": "30.4.1",
      "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-30.4.1.tgz",
      "integrity": "sha512-vjQb1sACEiv13DKJMDToJpzVW0joCsIQrmbg0fi7CyOOt+g9jTuQl2A216pWRBYhOVt53XbL/2LbMKg1BECWOw==",
      "license": "MIT",
      "dependencies": {
        "@jest/types": "30.4.1",
        "@types/node": "*",
        "chalk": "^4.1.2",
        "ci-info": "^4.2.0",
        "graceful-fs": "^4.2.11",
        "picomatch": "^4.0.3"
      },
      "engines": {
        "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
      }
    },
    "node_modules/picomatch": {
      "version": "4.0.7",
      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.7.tgz",
      "integrity": "sha512-qcJu88Q2IWqJsDD529JKMdwGm/dvInW4HvQnRwiH9JtihJvzGOscDtHE3x1pBKeUOTysQ8kVmLnJ2kJu7yhcGA==",
      "license": "MIT",
      "engines": {
        "node": ">=12"
      },
      "funding": {
        "url": "https://github.com/sponsors/jonschlinkert"
      }
    },
    "node_modules/supports-color": {
      "version": "7.2.0",
      "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
      "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
      "license": "MIT",
      "dependencies": {
        "has-flag": "^4.0.0"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/undici-types": {
      "version": "8.3.0",
      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-8.3.0.tgz",
      "integrity": "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-jest-util-error-with-stack",
  "version": "1.0.0",
  "description": "Clean-room verification sample for jest-util.ErrorWithStack",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "jest-util": "30.4.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify jest-util.ErrorWithStack in pkg:npm/jest-util@30.4.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/jest-util@30.4.1"
  ],
  "symbols": [
    "jest-util.ErrorWithStack"
  ]
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';
import { ErrorWithStack } from 'jest-util';
import {
  createErrorWithStack,
  createHiddenCallsiteError,
  getJestUtilInfo,
} from '../index.mjs';

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

// 1. ErrorWithStack inherits from JavaScript Error class and preserves provided message and error prototype chain
{
  const err = createErrorWithStack('custom error message');
  assert.ok(err instanceof Error);
  assert.ok(err instanceof ErrorWithStack);
  assert.equal(err.message, 'custom error message');
  assert.equal(err.name, 'Error');

  const emptyErr = new ErrorWithStack();
  assert.ok(emptyErr instanceof Error);
  assert.ok(emptyErr instanceof ErrorWithStack);
  assert.equal(emptyErr.message, '');
}

// 2. ErrorWithStack captures stack trace starting above the specified callsite function in V8 environments
{
  function internalHelper() {
    return new ErrorWithStack('callsite test', internalHelper);
  }
  function userAction() {
    return internalHelper();
  }
  const err = userAction();
  assert.ok(typeof err.stack === 'string');
  assert.ok(err.stack.includes('callsite test'));
  assert.ok(!err.stack.includes('internalHelper'));
  assert.ok(err.stack.includes('userAction'));

  function callerOfHidden() {
    return createHiddenCallsiteError('hidden wrapper test');
  }
  const hiddenErr = callerOfHidden();
  assert.ok(!hiddenErr.stack.includes('createHiddenCallsiteError'));
  assert.ok(hiddenErr.stack.includes('callerOfHidden'));
}

// 3. ErrorWithStack captures stack trace at invocation site when callsite parameter is omitted
{
  function invocationSite() {
    return new ErrorWithStack('direct invocation');
  }
  const err = invocationSite();
  assert.ok(typeof err.stack === 'string');
  assert.ok(err.stack.includes('direct invocation'));
  assert.ok(err.stack.includes('invocationSite'));
}

// 4. ErrorWithStack accepts optional stackLimit parameter to expand capture depth and restores original stackTraceLimit
{
  const originalLimit = Error.stackTraceLimit;
  function level1() {
    return level2();
  }
  function level2() {
    return level3();
  }
  function level3() {
    return new ErrorWithStack('stack limit test', level3, 50);
  }
  const err = level1();
  assert.equal(Error.stackTraceLimit, originalLimit);
  assert.ok(typeof err.stack === 'string');
  assert.ok(err.stack.includes('level1'));
  assert.ok(err.stack.includes('level2'));
  assert.ok(!err.stack.includes('level3'));
}

// 5. ErrorWithStack instances can be thrown and caught in try-catch blocks like standard Error objects
{
  assert.throws(
    () => {
      throw new ErrorWithStack('thrown exception', () => {});
    },
    (err) => {
      assert.ok(err instanceof ErrorWithStack);
      assert.ok(err instanceof Error);
      assert.equal(err.message, 'thrown exception');
      return true;
    }
  );
}

// 6. jest-util exports ErrorWithStack in both CommonJS and ECMAScript module formats
{
  assert.equal(typeof ErrorWithStack, 'function');
  const cjs = require('jest-util');
  assert.equal(typeof cjs.ErrorWithStack, 'function');
  assert.equal(cjs.ErrorWithStack, ErrorWithStack);

  const info = getJestUtilInfo();
  assert.equal(info.name, 'jest-util');
  assert.equal(info.version, '30.4.1');
}

console.log('All jest-util.ErrorWithStack contract assertions passed successfully.');