ansi-regex 6.3.0

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/ansi-regex@6.3.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/ansi-regex@6.3.0
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:319be4efdd81a1ce13df0c1231efc2cc3aaf026530c84991713d94216b4ee105","constraints":{"executionContext":"node"},"contract":["ansiRegex returns a RegExp instance for matching ANSI escape codes with global flag enabled by default","ansiRegex with onlyFirst set to true returns a non-global RegExp instance","ansiRegex matches standard ANSI Select Graphic Rendition styling and color sequences","ansiRegex matches 256-color and 24-bit truecolor RGB ANSI escape sequences","ansiRegex matches Operating System Command hyperlink sequences terminated with BEL or ST","ansiRegex matches terminal cursor movement and screen clear control sequences","ansiRegex matches 8-bit C1 control sequences","ansiRegex removes ANSI escape codes from styled strings when used with String.prototype.replace"],"goal":"verify pkg:npm/ansi-regex@6.3.0","kind":"HOW","packages":["pkg:npm/ansi-regex@6.3.0"],"schemaVersion":1},"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/ansi-regex@6.3.0"],"schemaVersion":1,"subject":"pkg:npm/ansi-regex@6.3.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-ansi-regex",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-ansi-regex",
      "version": "1.0.0",
      "dependencies": {
        "ansi-regex": "6.3.0"
      }
    },
    "node_modules/ansi-regex": {
      "version": "6.3.0",
      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.3.0.tgz",
      "integrity": "sha512-WpDfL7NO6j7tH88IDBNVdUJxDh9nmCteAVW9dsep846XdwF4naCBK+/tGLX3KJgcpgMRXCFlTM2hKGoK9FsdrQ==",
      "license": "MIT",
      "engines": {
        "node": ">=12"
      },
      "funding": {
        "url": "https://github.com/chalk/ansi-regex?sponsor=1"
      }
    }
  }
}

{
  "name": "sample-ansi-regex",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "ansi-regex": "6.3.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/ansi-regex@6.3.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/ansi-regex@6.3.0"
  ],
  "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 ansiRegex from 'ansi-regex';

// 1. ansiRegex returns a RegExp instance for matching ANSI escape codes with global flag enabled by default
{
  const regex = ansiRegex();
  assert.ok(regex instanceof RegExp);
  assert.equal(regex.global, true);
}

// 2. ansiRegex with onlyFirst set to true returns a non-global RegExp instance
{
  const regex = ansiRegex({ onlyFirst: true });
  assert.ok(regex instanceof RegExp);
  assert.equal(regex.global, false);
}

// 3. ansiRegex matches standard ANSI Select Graphic Rendition styling and color sequences
{
  const text = '\u001B[1m\u001B[4mbold underline\u001B[0m \u001B[31mred\u001B[39m';
  const matches = text.match(ansiRegex());
  assert.deepEqual(matches, ['\u001B[1m', '\u001B[4m', '\u001B[0m', '\u001B[31m', '\u001B[39m']);
  assert.equal(ansiRegex().test(text), true);
  assert.equal(ansiRegex().test('plain text without escape codes'), false);
}

// 4. ansiRegex matches 256-color and 24-bit truecolor RGB ANSI escape sequences
{
  const color256 = '\u001B[38;5;196m256-color\u001B[0m';
  const truecolor = '\u001B[38;2;255;128;64mtruecolor\u001B[0m';
  assert.deepEqual(color256.match(ansiRegex()), ['\u001B[38;5;196m', '\u001B[0m']);
  assert.deepEqual(truecolor.match(ansiRegex()), ['\u001B[38;2;255;128;64m', '\u001B[0m']);
}

// 5. ansiRegex matches Operating System Command hyperlink sequences terminated with BEL or ST
{
  const belOsc = '\u001B]8;;https://example.com\u0007link\u001B]8;;\u0007';
  const stOsc = '\u001B]8;;https://example.com\u001B\\link\u001B]8;;\u001B\\';
  assert.deepEqual(belOsc.match(ansiRegex()), ['\u001B]8;;https://example.com\u0007', '\u001B]8;;\u0007']);
  assert.deepEqual(stOsc.match(ansiRegex()), ['\u001B]8;;https://example.com\u001B\\', '\u001B]8;;\u001B\\']);
}

// 6. ansiRegex matches terminal cursor movement and screen clear control sequences
{
  const controlText = '\u001B[2J\u001B[H\u001B[2K\u001B[1A';
  assert.deepEqual(controlText.match(ansiRegex()), ['\u001B[2J', '\u001B[H', '\u001B[2K', '\u001B[1A']);
}

// 7. ansiRegex matches 8-bit C1 control sequences
{
  const c1Text = '\u009B31mRed\u009B0m';
  assert.deepEqual(c1Text.match(ansiRegex()), ['\u009B31m', '\u009B0m']);
}

// 8. ansiRegex removes ANSI escape codes from styled strings when used with String.prototype.replace
{
  const styled = '\u001B[1m\u001B[32mClean \u001B[4mRoom\u001B[0m!';
  const plain = styled.replace(ansiRegex(), '');
  assert.equal(plain, 'Clean Room!');
}