escape-string-regexp 2.0.0

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/escape-string-regexp@2.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/escape-string-regexp@2.0.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:c546f5693e6ef7dc03c2092d886f806a97b2376d8f6881e931aaf27f6b6c913c","constraints":{"executionContext":"node"},"contract":["escapeStringRegexp is a function that escapes regex special characters with backslashes","escapeStringRegexp escapes characters | \\ { } ( ) [ ] ^ $ + * ? . -","escaped string matches literally when used to construct RegExp","escapeStringRegexp throws TypeError when called with a non-string argument","escapeStringRegexp returns empty string unchanged when given empty string"],"goal":"verify pkg:npm/escape-string-regexp@2.0.0","kind":"HOW","packages":["pkg:npm/escape-string-regexp@2.0.0"],"schemaVersion":1},"contractCommand":["node","test/contract.js"],"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/escape-string-regexp@2.0.0"],"schemaVersion":1,"subject":"pkg:npm/escape-string-regexp@2.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-escape-string-regexp",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-escape-string-regexp",
      "version": "1.0.0",
      "dependencies": {
        "escape-string-regexp": "2.0.0"
      }
    },
    "node_modules/escape-string-regexp": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
      "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    }
  }
}

{
  "name": "sample-escape-string-regexp",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification sample for escape-string-regexp",
  "main": "src/index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "escape-string-regexp": "2.0.0"
  },
  "license": "MIT-0"
}

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

const escapeStringRegexp = require('escape-string-regexp');

function escapePattern(str) {
  return escapeStringRegexp(str);
}

function matchLiteral(text, pattern) {
  const escaped = escapeStringRegexp(pattern);
  const regex = new RegExp(escaped);
  return regex.test(text);
}

module.exports = {
  escapePattern,
  matchLiteral
};

const assert = require('node:assert');
const escapeStringRegexp = require('escape-string-regexp');
const { escapePattern, matchLiteral } = require('../src/index.js');

// 1. escapeStringRegexp is a function that escapes regex special characters with backslashes
assert.strictEqual(typeof escapeStringRegexp, 'function');
assert.strictEqual(escapeStringRegexp('foo.bar'), 'foo\\.bar');
assert.strictEqual(escapePattern('foo.bar'), 'foo\\.bar');

// 2. escapeStringRegexp escapes characters | \ { } ( ) [ ] ^ $ + * ? . -
const specialChars = '|\\{}()[].^$+*?-';
const escapedChars = escapeStringRegexp(specialChars);
assert.strictEqual(escapedChars, '\\|\\\\\\{\\}\\(\\)\\[\\]\\.\\^\\$\\+\\*\\?\\-');

const sentence = 'how much $ for a [unicorn]?';
assert.strictEqual(escapeStringRegexp(sentence), 'how much \\$ for a \\[unicorn\\]\\?');

// 3. escaped string matches literally when used to construct RegExp
const text = 'price is $10.00 [tax included]';
const query = '$10.00 [tax included]';
const regex = new RegExp(escapeStringRegexp(query));
assert.strictEqual(regex.test(text), true);
assert.strictEqual(matchLiteral(text, query), true);

const mismatchQuery = '$10.00 (tax included)';
assert.strictEqual(new RegExp(escapeStringRegexp(mismatchQuery)).test(text), false);
assert.strictEqual(matchLiteral(text, mismatchQuery), false);

// 4. escapeStringRegexp throws TypeError when called with a non-string argument
assert.throws(() => escapeStringRegexp(123), {
  name: 'TypeError',
  message: 'Expected a string'
});
assert.throws(() => escapeStringRegexp(null), {
  name: 'TypeError',
  message: 'Expected a string'
});
assert.throws(() => escapeStringRegexp(undefined), {
  name: 'TypeError',
  message: 'Expected a string'
});
assert.throws(() => escapeStringRegexp({}), {
  name: 'TypeError',
  message: 'Expected a string'
});
assert.throws(() => escapeStringRegexp(true), {
  name: 'TypeError',
  message: 'Expected a string'
});

// 5. escapeStringRegexp returns empty string unchanged when given empty string
assert.strictEqual(escapeStringRegexp(''), '');
assert.strictEqual(escapePattern(''), '');

console.log('Contract tests passed successfully.');