strip-literal 3.1.0: stripLiteralJsTokens

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

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:bd097cc3172e4599fb2eef248f26e87218c336b2d7ca830d0f26695d9caf7804","contract":["stripLiteralJsTokens returns an object containing the stripped result string and parsed tokens array","stripLiteralJsTokens replaces comments with whitespace while preserving line positions and character count","stripLiteralJsTokens replaces string literals and template literal contents with whitespace while keeping enclosing quotes and delimiters","stripLiteralJsTokens replaces stripped characters with a custom fillChar when specified","stripLiteralJsTokens applies a custom filter function to selectively strip or keep string literals","stripLiteralJsTokens strips regular expression literals with up to one flag while keeping delimiters and flag","stripLiteralJsTokens leaves unclosed string literals unstripped in the result"],"goal":"verify strip-literal.stripLiteralJsTokens in pkg:npm/strip-literal@3.1.0","kind":"HOW","packages":["pkg:npm/strip-literal@3.1.0"],"schemaVersion":1,"symbols":["strip-literal.stripLiteralJsTokens"]},"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.stripLiteralJsTokens"],"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.stripLiteralJsTokens 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.stripLiteralJsTokens in pkg:npm/strip-literal@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/strip-literal@3.1.0"
  ],
  "symbols": [
    "strip-literal.stripLiteralJsTokens"
  ]
}

'use strict';

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

/**
 * Strip string literals and comments from JavaScript source code using js-tokens,
 * returning the stripped source string alongside the parsed token stream.
 *
 * @param {string} code - JavaScript source code to parse and strip
 * @param {object} [options] - Options controlling stripping behavior
 * @param {string} [options.fillChar] - Single character to replace stripped content with
 * @param {(tokenBody: string) => boolean} [options.filter] - Custom filter returning false to keep literal
 * @returns {{ result: string, tokens: Array<object> }} Stripped code and token list
 */
function removeLiteralsDetailed(code, options) {
  return stripLiteralJsTokens(code, options);
}

module.exports = {
  stripLiteralJsTokens,
  removeLiteralsDetailed
};

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

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

// 1. Export verification
assert.equal(typeof stripLiteralJsTokens, 'function', 'stripLiteralJsTokens must be exported as a function');
assert.equal(stripLiteralJsTokens, stripLiteralPkg.stripLiteralJsTokens, 'stripLiteralJsTokens must match library export');
assert.equal(typeof removeLiteralsDetailed, 'function', 'removeLiteralsDetailed must be exported as a function');

// 2. stripLiteralJsTokens returns an object containing the stripped result string and parsed tokens array
{
  const code = 'const greeting = "hello";';
  const detailed = removeLiteralsDetailed(code);
  assert.equal(typeof detailed, 'object', 'stripLiteralJsTokens must return an object');
  assert.equal(typeof detailed.result, 'string', 'result property must be a string');
  assert.equal(detailed.result, 'const greeting = "     ";', 'string literal body must be replaced with spaces');
  assert.ok(Array.isArray(detailed.tokens), 'tokens property must be an array');
  assert.ok(detailed.tokens.length > 0, 'tokens array must not be empty');

  const strToken = detailed.tokens.find((t) => t.type === 'StringLiteral');
  assert.ok(strToken, 'tokens must contain StringLiteral token');
  assert.equal(strToken.value, '"hello"');
  assert.equal(strToken.closed, true);
}

// 3. stripLiteralJsTokens replaces comments with whitespace while preserving line positions and character count
{
  const code = '// single-line comment\nconst a = 1; /* multi\nline */';
  const detailed = stripLiteralJsTokens(code);
  const expected = ' '.repeat(22) + '\nconst a = 1; ' + ' '.repeat(8) + '\n' + ' '.repeat(7);
  assert.equal(detailed.result, expected, 'comments must be replaced with whitespace preserving line positions');
  assert.equal(detailed.result.length, code.length, 'output length must match input length');
}

// 4. stripLiteralJsTokens replaces string literals and template literal contents with whitespace while keeping enclosing quotes and delimiters
{
  const code = 'const msg = "hello world"; const tmpl = `count: ${val} items`;';
  const detailed = stripLiteralJsTokens(code);
  const expected = 'const msg = "           "; const tmpl = `       ${val}      `;';
  assert.equal(detailed.result, expected, 'string and template literal contents must be replaced with whitespace');
  assert.equal(detailed.result.length, code.length, 'output length must match input length');
}

// 5. stripLiteralJsTokens replaces stripped characters with a custom fillChar when specified
{
  const code = 'const key = "secret-token";';
  const detailed = stripLiteralJsTokens(code, { fillChar: '*' });
  const expected = 'const key = "************";';
  assert.equal(detailed.result, expected, 'string literal body must be replaced with fillChar');
  assert.equal(detailed.result.length, code.length, 'output length must match input length');
}

// 6. stripLiteralJsTokens applies a custom filter function to selectively strip or keep string literals
{
  const code = 'const a = "keep-this"; const b = "strip-this";';
  const detailed = stripLiteralJsTokens(code, {
    filter: (tokenBody) => tokenBody.includes('strip')
  });
  const expected = 'const a = "keep-this"; const b = "          ";';
  assert.equal(detailed.result, expected, 'filter function must determine which string literals are stripped');
}

// 7. stripLiteralJsTokens strips regular expression literals with up to one flag while keeping delimiters and flag
{
  const code = 'const re = /pattern[0-9]+/g;';
  const detailed = stripLiteralJsTokens(code, { fillChar: '*' });
  const expected = 'const re = /' + '*'.repeat('pattern[0-9]+'.length) + '/g;';
  assert.equal(detailed.result, expected, 'regex pattern body must be replaced with fillChar');
}

// 8. stripLiteralJsTokens leaves unclosed string literals unstripped in the result
{
  const code = 'const unclosed = "unterminated string';
  const detailed = stripLiteralJsTokens(code);
  assert.equal(detailed.result, code, 'unclosed string literal must not be modified');
}

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