wrap-ansi 6.2.0: wrapAnsi

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 pkg:npm/wrap-ansi@6.2.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/wrap-ansi@6.2.0
Demonstrate these symbols/APIs:
  - wrapAnsi

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:4ccf6060d182a7e1fc67953bbc00f0b9b6536980d2a27d32d7a32e92cbbb275d","contract":["wrapAnsi wraps plain text to specified column width with word boundaries","wrapAnsi preserves and reopens ANSI styling codes across wrapped lines","wrapAnsi breaks words exceeding column width when hard option is true","wrapAnsi preserves leading and trailing whitespace when trim option is false","wrapAnsi splits on characters rather than words when wordWrap option is false"],"goal":"verify pkg:npm/wrap-ansi@6.2.0","kind":"HOW","packages":["pkg:npm/wrap-ansi@6.2.0"],"schemaVersion":1,"symbols":["wrapAnsi"]},"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/wrap-ansi@6.2.0"],"schemaVersion":1,"subject":"pkg:npm/wrap-ansi@6.2.0","symbols":["wrapAnsi"],"verifierAdapter":"node-typescript@1"}

{
  "name": "verify-wrap-ansi",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-wrap-ansi",
      "version": "1.0.0",
      "dependencies": {
        "wrap-ansi": "6.2.0"
      }
    },
    "node_modules/ansi-regex": {
      "version": "5.0.1",
      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
      "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "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/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/emoji-regex": {
      "version": "8.0.0",
      "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
      "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
      "license": "MIT"
    },
    "node_modules/is-fullwidth-code-point": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
      "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/string-width": {
      "version": "4.2.3",
      "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
      "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
      "license": "MIT",
      "dependencies": {
        "emoji-regex": "^8.0.0",
        "is-fullwidth-code-point": "^3.0.0",
        "strip-ansi": "^6.0.1"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/strip-ansi": {
      "version": "6.0.1",
      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
      "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
      "license": "MIT",
      "dependencies": {
        "ansi-regex": "^5.0.1"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/wrap-ansi": {
      "version": "6.2.0",
      "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
      "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
      "license": "MIT",
      "dependencies": {
        "ansi-styles": "^4.0.0",
        "string-width": "^4.1.0",
        "strip-ansi": "^6.0.0"
      },
      "engines": {
        "node": ">=8"
      }
    }
  }
}

{
  "name": "verify-wrap-ansi",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "wrap-ansi": "6.2.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/wrap-ansi@6.2.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/wrap-ansi@6.2.0"
  ],
  "symbols": [
    "wrapAnsi"
  ]
}

import wrapAnsi from 'wrap-ansi';

/**
 * Formats and wraps terminal text with ANSI escape sequence support.
 *
 * @param {string} input - Text to wrap
 * @param {number} columns - Number of columns to wrap to
 * @param {object} [options] - Options for wrapping
 * @returns {string} Wrapped text
 */
export function formatTerminalText(input, columns, options = {}) {
  return wrapAnsi(input, columns, options);
}

export { wrapAnsi };
export default wrapAnsi;

import assert from 'node:assert';
import wrapAnsi, { formatTerminalText } from '../src/index.mjs';

// 1. wrapAnsi wraps plain text to specified column width with word boundaries
const plainText = 'The quick brown fox jumps over the lazy dog';
const wrappedPlain = wrapAnsi(plainText, 20);
assert.strictEqual(
  wrappedPlain,
  'The quick brown fox\njumps over the lazy\ndog'
);
assert.strictEqual(
  formatTerminalText(plainText, 20),
  'The quick brown fox\njumps over the lazy\ndog'
);

// 2. wrapAnsi preserves and reopens ANSI styling codes across wrapped lines
const redStart = '\u001b[31m';
const redEnd = '\u001b[39m';
const ansiText = `${redStart}The quick brown fox jumps over the lazy dog${redEnd}`;
const wrappedAnsi = wrapAnsi(ansiText, 20);
const expectedAnsi = `${redStart}The quick brown fox${redEnd}\n${redStart}jumps over the lazy${redEnd}\n${redStart}dog${redEnd}`;
assert.strictEqual(wrappedAnsi, expectedAnsi);

// 3. wrapAnsi breaks words exceeding column width when hard option is true
const longWord = 'supercalifragilisticexpialidocious';
const hardWrapped = wrapAnsi(longWord, 10, { hard: true });
assert.strictEqual(
  hardWrapped,
  'supercalif\nragilistic\nexpialidoc\nious'
);

// 4. wrapAnsi preserves leading and trailing whitespace when trim option is false
const spacedText = '   hello   world   ';
const untrimmedWrapped = wrapAnsi(spacedText, 10, { trim: false });
assert.strictEqual(untrimmedWrapped, '   hello  \n world   ');

// 5. wrapAnsi splits on characters rather than words when wordWrap option is false
const unwordWrapped = wrapAnsi('hello world', 5, { wordWrap: false });
assert.strictEqual(unwordWrapped, 'hello\nworld');

console.log('Contract tests passed successfully.');