strip-literal 3.1.0: stripLiteral

audit=false
fund=false

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 strip-literal.stripLiteral in pkg:npm/strip-literal@3.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/strip-literal@3.1.0
Demonstrate these symbols/APIs:
  - strip-literal.stripLiteral

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:8ac6d6ee58667e9bd18753d8db74635b160e0bbff2e42d2df5338d8615cdda33","constraints":{"executionContext":"node"},"contract":["stripLiteral replaces single-line comments with whitespace while preserving line breaks and character positions","stripLiteral replaces multi-line comments with whitespace while preserving newlines and character positions","stripLiteral replaces string literal bodies with whitespace while preserving quotes","stripLiteral replaces template literal strings with whitespace while preserving interpolation expressions","stripLiteral replaces regular expression literals with whitespace while preserving slash delimiters and single flag","stripLiteral replaces stripped characters with a custom fillChar option","stripLiteral respects filter option to selectively retain string literals"],"goal":"verify strip-literal.stripLiteral in pkg:npm/strip-literal@3.1.0","kind":"HOW","packages":["pkg:npm/strip-literal@3.1.0"],"schemaVersion":1,"symbols":["strip-literal.stripLiteral"]},"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","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/strip-literal@3.1.0"],"schemaVersion":1,"subject":"pkg:npm/strip-literal@3.1.0","symbols":["strip-literal.stripLiteral"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-strip-literal",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-strip-literal",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "strip-literal": "3.1.0"
      }
    },
    "node_modules/js-tokens": {
      "version": "9.0.1",
      "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz",
      "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==",
      "license": "MIT"
    },
    "node_modules/strip-literal": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz",
      "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==",
      "license": "MIT",
      "dependencies": {
        "js-tokens": "^9.0.1"
      },
      "funding": {
        "url": "https://github.com/sponsors/antfu"
      }
    }
  }
}

{
  "name": "sample-strip-literal",
  "version": "1.0.0",
  "private": true,
  "description": "verify strip-literal.stripLiteral in pkg:npm/strip-literal@3.1.0",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "strip-literal": "3.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify strip-literal.stripLiteral in pkg:npm/strip-literal@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/strip-literal@3.1.0"
  ],
  "symbols": [
    "strip-literal.stripLiteral"
  ]
}

'use strict';

const { stripLiteral } = require('strip-literal');

/**
 * Strips comments and string literals from code while preserving positions.
 *
 * @param {string} code - Source code to strip
 * @param {object} [options] - Stripping options (fillChar, filter)
 * @returns {string} Code with literals stripped
 */
function stripCodeLiterals(code, options) {
  return stripLiteral(code, options);
}

module.exports = {
  stripLiteral,
  stripCodeLiterals
};

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

const require = createRequire(import.meta.url);
const { stripLiteral, stripCodeLiterals } = require('../src/index.js');
const stripLiteralPkg = require('strip-literal');

// 1. Export verification
assert.equal(typeof stripLiteral, 'function', 'stripLiteral must be exported as a function');
assert.equal(typeof stripCodeLiterals, 'function', 'stripCodeLiterals wrapper must be exported as a function');
assert.equal(stripLiteral, stripLiteralPkg.stripLiteral, 'stripLiteral must match package export');

// 2. stripLiteral replaces single-line comments with whitespace while preserving line breaks and character positions
{
  const code = '// single line comment\nconst x = 10;';
  const result = stripCodeLiterals(code);
  const expected = ' '.repeat(22) + '\nconst x = 10;';
  assert.equal(result, expected, 'single-line comment must be replaced with spaces');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 3. stripLiteral replaces multi-line comments with whitespace while preserving newlines and character positions
{
  const code = '/* first line\nsecond line */\nconst y = 20;';
  const result = stripLiteral(code);
  const expected = ' '.repeat(13) + '\n' + ' '.repeat(14) + '\nconst y = 20;';
  assert.equal(result, expected, 'multi-line comment must be replaced with spaces preserving newlines');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 4. stripLiteral replaces string literal bodies with whitespace while preserving quotes
{
  const code = 'const str = "hello world"; const ch = \'a\';';
  const result = stripLiteral(code);
  const expected = 'const str = "           "; const ch = \' \';';
  assert.equal(result, expected, 'string literal body must be replaced with whitespace preserving quotes');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 5. stripLiteral replaces template literal strings with whitespace while preserving interpolation expressions
{
  const code = 'const t = `prefix ${user} suffix`;';
  const result = stripLiteral(code);
  const expected = 'const t = `       ${user}       `;';
  assert.equal(result, expected, 'template literal body must be replaced with whitespace preserving expressions');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 6. stripLiteral replaces regular expression literals with whitespace while preserving slash delimiters and single flag
{
  const code = 'const regex = /pattern123/g;';
  const result = stripLiteral(code);
  const expected = 'const regex = /          /g;';
  assert.equal(result, expected, 'regex literal body must be replaced with whitespace preserving delimiter and flag');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 7. stripLiteral replaces stripped characters with a custom fillChar option
{
  const code = 'const token = "my-secret";';
  const result = stripLiteral(code, { fillChar: '_' });
  const expected = 'const token = "_________";';
  assert.equal(result, expected, 'fillChar must be used to replace stripped characters');
  assert.equal(result.length, code.length, 'length must be preserved');
}

// 8. stripLiteral respects filter option to selectively retain string literals
{
  const code = 'const a = "keep"; const b = "remove";';
  const result = stripLiteral(code, {
    filter: (literal) => literal === 'remove'
  });
  const expected = 'const a = "keep"; const b = "      ";';
  assert.equal(result, expected, 'filter option must selectively control stripping');
  assert.equal(result.length, code.length, 'length must be preserved');
}

console.log('Contract assertions passed.');