ansi-styles 6.2.3: modifierNames

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 ansi-styles.modifierNames in pkg:npm/ansi-styles@6.2.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/ansi-styles@6.2.3
Demonstrate these symbols/APIs:
  - ansi-styles.modifierNames

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:d32c7406741e8f5cc5b9f1895af623ca41c3a7fbff86cb0193aa6381f1af96d2","contract":["modifierNames is an array containing all standard ANSI style modifier names: reset, bold, dim, italic, underline, overline, inverse, hidden, and strikethrough","each name in modifierNames corresponds to an entry in ansiStyles.modifier with valid open and close ANSI escape sequences","each name in modifierNames is also accessible directly on the root ansiStyles object","isValidModifier correctly checks whether a string is a recognized modifier name in modifierNames","formatWithModifier wraps input text with the open and close ANSI escape sequences for the specified modifier name and throws on invalid modifiers"],"goal":"verify ansi-styles.modifierNames in pkg:npm/ansi-styles@6.2.3","kind":"HOW","packages":["pkg:npm/ansi-styles@6.2.3"],"schemaVersion":1,"symbols":["ansi-styles.modifierNames"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/ansi-styles@6.2.3"],"schemaVersion":1,"subject":"pkg:npm/ansi-styles@6.2.3","symbols":["ansi-styles.modifierNames"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-ansi-styles-modifier-names",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-ansi-styles-modifier-names",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "ansi-styles": "6.2.3"
      }
    },
    "node_modules/ansi-styles": {
      "version": "6.2.3",
      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz",
      "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==",
      "license": "MIT",
      "engines": {
        "node": ">=12"
      },
      "funding": {
        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
      }
    }
  }
}

{
  "name": "sample-ansi-styles-modifier-names",
  "version": "1.0.0",
  "private": true,
  "description": "verify ansi-styles.modifierNames in pkg:npm/ansi-styles@6.2.3",
  "type": "module",
  "main": "src/index.mjs",
  "license": "MIT-0",
  "dependencies": {
    "ansi-styles": "6.2.3"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify ansi-styles.modifierNames in pkg:npm/ansi-styles@6.2.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/ansi-styles@6.2.3"
  ],
  "symbols": [
    "ansi-styles.modifierNames"
  ]
}

import ansiStyles, { modifierNames } from 'ansi-styles';

/**
 * Returns the list of all supported ANSI modifier names.
 *
 * @returns {string[]} Array of modifier names.
 */
export function getModifierNames() {
  return modifierNames;
}

/**
 * Checks if a given name is a valid ANSI modifier name.
 *
 * @param {string} name - Modifier name to check.
 * @returns {boolean} True if the modifier name exists in modifierNames.
 */
export function isValidModifier(name) {
  return modifierNames.includes(name);
}

/**
 * Wraps text with the specified ANSI modifier escape codes.
 *
 * @param {string} modifierName - The modifier name (e.g. 'bold', 'dim', 'underline').
 * @param {string} text - Text to format.
 * @returns {string} Formatted text with ANSI escape codes.
 */
export function formatWithModifier(modifierName, text) {
  if (!isValidModifier(modifierName)) {
    throw new Error(`Unknown modifier: ${modifierName}`);
  }
  const modifier = ansiStyles.modifier[modifierName];
  return `${modifier.open}${text}${modifier.close}`;
}

export { modifierNames, ansiStyles };
export default ansiStyles;

import assert from 'node:assert/strict';
import ansiStyles, {
  modifierNames,
  getModifierNames,
  isValidModifier,
  formatWithModifier,
} from '../src/index.mjs';

// 1. modifierNames is an array containing all standard ANSI style modifier names
{
  assert.ok(Array.isArray(modifierNames), 'modifierNames should be an array');
  const expectedModifiers = [
    'reset',
    'bold',
    'dim',
    'italic',
    'underline',
    'overline',
    'inverse',
    'hidden',
    'strikethrough',
  ];
  assert.deepStrictEqual(modifierNames, expectedModifiers, 'modifierNames must match expected standard modifiers');
  assert.deepStrictEqual(getModifierNames(), expectedModifiers, 'getModifierNames must return the modifierNames array');
}

// 2. each name in modifierNames corresponds to an entry in ansiStyles.modifier with valid open and close ANSI escape sequences
{
  for (const name of modifierNames) {
    const mod = ansiStyles.modifier[name];
    assert.ok(mod, `ansiStyles.modifier.${name} must exist`);
    assert.ok(typeof mod.open === 'string', `ansiStyles.modifier.${name}.open must be a string`);
    assert.ok(typeof mod.close === 'string', `ansiStyles.modifier.${name}.close must be a string`);
    assert.ok(mod.open.startsWith('\u001B['), `ansiStyles.modifier.${name}.open must start with escape code`);
    assert.ok(mod.open.endsWith('m'), `ansiStyles.modifier.${name}.open must end with 'm'`);
    assert.ok(mod.close.startsWith('\u001B['), `ansiStyles.modifier.${name}.close must start with escape code`);
    assert.ok(mod.close.endsWith('m'), `ansiStyles.modifier.${name}.close must end with 'm'`);
  }
}

// 3. each name in modifierNames is also accessible directly on the root ansiStyles object
{
  for (const name of modifierNames) {
    const directMod = ansiStyles[name];
    assert.ok(directMod, `ansiStyles.${name} must exist directly on root styles object`);
    assert.strictEqual(directMod.open, ansiStyles.modifier[name].open, `ansiStyles.${name}.open should match ansiStyles.modifier.${name}.open`);
    assert.strictEqual(directMod.close, ansiStyles.modifier[name].close, `ansiStyles.${name}.close should match ansiStyles.modifier.${name}.close`);
  }
}

// 4. isValidModifier correctly checks whether a string is a recognized modifier name in modifierNames
{
  assert.strictEqual(isValidModifier('bold'), true);
  assert.strictEqual(isValidModifier('underline'), true);
  assert.strictEqual(isValidModifier('strikethrough'), true);
  assert.strictEqual(isValidModifier('nonExistentModifier'), false);
  assert.strictEqual(isValidModifier('red'), false);
  assert.strictEqual(isValidModifier(''), false);
}

// 5. formatWithModifier wraps input text with the open and close ANSI escape sequences for the specified modifier name and throws on invalid modifiers
{
  const boldText = formatWithModifier('bold', 'hello');
  assert.strictEqual(boldText, `${ansiStyles.bold.open}hello${ansiStyles.bold.close}`);

  const italicText = formatWithModifier('italic', 'world');
  assert.strictEqual(italicText, `${ansiStyles.italic.open}world${ansiStyles.italic.close}`);

  assert.throws(
    () => formatWithModifier('invalidStyle', 'test'),
    /Unknown modifier: invalidStyle/,
    'formatWithModifier must throw on unknown modifier'
  );
}

console.log('All ansi-styles.modifierNames contract assertions passed successfully.');