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

Use EXACTLY these public packages and versions:
  - pkg:npm/strip-literal@3.1.0
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:7531d1f03bab307639ec3f34d59dff70f6fa7cbf9394579108b7770140876f41","constraints":{"executionContext":"node"},"contract":["stripLiteral replaces comments with spaces to preserve line and character offsets","stripLiteral replaces string literals and template literal contents with whitespace while keeping quotes and interpolation delimiters","stripLiteral replaces stripped characters with a custom fillChar when specified","stripLiteral applies custom filter function to selectively strip or keep literal tokens","stripLiteralDetailed returns an object containing the stripped result string and the array of parsed tokens"],"goal":"verify pkg:npm/strip-literal@3.1.0","kind":"HOW","packages":["pkg:npm/strip-literal@3.1.0"],"schemaVersion":1,"symbols":["stripLiteral","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":["stripLiteral","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 pkg:npm/strip-literal@3.1.0",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "strip-literal": "3.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/strip-literal@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/strip-literal@3.1.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

'use strict';

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

/**
 * Strip comments and string literals from JavaScript/TypeScript source code.
 *
 * @param {string} code - Source code string
 * @param {object} [options] - Stripping options
 * @returns {string} Stripped code
 */
function removeLiterals(code, options) {
  return stripLiteral(code, options);
}

/**
 * Strip comments and string literals, returning stripped code and token list.
 *
 * @param {string} code - Source code string
 * @param {object} [options] - Stripping options
 * @returns {{ result: string, tokens: Array<object> }} Stripped code and token list
 */
function removeLiteralsWithTokens(code, options) {
  return stripLiteralDetailed(code, options);
}

module.exports = {
  stripLiteral,
  stripLiteralDetailed,
  stripLiteralJsTokens,
  removeLiterals,
  removeLiteralsWithTokens
};

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

const require = createRequire(import.meta.url);
const {
  stripLiteral,
  stripLiteralDetailed,
  stripLiteralJsTokens,
  removeLiterals,
  removeLiteralsWithTokens
} = 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 stripLiteralDetailed, 'function', 'stripLiteralDetailed must be exported as a function');
assert.equal(typeof stripLiteralJsTokens, 'function', 'stripLiteralJsTokens must be exported as a function');
assert.equal(stripLiteral, stripLiteralPkg.stripLiteral, 'stripLiteral must match library export');
assert.equal(stripLiteralDetailed, stripLiteralPkg.stripLiteralDetailed, 'stripLiteralDetailed must match library export');
assert.equal(stripLiteralJsTokens, stripLiteralDetailed, 'stripLiteralJsTokens must alias stripLiteralDetailed');

// 2. stripLiteral replaces comments with spaces to preserve line and character offsets
{
  const code = '// single-line comment\nconst a = 1; /* multi\nline */';
  const result = removeLiterals(code);
  const expected = ' '.repeat(22) + '\nconst a = 1; ' + ' '.repeat(8) + '\n' + ' '.repeat(7);
  assert.equal(result, expected, 'Comments must be replaced by whitespace while preserving line positions');
  assert.equal(result.length, code.length, 'Output length must match input length');
}

// 3. stripLiteral replaces string literals and template literal contents with whitespace while keeping quotes and interpolation delimiters
{
  const code = 'const msg = "hello world"; const tmpl = `count: ${val} items`;';
  const result = stripLiteral(code);
  const expected = 'const msg = "           "; const tmpl = `       ${val}      `;';
  assert.equal(result, expected, 'String and template literal bodies must be replaced by whitespace');
  assert.equal(result.length, code.length, 'Output length must match input length');
}

// 4. stripLiteral replaces stripped characters with a custom fillChar when specified
{
  const code = 'const key = "secret-token";';
  const result = stripLiteral(code, { fillChar: '*' });
  const expected = 'const key = "************";';
  assert.equal(result, expected, 'String literal body must be replaced with specified fill character');
  assert.equal(result.length, code.length, 'Output length must match input length');
}

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

// 6. stripLiteralDetailed returns an object containing the stripped result string and the array of parsed tokens
{
  const code = 'const greeting = "hi";';
  const detailed = removeLiteralsWithTokens(code);
  assert.equal(typeof detailed, 'object', 'stripLiteralDetailed must return an object');
  assert.equal(detailed.result, 'const greeting = "  ";');
  assert.ok(Array.isArray(detailed.tokens), 'tokens property must be an array');
  assert.ok(detailed.tokens.length > 0, 'tokens array must not be empty');

  // Verify token properties from js-tokens
  const stringToken = detailed.tokens.find((t) => t.type === 'StringLiteral');
  assert.ok(stringToken, 'Token list must include StringLiteral token');
  assert.equal(stringToken.value, '"hi"');
  assert.equal(stringToken.closed, true);
}

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