kleur 4.1.5: underline

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 kleur.underline in pkg:npm/kleur@4.1.5
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/kleur@4.1.5
Demonstrate these symbols/APIs:
  - kleur.underline

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:89cb762a476a096f409611f2dc83c187994c0e0972637f9d9616f8dcb799ff9f","contract":["kleur.underline applies ANSI underline escape codes to strings when enabled is true","kleur.underline supports chaining with color and style modifiers like bold and cyan","kleur.underline returns plain unformatted text when enabled is false","kleur.underline properly restores underline formatting when nesting styled strings"],"goal":"verify kleur.underline in pkg:npm/kleur@4.1.5","kind":"HOW","packages":["pkg:npm/kleur@4.1.5"],"schemaVersion":1,"symbols":["kleur.underline"]},"contractCommand":["node","test/contract.cjs"],"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/kleur@4.1.5"],"schemaVersion":1,"subject":"pkg:npm/kleur@4.1.5","symbols":["kleur.underline"],"verifierAdapter":"node-typescript@1"}

'use strict';

const kleur = require('kleur');

/**
 * Format text with underline styling.
 * @param {string} text
 * @returns {string}
 */
function underline(text) {
  return kleur.underline(text);
}

/**
 * Format text with chained underline, bold, and cyan styling.
 * @param {string} text
 * @returns {string}
 */
function underlineBoldCyan(text) {
  return kleur.underline().bold().cyan(text);
}

/**
 * Enable or disable color and style formatting.
 * @param {boolean} flag
 */
function setColorEnabled(flag) {
  kleur.enabled = flag;
}

module.exports = {
  kleur,
  underline,
  underlineBoldCyan,
  setColorEnabled
};

{
  "name": "sample-kleur-underline",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-kleur-underline",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "kleur": "4.1.5"
      }
    },
    "node_modules/kleur": {
      "version": "4.1.5",
      "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz",
      "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==",
      "license": "MIT",
      "engines": {
        "node": ">=6"
      }
    }
  }
}

{
  "name": "sample-kleur-underline",
  "version": "1.0.0",
  "private": true,
  "description": "verify kleur.underline in pkg:npm/kleur@4.1.5",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "kleur": "4.1.5"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify kleur.underline in pkg:npm/kleur@4.1.5",
  "kind": "HOW",
  "packages": [
    "pkg:npm/kleur@4.1.5"
  ],
  "symbols": [
    "kleur.underline"
  ]
}

'use strict';

const assert = require('node:assert');
const kleur = require('kleur');
const { underline, underlineBoldCyan, setColorEnabled } = require('../index.js');

function testContract() {
  const initialEnabled = kleur.enabled;

  try {
    setColorEnabled(true);

    // 1. kleur.underline applies ANSI underline escape codes to strings when enabled is true
    assert.strictEqual(kleur.underline('sample'), '\x1b[4msample\x1b[24m');
    assert.strictEqual(underline('sample'), '\x1b[4msample\x1b[24m');

    // 2. kleur.underline supports chaining with color and style modifiers like bold and cyan
    assert.strictEqual(kleur.underline().bold().cyan('sample'), '\x1b[4m\x1b[1m\x1b[36msample\x1b[24m\x1b[22m\x1b[39m');
    assert.strictEqual(underlineBoldCyan('sample'), '\x1b[4m\x1b[1m\x1b[36msample\x1b[24m\x1b[22m\x1b[39m');

    // 3. kleur.underline returns plain unformatted text when enabled is false
    setColorEnabled(false);
    assert.strictEqual(kleur.enabled, false);
    assert.strictEqual(kleur.underline('sample'), 'sample');
    assert.strictEqual(underline('sample'), 'sample');
    assert.strictEqual(underlineBoldCyan('sample'), 'sample');

    // 4. kleur.underline properly restores underline formatting when nesting styled strings
    setColorEnabled(true);
    const innerUnderline = kleur.underline('inner');
    const nested = kleur.underline(`outer ${innerUnderline} outer`);
    assert.strictEqual(nested, '\x1b[4mouter \x1b[4minner\x1b[24m\x1b[4m outer\x1b[24m');

    console.log('Contract tests passed successfully.');
  } finally {
    kleur.enabled = initialEnabled;
  }
}

testContract();