entities 6.0.1: escapeText

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 entities.escapeText in pkg:npm/entities@6.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/entities@6.0.1
Demonstrate these symbols/APIs:
  - entities.escapeText

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:7bcd6845aaef84c071cfb9e6d821178d3925d4c9f6a926e97ca0a2175a81d7d8","contract":["entities.escapeText is exported as a function","entities.escapeText encodes ampersand, less-than, greater-than, and non-breaking space characters into HTML entities","entities.escapeText preserves single and double quotation marks unescaped","entities.escapeText preserves text without escapable characters unchanged","entities.escapeText correctly handles empty strings and consecutive escapable characters"],"goal":"verify entities.escapeText in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.escapeText"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"subject":"pkg:npm/entities@6.0.1","symbols":["entities.escapeText"],"verifierAdapter":"node-typescript@1"}

import { escapeText } from 'entities';

/**
 * Escapes HTML text special characters (&, <, >, and \u00A0) using entities.escapeText.
 *
 * @param {string} text - The input string to escape.
 * @returns {string} The HTML text-escaped string.
 */
export function escapeHtmlText(text) {
  return escapeText(text);
}

export { escapeText };
export default { escapeText, escapeHtmlText };

{
  "name": "sample-entities-escape-text",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-escape-text",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "entities": "6.0.1"
      }
    },
    "node_modules/entities": {
      "version": "6.0.1",
      "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz",
      "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==",
      "license": "BSD-2-Clause",
      "engines": {
        "node": ">=0.12"
      },
      "funding": {
        "url": "https://github.com/fb55/entities?sponsor=1"
      }
    }
  }
}

{
  "name": "sample-entities-escape-text",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for entities@6.0.1",
  "type": "module",
  "main": "index.mjs",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "license": "MIT-0",
  "dependencies": {
    "entities": "6.0.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify entities.escapeText in pkg:npm/entities@6.0.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/entities@6.0.1"
  ],
  "symbols": [
    "entities.escapeText"
  ]
}

import assert from 'node:assert/strict';
import * as entities from 'entities';
import { escapeText } from '../index.mjs';

// 1. entities.escapeText is exported as a function
{
  assert.equal(typeof entities.escapeText, 'function', 'entities.escapeText should be a function');
  assert.equal(typeof escapeText, 'function', 'local export escapeText should be a function');
  assert.equal(entities.escapeText, escapeText, 'local export should re-export entities.escapeText');
}

// 2. entities.escapeText encodes ampersand, less-than, greater-than, and non-breaking space characters into HTML entities
{
  assert.equal(escapeText('&'), '&', '& should escape to &');
  assert.equal(escapeText('<'), '&lt;', '< should escape to &lt;');
  assert.equal(escapeText('>'), '&gt;', '> should escape to &gt;');
  assert.equal(escapeText('\u00A0'), '&nbsp;', '\\u00A0 should escape to &nbsp;');
  assert.equal(
    escapeText('Tom & Jerry <cartoon> \u00A0 2024'),
    'Tom &amp; Jerry &lt;cartoon&gt; &nbsp; 2024',
    'mixed text with multiple escapables should be escaped correctly'
  );
}

// 3. entities.escapeText preserves single and double quotation marks unescaped
{
  assert.equal(escapeText('"quotes"'), '"quotes"', 'double quotes should not be escaped');
  assert.equal(escapeText("'single'"), "'single'", 'single quotes should not be escaped');
  assert.equal(
    escapeText('<div class="main" data-id=\'1\'>&content</div>'),
    '&lt;div class="main" data-id=\'1\'&gt;&amp;content&lt;/div&gt;',
    'attributes with quotes should leave quotes unescaped while escaping tags and ampersands'
  );
}

// 4. entities.escapeText preserves text without escapable characters unchanged
{
  assert.equal(escapeText('Hello, world! 12345'), 'Hello, world! 12345');
  assert.equal(escapeText('Unicode text: 안녕하세요, Grüße, café'), 'Unicode text: 안녕하세요, Grüße, café');
  assert.equal(escapeText('/path/to/file?query=value#fragment'), '/path/to/file?query=value#fragment');
}

// 5. entities.escapeText correctly handles empty strings and consecutive escapable characters
{
  assert.equal(escapeText(''), '', 'empty string should return empty string');
  assert.equal(
    escapeText('<<<>>>&&&\u00A0\u00A0'),
    '&lt;&lt;&lt;&gt;&gt;&gt;&amp;&amp;&amp;&nbsp;&nbsp;',
    'consecutive special characters should all be escaped'
  );
  assert.equal(
    escapeText('&<>\u00A0'),
    '&amp;&lt;&gt;&nbsp;',
    'adjacent distinct escapable characters should all be converted'
  );
}

console.log('All entities.escapeText contract tests passed successfully.');