entities 6.0.1: encodeHTML

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.encodeHTML 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.encodeHTML

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:5e60efbff6e19e34e95dd5936fb264f8d3bb94c9ecd7cdeef66f4bec74c8479b","contract":["encodeHTML encodes HTML and XML markup characters into named entities","encodeHTML encodes ASCII punctuation characters that have named entities","encodeHTML encodes characters with equivalent named HTML entities","encodeHTML encodes code points without named entities as hexadecimal character references","encodeHTML preserves alphanumeric characters, whitespace, and empty strings","encodeHTML aliases encodeHTML4 and encodeHTML5 to identical implementations"],"goal":"verify entities.encodeHTML in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.encodeHTML"]},"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.encodeHTML"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-entities-encodehtml",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-encodehtml",
      "version": "1.0.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-encodehtml",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "entities": "6.0.1"
  }
}

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

import assert from 'node:assert/strict';
import { encodeHTML, encodeHTML4, encodeHTML5 } from 'entities';

// 1. encodeHTML encodes HTML and XML markup characters into named entities
assert.equal(
  encodeHTML('& < > " \''),
  '&amp; &lt; &gt; &quot; &apos;'
);

// 2. encodeHTML encodes ASCII punctuation characters that have named entities
assert.equal(
  encodeHTML('# / ( ) ; ='),
  '&num; &sol; &lpar; &rpar; &semi; &equals;'
);

// 3. encodeHTML encodes characters with equivalent named HTML entities
assert.equal(
  encodeHTML('© ® € £ ü ß'),
  '&copy; &circledR; &euro; &pound; &uuml; &szlig;'
);

// 4. encodeHTML encodes code points without named entities as hexadecimal character references
assert.equal(
  encodeHTML('😀 🎉'),
  '&#x1f600; &#x1f389;'
);

// 5. encodeHTML preserves alphanumeric characters, whitespace, and empty strings
assert.equal(
  encodeHTML('Hello World 123'),
  'Hello World 123'
);
assert.equal(
  encodeHTML(''),
  ''
);

// 6. encodeHTML aliases encodeHTML4 and encodeHTML5 to identical implementations
assert.equal(encodeHTML4, encodeHTML);
assert.equal(encodeHTML5, encodeHTML);

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