entities 6.0.1: encodeNonAsciiHTML

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

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:993422f1a48c71dd18ff3ac27630fe70d628d2c3c5fa9e601f996180b9474ca5","contract":["entities.encodeNonAsciiHTML encodes non-ASCII unicode characters into HTML named entities","entities.encodeNonAsciiHTML preserves valid HTML ASCII characters like hashes and alphanumeric text","entities.encodeNonAsciiHTML encodes HTML special characters into named entities","entities.encodeNonAsciiHTML encodes non-ASCII characters without named entities into hexadecimal numeric references","entities.encodeNonAsciiHTML handles empty string and plain ASCII text without modification"],"goal":"verify entities.encodeNonAsciiHTML in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.encodeNonAsciiHTML"]},"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/entities@6.0.1"],"schemaVersion":1,"subject":"pkg:npm/entities@6.0.1","symbols":["entities.encodeNonAsciiHTML"],"verifierAdapter":"node-typescript@1"}

const { encodeNonAsciiHTML } = require('entities');

/**
 * Encodes non-ASCII characters and characters not valid in HTML documents.
 * Preserves ASCII characters valid in HTML documents (e.g. '#', alphanumeric).
 *
 * @param {string} input - Input text to encode.
 * @returns {string} Encoded HTML string.
 */
function encodeNonAscii(input) {
  return encodeNonAsciiHTML(input);
}

module.exports = {
  encodeNonAscii,
  encodeNonAsciiHTML,
};

{
  "name": "sample-entities-encode-non-ascii-html",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-encode-non-ascii-html",
      "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"
      }
    }
  }
}

{
  "name": "sample-entities-encode-non-ascii-html",
  "version": "1.0.0",
  "description": "Clean-room sample verifying entities.encodeNonAsciiHTML in pkg:npm/entities@6.0.1",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "entities": "6.0.1"
  }
}

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

import assert from 'node:assert';
import { encodeNonAsciiHTML } from 'entities';
import { encodeNonAscii } from '../index.js';

// 1. entities.encodeNonAsciiHTML encodes non-ASCII unicode characters into HTML named entities
const accented = encodeNonAscii('café & résumé');
assert.strictEqual(
  accented,
  'café & résumé',
  'entities.encodeNonAsciiHTML encodes non-ASCII unicode characters into HTML named entities'
);

const symbols = encodeNonAsciiHTML('© 2026 €');
assert.strictEqual(
  symbols,
  '© 2026 €',
  'entities.encodeNonAsciiHTML encodes currency and copyright symbols into named entities'
);

// 2. entities.encodeNonAsciiHTML preserves valid HTML ASCII characters like hashes and alphanumeric text
const validAscii = encodeNonAsciiHTML('#section-1?a=1+2');
assert.strictEqual(
  validAscii,
  '#section-1?a=1+2',
  'entities.encodeNonAsciiHTML preserves valid HTML ASCII characters like hashes and alphanumeric text'
);

// 3. entities.encodeNonAsciiHTML encodes HTML special characters into named entities
const htmlTags = encodeNonAsciiHTML('<div class="note">it\'s & that</div>');
assert.strictEqual(
  htmlTags,
  '&lt;div class=&quot;note&quot;&gt;it&apos;s &amp; that&lt;/div&gt;',
  'entities.encodeNonAsciiHTML encodes HTML special characters into named entities'
);

// 4. entities.encodeNonAsciiHTML encodes non-ASCII characters without named entities into hexadecimal numeric references
const emoji = encodeNonAsciiHTML('\u{1F600}');
assert.strictEqual(
  emoji,
  '&#x1f600;',
  'entities.encodeNonAsciiHTML encodes emoji into hexadecimal numeric references'
);

const cjk = encodeNonAsciiHTML('世界');
assert.strictEqual(
  cjk,
  '&#x4e16;&#x754c;',
  'entities.encodeNonAsciiHTML encodes non-Latin characters into hexadecimal numeric references'
);

// 5. entities.encodeNonAsciiHTML handles empty string and plain ASCII text without modification
const empty = encodeNonAsciiHTML('');
assert.strictEqual(
  empty,
  '',
  'entities.encodeNonAsciiHTML returns empty string unmodified'
);

const plain = encodeNonAsciiHTML('hello world 123');
assert.strictEqual(
  plain,
  'hello world 123',
  'entities.encodeNonAsciiHTML preserves standard ASCII text'
);

console.log('All contract assertions passed.');