strip-json-comments 3.1.1: stripJsonComments

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 pkg:npm/strip-json-comments@3.1.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/strip-json-comments@3.1.1
Demonstrate these symbols/APIs:
  - stripJsonComments

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:7f39aa6599730c72bdae8ddc32e834e7d36ecaa8bf5de174e0f75d255e41963b","contract":["assert stripJsonComments removes single-line and multi-line comments from JSON string","assert stripJsonComments replaces comments with whitespace by default to preserve character offsets","assert stripJsonComments strips comments completely without whitespace when whitespace option is false","assert stripJsonComments preserves comment-like characters inside quoted string literals and handles escaped quotes","assert stripJsonComments throws TypeError when non-string input is provided"],"goal":"verify pkg:npm/strip-json-comments@3.1.1","kind":"HOW","packages":["pkg:npm/strip-json-comments@3.1.1"],"schemaVersion":1,"symbols":["stripJsonComments"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/strip-json-comments@3.1.1"],"schemaVersion":1,"subject":"pkg:npm/strip-json-comments@3.1.1","symbols":["stripJsonComments"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-strip-json-comments",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-strip-json-comments",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "strip-json-comments": "3.1.1"
      }
    },
    "node_modules/strip-json-comments": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
      "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    }
  }
}

{
  "name": "sample-strip-json-comments",
  "version": "1.0.0",
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "strip-json-comments": "3.1.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/strip-json-comments@3.1.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/strip-json-comments@3.1.1"
  ],
  "symbols": [
    "stripJsonComments"
  ]
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const stripJsonComments = require('strip-json-comments');

// 1. Removes single-line and multi-line comments from JSON string
const jsonWithComments = `{\n  // single line comment\n  "name": "csx",\n  /* multi\n     line\n     comment */\n  "active": true\n}`;
const stripped = stripJsonComments(jsonWithComments);
const parsed = JSON.parse(stripped);
assert.deepEqual(parsed, { name: 'csx', active: true });

// 2. Replaces comments with whitespace by default to preserve character offsets
const singleLine = '{\n  // comment\n  "key": "value"\n}';
const withWhitespace = stripJsonComments(singleLine);
assert.equal(withWhitespace, '{\n            \n  "key": "value"\n}');
assert.equal(withWhitespace.length, singleLine.length);

// 3. Strips comments completely without whitespace when whitespace option is false
const withoutWhitespace = stripJsonComments('/* comment */{"a": 1}// trailing', { whitespace: false });
assert.equal(withoutWhitespace, '{"a": 1}');
assert.deepEqual(JSON.parse(withoutWhitespace), { a: 1 });

// 4. Preserves comment-like characters inside quoted string literals and handles escaped quotes
const jsonWithUrl = '{"url": "https://example.com/api", "msg": "/* not a comment */ \\"// nested\\""}';
const preserved = stripJsonComments(jsonWithUrl);
assert.equal(preserved, jsonWithUrl);
assert.deepEqual(JSON.parse(preserved), {
  url: 'https://example.com/api',
  msg: '/* not a comment */ "// nested"'
});

// 5. Throws TypeError when non-string input is provided
assert.throws(
  () => stripJsonComments(123),
  (err) => err instanceof TypeError && /Expected argument `jsonString` to be a `string`/.test(err.message)
);
assert.throws(
  () => stripJsonComments(null),
  (err) => err instanceof TypeError
);
assert.throws(
  () => stripJsonComments({}),
  (err) => err instanceof TypeError
);