CodeSampleX

Exemplo

@jest/console 29.7.0: buffer and format console log messages using BufferedConsole

Amostra verificada para npm @jest/console 29.7.0: buffer and format console log messages using BufferedConsole. O contrato rodou em node 22 · linux…

sha256:4934dde5b9466242d407338ae2bdf7347bf4d78dae14649af5d3762f0b1a5b4f

Esta rede oferece uma coisa: uma amostra que compila. Ela a executou em um sandbox e guardou o recibo assinado. Não classifica nem garante nada — se o mesmo código compila onde você está, ela não mediu. Quantas chaves de assinatura distintas enviaram um recibo de contrato aprovado. Uma é só o autor; mais de uma significa que outra pessoa também o compilou. Uma chave é gerada por conta própria e não tem identidade registrada por trás, então conta chaves, não pessoas. MIT-0

Evidência de execução

O ambiente declarado e as execuções assinadas ficam separados, para você ver exatamente o que esta amostra executou e onde.

Base da evidência
Contrato assinado aprovado
Recibos de verificação
1
Chaves de assinatura que o compilaram
1
Ambiente declarado node 22.23 linux 24 · ubuntu · glibc 2.39 x64 node 22.23 javascript npm 10

Ambientes das execuções de verificação

Ambiente Contrato Etapas Execução
node 22 · linux alpine/x64 · docker ed25519:c1973797be207ac4 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · node-typescript@1node:22-alpine@sha256:c610fcdfb1d5…		 2026-08-23

Caso

HOW
Objetivo
buffer and format console log messages using BufferedConsole
Pacotes
Símbolos
  • BufferedConsole
  • getConsoleOutput
Ambiente
node 22.23.2
Criado
2026-08-23T16:15:38Z

Contrato

  1. BufferedConsole captures log, info, warn, error, and debug messages into an in-memory buffer with type, message, and caller origin stack trace
  2. BufferedConsole.write appends structured log entries directly to a target buffer array
  3. BufferedConsole manages indentation levels for grouped logs with group and groupCollapsed while groupEnd resets indentation without creating buffer entries
  4. BufferedConsole tracks named timers with time and timeEnd and named counters with count and countReset
  5. BufferedConsole.assert logs an AssertionError entry with type assert when evaluated condition is falsy and ignores truthy conditions
  6. getConsoleOutput formats buffered console log entries into indented output strings with colorized log types and stack traces
  7. captureConsoleLogs intercepts global console output during function execution and restores the original global console on completion
  8. CustomConsole writes console entries directly to custom writable stdout and stderr streams
  9. NullConsole requires writable streams in constructor and silences all console output without throwing

Arquivos

  • PROMPT.md
  • csx.json
  • index.js
  • package-lock.json
  • package.json
  • spec.json
  • test/contract.js

Baixar o artefato de código-fonte (tar.gz)

Código-fonte

PROMPT.md
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: buffer and format console log messages using BufferedConsole
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40jest/console@29.7.0
Demonstrate these symbols/APIs:
  - BufferedConsole
  - getConsoleOutput
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.
csx.json
{"case":{"caseId":"case:sha256:3b0bd1927a71d86c81cb08f921956b5ff3a90c18cd9f05dd69af8a1e34775215","constraints":{"executionContext":"node"},"contract":["BufferedConsole captures log, info, warn, error, and debug messages into an in-memory buffer with type, message, and caller origin stack trace","BufferedConsole.write appends structured log entries directly to a target buffer array","BufferedConsole manages indentation levels for grouped logs with group and groupCollapsed while groupEnd resets indentation without creating buffer entries","BufferedConsole tracks named timers with time and timeEnd and named counters with count and countReset","BufferedConsole.assert logs an AssertionError entry with type assert when evaluated condition is falsy and ignores truthy conditions","getConsoleOutput formats buffered console log entries into indented output strings with colorized log types and stack traces","captureConsoleLogs intercepts global console output during function execution and restores the original global console on completion","CustomConsole writes console entries directly to custom writable stdout and stderr streams","NullConsole requires writable streams in constructor and silences all console output without throwing"],"goal":"buffer and format console log messages using BufferedConsole","kind":"HOW","packages":["pkg:npm/%40jest/console@29.7.0"],"schemaVersion":1,"symbols":["BufferedConsole","getConsoleOutput"]},"contractCommand":["node","test/contract.js"],"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/%40jest/console@29.7.0"],"schemaVersion":1,"subject":"pkg:npm/%40jest/console@29.7.0","symbols":["BufferedConsole","getConsoleOutput"],"verifierAdapter":"node-typescript@1"}
index.js
'use strict';

const { Writable } = require('stream');
const {
  BufferedConsole,
  CustomConsole,
  NullConsole,
  getConsoleOutput
} = require('@jest/console');

/**
 * Creates a new BufferedConsole instance.
 * @param {Function} [getSourceMaps] - Optional source map resolver function.
 * @returns {BufferedConsole}
 */
function createBufferedConsole(getSourceMaps = () => null) {
  return new BufferedConsole(getSourceMaps);
}

/**
 * Formats a console buffer using getConsoleOutput with given options.
 * @param {Array<object>} buffer - Log entries buffer from BufferedConsole.
 * @param {object} [options] - Configuration options.
 * @param {string} [options.rootDir] - Root directory for stack trace normalization.
 * @param {boolean} [options.verbose] - Whether to use verbose indentation.
 * @param {boolean} [options.noStackTrace] - Whether to omit stack traces.
 * @returns {string} Formatted console output string.
 */
function formatConsoleEntries(buffer, options = {}) {
  const rootDir = options.rootDir || process.cwd();
  const config = { rootDir };
  const globalConfig = {
    verbose: Boolean(options.verbose),
    noStackTrace: Boolean(options.noStackTrace)
  };
  return getConsoleOutput(buffer, config, globalConfig);
}

/**
 * Executes a callback function and captures all console messages logged during its execution.
 * @param {Function} fn - Function to execute.
 * @param {object} [formatOptions] - Options passed to formatConsoleEntries.
 * @returns {{ result: *, buffer: Array<object>, output: string, console: BufferedConsole }}
 */
function captureConsoleLogs(fn, formatOptions = {}) {
  const bufferedConsole = createBufferedConsole();
  const originalConsole = global.console;
  let result;

  try {
    global.console = bufferedConsole;
    result = fn(bufferedConsole);
  } finally {
    global.console = originalConsole;
  }

  const buffer = bufferedConsole.getBuffer() || [];
  const output = formatConsoleEntries(buffer, formatOptions);

  return {
    result,
    buffer,
    output,
    console: bufferedConsole
  };
}

/**
 * Creates a CustomConsole that writes output through custom writable streams.
 * @param {NodeJS.WritableStream} stdout - Stream for stdout messages (log, info, dir, etc.).
 * @param {NodeJS.WritableStream} stderr - Stream for stderr messages (warn, error, assert).
 * @param {Function} [formatBuffer] - Optional custom buffer formatter function.
 * @returns {CustomConsole}
 */
function createCustomConsole(stdout, stderr, formatBuffer) {
  return new CustomConsole(stdout, stderr, formatBuffer);
}

/**
 * Creates a NullConsole instance with default no-op streams if none provided.
 * @param {NodeJS.WritableStream} [stdout] - Optional stdout stream.
 * @param {NodeJS.WritableStream} [stderr] - Optional stderr stream.
 * @returns {NullConsole}
 */
function createNullConsole(stdout, stderr) {
  const devNull = () =>
    new Writable({
      write(chunk, encoding, callback) {
        callback();
      }
    });
  return new NullConsole(stdout || devNull(), stderr || devNull());
}

module.exports = {
  BufferedConsole,
  CustomConsole,
  NullConsole,
  getConsoleOutput,
  createBufferedConsole,
  formatConsoleEntries,
  captureConsoleLogs,
  createCustomConsole,
  createNullConsole
};
package-lock.json
{
  "name": "sample-jest-console",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-jest-console",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@jest/console": "29.7.0"
      }
    },
    "node_modules/@babel/code-frame": {
      "version": "7.29.7",
      "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.7.tgz",
      "integrity": "sha512-Aup7aUOfpbAUg2ROOJN6Iw5f9DMBlzu0mIkm/malLQFN/YQgO48wCj0Kxa3sEHJvPVFg7siR+qRInwXd2qhQKw==",
      "license": "MIT",
      "dependencies": {
        "@babel/helper-validator-identifier": "^7.29.7",
        "js-tokens": "^4.0.0",
        "picocolors": "^1.1.1"
      },
      "engines": {
        "node": ">=6.9.0"
      }
    },
    "node_modules/@babel/helper-validator-identifier": {
      "version": "7.29.7",
      "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.29.7.tgz",
      "integrity": "sha512-qehxGkRj55h/ff8EMaJ+cYhyaKlHIxqYDn682wQD7RNp9UujOQsHog2uS0r2vzr4pW+sXf90NeeayjcNaX3fFg==",
      "license": "MIT",
      "engines": {
        "node": ">=6.9.0"
      }
    },
    "node_modules/@jest/console": {
      "version": "29.7.0",
      "resolved": "https://registry.npmjs.org/@jest/console/-/console-29.7.0.tgz",
      "integrity": "sha512-5Ni4CU7XHQi32IJ398EEP4RrB8eV09sXP2ROqD4bksHrnTree52PsxvX8tpL8LvTZ3pFzXyPbNQReSN41CAhOg==",
      "license": "MIT",
      "dependencies": {
        "@jest/types": "^29.6.3",
        "@types/node": "*",
        "chalk": "^4.0.0",
        "jest-message-util": "^29.7.0",
        "jest-util": "^29.7.0",
        "slash": "^3.0.0"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/@jest/schemas": {
      "version": "29.6.3",
      "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz",
      "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==",
      "license": "MIT",
      "dependencies": {
        "@sinclair/typebox": "^0.27.8"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/@jest/types": {
      "version": "29.6.3",
      "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz",
      "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==",
      "license": "MIT",
      "dependencies": {
        "@jest/schemas": "^29.6.3",
        "@types/istanbul-lib-coverage": "^2.0.0",
        "@types/istanbul-reports": "^3.0.0",
        "@types/node": "*",
        "@types/yargs": "^17.0.8",
        "chalk": "^4.0.0"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/@sinclair/typebox": {
      "version": "0.27.12",
      "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.12.tgz",
      "integrity": "sha512-hhyNJ+nbR6ZR7pToHvllEFun9TL0sbL+tk/ON75lo+Xas054uez98qRbsuNt7MBCyZKK4+8Yli/OAGZhmfBZ/g==",
      "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.2.0",
      "resolved": "https://registry.npmjs.org/@types/node/-/node-26.2.0.tgz",
      "integrity": "sha512-5IviulTZeRNp2vAJ514cc/HUlY5nZ9fCbq9DMyC52BrhFZACo3nI0R7qBxhQmo/d27NFe96ur/b7Wwxklda+kg==",
      "license": "MIT",
      "dependencies": {
        "undici-types": "~8.3.0"
      }
    },
    "node_modules/@types/stack-utils": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz",
      "integrity": "sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==",
      "license": "MIT"
    },
    "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/braces": {
      "version": "3.0.3",
      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
      "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
      "license": "MIT",
      "dependencies": {
        "fill-range": "^7.1.1"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "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": "3.9.0",
      "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz",
      "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==",
      "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/escape-string-regexp": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
      "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/fill-range": {
      "version": "7.1.1",
      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
      "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
      "license": "MIT",
      "dependencies": {
        "to-regex-range": "^5.0.1"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "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/is-number": {
      "version": "7.0.0",
      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
      "license": "MIT",
      "engines": {
        "node": ">=0.12.0"
      }
    },
    "node_modules/jest-message-util": {
      "version": "29.7.0",
      "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.7.0.tgz",
      "integrity": "sha512-GBEV4GRADeP+qtB2+6u61stea8mGcOT4mCtrYISZwfu9/ISHFJ/5zOMXYbpBE9RsS5+Gb63DW4FgmnKJ79Kf6w==",
      "license": "MIT",
      "dependencies": {
        "@babel/code-frame": "^7.12.13",
        "@jest/types": "^29.6.3",
        "@types/stack-utils": "^2.0.0",
        "chalk": "^4.0.0",
        "graceful-fs": "^4.2.9",
        "micromatch": "^4.0.4",
        "pretty-format": "^29.7.0",
        "slash": "^3.0.0",
        "stack-utils": "^2.0.3"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/jest-util": {
      "version": "29.7.0",
      "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz",
      "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==",
      "license": "MIT",
      "dependencies": {
        "@jest/types": "^29.6.3",
        "@types/node": "*",
        "chalk": "^4.0.0",
        "ci-info": "^3.2.0",
        "graceful-fs": "^4.2.9",
        "picomatch": "^2.2.3"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/js-tokens": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
      "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
      "license": "MIT"
    },
    "node_modules/micromatch": {
      "version": "4.0.8",
      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
      "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
      "license": "MIT",
      "dependencies": {
        "braces": "^3.0.3",
        "picomatch": "^2.3.1"
      },
      "engines": {
        "node": ">=8.6"
      }
    },
    "node_modules/picocolors": {
      "version": "1.1.1",
      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
      "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==",
      "license": "ISC"
    },
    "node_modules/picomatch": {
      "version": "2.3.2",
      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz",
      "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==",
      "license": "MIT",
      "engines": {
        "node": ">=8.6"
      },
      "funding": {
        "url": "https://github.com/sponsors/jonschlinkert"
      }
    },
    "node_modules/pretty-format": {
      "version": "29.7.0",
      "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz",
      "integrity": "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==",
      "license": "MIT",
      "dependencies": {
        "@jest/schemas": "^29.6.3",
        "ansi-styles": "^5.0.0",
        "react-is": "^18.0.0"
      },
      "engines": {
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
    "node_modules/pretty-format/node_modules/ansi-styles": {
      "version": "5.2.0",
      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz",
      "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==",
      "license": "MIT",
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
      }
    },
    "node_modules/react-is": {
      "version": "18.3.1",
      "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz",
      "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==",
      "license": "MIT"
    },
    "node_modules/slash": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
      "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/stack-utils": {
      "version": "2.0.6",
      "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz",
      "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==",
      "license": "MIT",
      "dependencies": {
        "escape-string-regexp": "^2.0.0"
      },
      "engines": {
        "node": ">=10"
      }
    },
    "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/to-regex-range": {
      "version": "5.0.1",
      "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
      "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
      "license": "MIT",
      "dependencies": {
        "is-number": "^7.0.0"
      },
      "engines": {
        "node": ">=8.0"
      }
    },
    "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"
    }
  }
}
package.json
{
  "name": "sample-jest-console",
  "version": "1.0.0",
  "private": true,
  "description": "buffer and format console log messages using BufferedConsole",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "@jest/console": "29.7.0"
  },
  "license": "MIT-0"
}
spec.json
{
  "schemaVersion": 1,
  "goal": "buffer and format console log messages using BufferedConsole",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40jest/console@29.7.0"
  ],
  "symbols": [
    "BufferedConsole",
    "getConsoleOutput"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}
test/contract.js
'use strict';

const assert = require('assert');
const { Writable } = require('stream');
const {
  BufferedConsole,
  CustomConsole,
  NullConsole,
  getConsoleOutput,
  createBufferedConsole,
  formatConsoleEntries,
  captureConsoleLogs,
  createCustomConsole,
  createNullConsole
} = require('../index.js');

function testBufferedConsoleLogging() {
  const consoleInstance = createBufferedConsole();
  consoleInstance.log('standard log message');
  consoleInstance.info('informational notice');
  consoleInstance.warn('warning notice');
  consoleInstance.error('error event');
  consoleInstance.debug('debug trace');

  const buffer = consoleInstance.getBuffer();
  assert.ok(Array.isArray(buffer), 'buffer must be an array');
  assert.strictEqual(buffer.length, 5, 'buffer must contain exactly 5 entries');

  assert.strictEqual(buffer[0].type, 'log');
  assert.strictEqual(buffer[0].message, 'standard log message');
  assert.ok(typeof buffer[0].origin === 'string' && buffer[0].origin.length > 0);

  assert.strictEqual(buffer[1].type, 'info');
  assert.strictEqual(buffer[1].message, 'informational notice');

  assert.strictEqual(buffer[2].type, 'warn');
  assert.strictEqual(buffer[2].message, 'warning notice');

  assert.strictEqual(buffer[3].type, 'error');
  assert.strictEqual(buffer[3].message, 'error event');

  assert.strictEqual(buffer[4].type, 'debug');
  assert.strictEqual(buffer[4].message, 'debug trace');
}

function testBufferedConsoleStaticWrite() {
  const targetBuffer = [];
  BufferedConsole.write(targetBuffer, 'warn', 'manually written message', 1);

  assert.strictEqual(targetBuffer.length, 1);
  assert.strictEqual(targetBuffer[0].type, 'warn');
  assert.strictEqual(targetBuffer[0].message, 'manually written message');
  assert.ok(typeof targetBuffer[0].origin === 'string');
}

function testBufferedConsoleGrouping() {
  const consoleInstance = createBufferedConsole();
  consoleInstance.group('Parent Group');
  consoleInstance.log('nested item 1');
  consoleInstance.groupCollapsed('Child Group');
  consoleInstance.log('deeply nested item');
  consoleInstance.groupEnd();
  consoleInstance.log('nested item 2');
  consoleInstance.groupEnd();

  const buffer = consoleInstance.getBuffer();
  assert.strictEqual(buffer.length, 5);

  assert.strictEqual(buffer[0].type, 'group');
  assert.strictEqual(buffer[0].message, '  Parent Group');

  assert.strictEqual(buffer[1].type, 'log');
  assert.strictEqual(buffer[1].message, '  nested item 1');

  assert.strictEqual(buffer[2].type, 'groupCollapsed');
  assert.strictEqual(buffer[2].message, '    Child Group');

  assert.strictEqual(buffer[3].type, 'log');
  assert.strictEqual(buffer[3].message, '    deeply nested item');

  assert.strictEqual(buffer[4].type, 'log');
  assert.strictEqual(buffer[4].message, '  nested item 2');
}

function testBufferedConsoleTimersAndCounters() {
  const consoleInstance = createBufferedConsole();
  consoleInstance.count('testCounter');
  consoleInstance.count('testCounter');
  consoleInstance.countReset('testCounter');
  consoleInstance.count('testCounter');

  consoleInstance.time('operationTimer');
  consoleInstance.timeEnd('operationTimer');

  const buffer = consoleInstance.getBuffer();
  assert.strictEqual(buffer[0].message, 'testCounter: 1');
  assert.strictEqual(buffer[1].message, 'testCounter: 2');
  assert.strictEqual(buffer[2].message, 'testCounter: 1');

  assert.strictEqual(buffer[3].type, 'time');
  assert.match(buffer[3].message, /^operationTimer: \d+(\.\d+)?\s*(ms|s)$/);
}

function testBufferedConsoleAssertions() {
  const consoleInstance = createBufferedConsole();
  consoleInstance.assert(true, 'truthy condition must not log');
  assert.strictEqual(consoleInstance.getBuffer(), undefined);

  consoleInstance.assert(false, 'falsy condition logged');
  const buffer = consoleInstance.getBuffer();
  assert.strictEqual(buffer.length, 1);
  assert.strictEqual(buffer[0].type, 'assert');
  assert.match(buffer[0].message, /AssertionError.*falsy condition logged/);
}

function testGetConsoleOutputFormatting() {
  const consoleInstance = createBufferedConsole();
  consoleInstance.log('output formatting log');
  consoleInstance.warn('output formatting warn');
  consoleInstance.error('output formatting error');

  const buffer = consoleInstance.getBuffer();
  const formattedVerbose = formatConsoleEntries(buffer, {
    verbose: true,
    noStackTrace: false
  });
  assert.match(formattedVerbose, /console\.log/);
  assert.match(formattedVerbose, /output formatting log/);
  assert.match(formattedVerbose, /console\.warn/);
  assert.match(formattedVerbose, /output formatting warn/);
  assert.match(formattedVerbose, /console\.error/);
  assert.match(formattedVerbose, /output formatting error/);

  const formattedNoStack = formatConsoleEntries(buffer, {
    verbose: false,
    noStackTrace: true
  });
  assert.match(formattedNoStack, /output formatting log/);
}

function testCaptureConsoleLogs() {
  const result = captureConsoleLogs(() => {
    console.log('intercepted message');
    console.warn('intercepted warning');
    return 'success-value';
  });

  assert.strictEqual(result.result, 'success-value');
  assert.strictEqual(result.buffer.length, 2);
  assert.strictEqual(result.buffer[0].message, 'intercepted message');
  assert.strictEqual(result.buffer[1].message, 'intercepted warning');
  assert.match(result.output, /intercepted message/);
}

function testCustomConsoleStreaming() {
  const stdoutChunks = [];
  const stderrChunks = [];

  const stdoutStream = new Writable({
    write(chunk, encoding, callback) {
      stdoutChunks.push(chunk.toString());
      callback();
    }
  });

  const stderrStream = new Writable({
    write(chunk, encoding, callback) {
      stderrChunks.push(chunk.toString());
      callback();
    }
  });

  const customConsole = createCustomConsole(stdoutStream, stderrStream);
  customConsole.log('stdout message');
  customConsole.error('stderr message');

  assert.strictEqual(stdoutChunks.join(''), 'stdout message\n');
  assert.strictEqual(stderrChunks.join(''), 'stderr message\n');
}

function testNullConsole() {
  // NullConsole requires streams in constructor, otherwise throws ERR_CONSOLE_WRITABLE_STREAM
  assert.throws(
    () => {
      new NullConsole();
    },
    (err) => {
      assert.strictEqual(err.code, 'ERR_CONSOLE_WRITABLE_STREAM');
      return true;
    }
  );

  const nullConsole = createNullConsole();
  nullConsole.log('silenced log');
  nullConsole.info('silenced info');
  nullConsole.warn('silenced warn');
  nullConsole.error('silenced error');
  nullConsole.debug('silenced debug');
}

function runAll() {
  testBufferedConsoleLogging();
  testBufferedConsoleStaticWrite();
  testBufferedConsoleGrouping();
  testBufferedConsoleTimersAndCounters();
  testBufferedConsoleAssertions();
  testGetConsoleOutputFormatting();
  testCaptureConsoleLogs();
  testCustomConsoleStreaming();
  testNullConsole();

  console.log('Contract tests passed successfully.');
  process.exit(0);
}

runAll();

Seeder de origem

anônimo