strip-literal 3.1.0: stripLiteralDetailed

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

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:fd8d22ec8759d5a237bd71fccbfd044873f4ad162da77806f8f27948f598201e","contract":["stripLiteralDetailed exports as a callable function and stripLiteralJsTokens is an exact alias","stripLiteralDetailed returns an object containing stripped result string and tokens array","stripLiteralDetailed preserves original string length and line offsets while blanking string bodies","stripLiteralDetailed replaces single-line and multi-line comments with whitespace preserving positions","stripLiteralDetailed replaces stripped literal characters with custom fillChar when configured","stripLiteralDetailed filter callback determines whether specific string literal tokens are stripped","stripLiteralDetailed returns structured js-tokens array with token type, value, and closed state"],"goal":"verify strip-literal.stripLiteralDetailed in pkg:npm/strip-literal@3.1.0","kind":"HOW","packages":["pkg:npm/strip-literal@3.1.0"],"schemaVersion":1,"symbols":["strip-literal.stripLiteralDetailed"]},"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.stripLiteralDetailed"],"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.stripLiteralDetailed 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.stripLiteralDetailed in pkg:npm/strip-literal@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/strip-literal@3.1.0"
  ],
  "symbols": [
    "strip-literal.stripLiteralDetailed"
  ]
}

'use strict';

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

/**
 * Strip comments and string literals, returning detailed breakdown of result and tokens.
 *
 * @param {string} code - Source code string to strip
 * @param {object} [options] - Stripping options (fillChar, filter)
 * @returns {{ result: string, tokens: Array<object> }} Stripped code and token list
 */
function stripWithDetails(code, options) {
  return stripLiteralDetailed(code, options);
}

module.exports = {
  stripLiteral,
  stripLiteralDetailed,
  stripLiteralJsTokens,
  stripWithDetails
};

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

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

// 1. stripLiteralDetailed exports as a callable function and stripLiteralJsTokens is an exact alias
assert.equal(typeof stripLiteralDetailed, 'function', 'stripLiteralDetailed must be a function');
assert.equal(typeof stripLiteralJsTokens, 'function', 'stripLiteralJsTokens must be a function');
assert.equal(stripLiteralDetailed, stripLiteralPkg.stripLiteralDetailed, 'stripLiteralDetailed must match library export');
assert.equal(stripLiteralJsTokens, stripLiteralDetailed, 'stripLiteralJsTokens must be an alias of stripLiteralDetailed');

// 2. stripLiteralDetailed returns an object containing stripped result string and tokens array
{
  const code = 'const greeting = "hello";';
  const detailed = stripWithDetails(code);
  assert.equal(typeof detailed, 'object', 'stripLiteralDetailed must return an object');
  assert.equal(typeof detailed.result, 'string', 'result property must be a string');
  assert.ok(Array.isArray(detailed.tokens), 'tokens property must be an array');
  assert.equal(detailed.result, 'const greeting = "     ";');
}

// 3. stripLiteralDetailed preserves original string length and line offsets while blanking string bodies
{
  const code = 'const str = "sample text"; const tmpl = `item: ${id}`;';
  const { result } = stripLiteralDetailed(code);
  assert.equal(result.length, code.length, 'Output length must match input length');
  assert.equal(result, 'const str = "           "; const tmpl = `      ${id}`;');
}

// 4. stripLiteralDetailed replaces single-line and multi-line comments with whitespace preserving positions
{
  const code = '// header comment\nconst count = /* inline */ 100;';
  const { result } = stripLiteralDetailed(code);
  const expected = ' '.repeat(17) + '\nconst count = ' + ' '.repeat(12) + ' 100;';
  assert.equal(result, expected, 'Comments must be replaced with whitespace preserving positions');
  assert.equal(result.length, code.length, 'Output length must match input length');
}

// 5. stripLiteralDetailed replaces stripped literal characters with custom fillChar when configured
{
  const code = 'const token = "secret123";';
  const { result } = stripLiteralDetailed(code, { fillChar: '#' });
  assert.equal(result, 'const token = "#########";', 'Stripped characters must use custom fill character');
  assert.equal(result.length, code.length, 'Output length must match input length');
}

// 6. stripLiteralDetailed filter callback determines whether specific string literal tokens are stripped
{
  const code = 'const a = "keep-me"; const b = "strip-me";';
  const { result } = stripLiteralDetailed(code, {
    filter: (tokenBody) => tokenBody.includes('strip')
  });
  assert.equal(result, 'const a = "keep-me"; const b = "        ";', 'Filter must conditionally preserve string literals');
}

// 7. stripLiteralDetailed returns structured js-tokens array with token type, value, and closed state
{
  const code = 'const msg = "world";';
  const { tokens } = stripLiteralDetailed(code);
  assert.ok(tokens.length > 0, 'tokens array must not be empty');
  const strTok = tokens.find((t) => t.type === 'StringLiteral');
  assert.ok(strTok, 'Token list must contain a StringLiteral token');
  assert.equal(strTok.value, '"world"', 'Token value must match the original literal text');
  assert.equal(strTok.closed, true, 'StringLiteral token must have closed boolean flag');
}

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