semver 5.7.2: clean

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 semver.clean in pkg:npm/semver@5.7.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/semver@5.7.2
Demonstrate these symbols/APIs:
  - semver.clean
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:60d6d096d3288d65a53b7183ed04f8cc7f5828c437b527e2d53c36d953aa2e79","constraints":{"executionContext":"node"},"contract":["semver.clean strips surrounding whitespace, equal signs, and v prefixes from a valid semantic version string","semver.clean retains prerelease identifiers but omits build metadata from the returned cleaned version","semver.clean returns null for invalid versions, range operators, wildcard versions, and non-empty strings with separated prefixes","semver.clean throws TypeError when passed non-string arguments","semver.clean accepts an optional loose boolean flag or options object","isCleanable helper safely returns boolean without throwing on invalid or non-string inputs"],"goal":"verify semver.clean in pkg:npm/semver@5.7.2","kind":"HOW","packages":["pkg:npm/semver@5.7.2"],"schemaVersion":1,"symbols":["semver.clean"]},"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/semver@5.7.2"],"schemaVersion":1,"subject":"pkg:npm/semver@5.7.2","symbols":["semver.clean"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-semver-clean",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-semver-clean",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "semver": "5.7.2"
      }
    },
    "node_modules/semver": {
      "version": "5.7.2",
      "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz",
      "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==",
      "license": "ISC",
      "bin": {
        "semver": "bin/semver"
      }
    }
  }
}

{
  "name": "sample-semver-clean",
  "version": "1.0.0",
  "private": true,
  "license": "MIT-0",
  "main": "src/index.js",
  "dependencies": {
    "semver": "5.7.2"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify semver.clean in pkg:npm/semver@5.7.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/semver@5.7.2"
  ],
  "symbols": [
    "semver.clean"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const semver = require('semver');

/**
 * Cleans a version string by stripping outer whitespace, 'v' prefixes, and leading '=' signs.
 * Returns the cleaned semantic version without build metadata, or null if unparseable.
 * Throws TypeError if version is not a string.
 *
 * @param {string} version - The raw version string to clean.
 * @param {boolean|object} [optionsOrLoose] - Options object or loose boolean flag.
 * @returns {string|null} The cleaned valid semantic version string, or null if invalid.
 */
function cleanVersion(version, optionsOrLoose) {
  return semver.clean(version, optionsOrLoose);
}

/**
 * Safely checks if a given input is a string that can be cleaned into a valid semantic version.
 *
 * @param {any} version - The version value to test.
 * @param {boolean|object} [optionsOrLoose] - Options object or loose boolean flag.
 * @returns {boolean} True if input is a string that cleans to a valid version, false otherwise.
 */
function isCleanable(version, optionsOrLoose) {
  if (typeof version !== 'string') {
    return false;
  }
  return semver.clean(version, optionsOrLoose) !== null;
}

module.exports = {
  clean: semver.clean,
  cleanVersion,
  isCleanable,
  semver
};

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

const require = createRequire(import.meta.url);
const semver = require('semver');
const { clean, cleanVersion, isCleanable } = require('../src/index.js');

// 1. Verify module exports and function identity
assert.equal(typeof clean, 'function', 'semver.clean must be a function');
assert.strictEqual(clean, semver.clean, 'clean export must match semver.clean exactly');
assert.equal(typeof cleanVersion, 'function', 'cleanVersion must be a function');
assert.equal(typeof isCleanable, 'function', 'isCleanable must be a function');

// 2. semver.clean strips surrounding whitespace, equal signs, and v prefixes from a valid semantic version string
assert.equal(semver.clean('1.2.3'), '1.2.3', 'clean should preserve standard semantic version');
assert.equal(semver.clean('  1.2.3  '), '1.2.3', 'clean should strip surrounding whitespace');
assert.equal(semver.clean('v1.2.3'), '1.2.3', 'clean should strip leading v prefix');
assert.equal(semver.clean('=1.2.3'), '1.2.3', 'clean should strip leading equal sign');
assert.equal(semver.clean('  =v1.2.3  '), '1.2.3', 'clean should strip combined whitespace, equal sign, and v prefix');
assert.equal(semver.clean('==1.2.3'), '1.2.3', 'clean should strip multiple equal signs');
assert.equal(semver.clean(' =v=1.2.3 '), '1.2.3', 'clean should strip interleaved equal and v prefixes');
assert.equal(cleanVersion('  =v2.5.0  '), '2.5.0', 'cleanVersion helper should return cleaned version string');

// 3. semver.clean retains prerelease identifiers but omits build metadata from the returned cleaned version
assert.equal(
  semver.clean('  =v1.2.3-alpha.1  '),
  '1.2.3-alpha.1',
  'clean should preserve prerelease identifier'
);
assert.equal(
  semver.clean('  =v1.2.3-beta.2+build.999  '),
  '1.2.3-beta.2',
  'clean should preserve prerelease identifier and omit build metadata'
);
assert.equal(
  semver.clean('1.0.0+20130313144700'),
  '1.0.0',
  'clean should omit standalone build metadata'
);
assert.equal(
  cleanVersion('  =v2.0.0-rc.1+sha.abcdef  '),
  '2.0.0-rc.1',
  'cleanVersion helper should return cleaned prerelease version without build metadata'
);

// 4. semver.clean returns null for invalid versions, range operators, wildcard versions, and non-empty strings with separated prefixes
assert.equal(semver.clean('^1.2.3'), null, 'clean should return null for caret range');
assert.equal(semver.clean('~1.2.3'), null, 'clean should return null for tilde range');
assert.equal(semver.clean('>=1.2.3'), null, 'clean should return null for comparison operator');
assert.equal(semver.clean('1.2.x'), null, 'clean should return null for wildcard version');
assert.equal(semver.clean('1.2'), null, 'clean should return null for partial 2-part version');
assert.equal(semver.clean('invalid-version'), null, 'clean should return null for non-version string');
assert.equal(semver.clean(''), null, 'clean should return null for empty string');
assert.equal(semver.clean(' = 1.2.3 '), null, 'clean should return null when space separates prefix from version');
assert.equal(semver.clean('v 1.2.3'), null, 'clean should return null when space separates v from version');

// 5. semver.clean throws TypeError when passed non-string arguments
assert.throws(
  () => semver.clean(null),
  (err) => err instanceof TypeError,
  'semver.clean must throw TypeError when called with null'
);
assert.throws(
  () => semver.clean(undefined),
  (err) => err instanceof TypeError,
  'semver.clean must throw TypeError when called with undefined'
);
assert.throws(
  () => semver.clean(123),
  (err) => err instanceof TypeError,
  'semver.clean must throw TypeError when called with a number'
);
assert.throws(
  () => semver.clean({}),
  (err) => err instanceof TypeError,
  'semver.clean must throw TypeError when called with an object'
);

// 6. semver.clean accepts an optional loose boolean flag or options object
assert.equal(
  semver.clean('  =v1.2.3  ', true),
  '1.2.3',
  'clean should accept boolean loose flag'
);
assert.equal(
  semver.clean('  =v1.2.3  ', { loose: true }),
  '1.2.3',
  'clean should accept options object with loose: true'
);
assert.equal(
  semver.clean('  =v1.2.3  ', { loose: false }),
  '1.2.3',
  'clean should accept options object with loose: false'
);

// 7. isCleanable helper safely returns boolean without throwing on invalid or non-string inputs
assert.equal(isCleanable(' =v1.0.0 '), true, 'isCleanable should return true for valid cleanable version');
assert.equal(isCleanable('^1.0.0'), false, 'isCleanable should return false for range string');
assert.equal(isCleanable('not-a-version'), false, 'isCleanable should return false for invalid string');
assert.equal(isCleanable(null), false, 'isCleanable should return false for null input without throwing');
assert.equal(isCleanable(undefined), false, 'isCleanable should return false for undefined input without throwing');
assert.equal(isCleanable(123), false, 'isCleanable should return false for numeric input without throwing');

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