semver 6.3.1: 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@6.3.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/semver@6.3.1
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:f28be1e04e3469a3bdba9808bde36a1ad64f3c1a4b424581106fe5a12f610734","constraints":{"executionContext":"node"},"contract":["semver.clean strips leading v and equal prefixes with surrounding whitespace from standard version string","semver.clean preserves prerelease identifier while stripping leading prefixes","semver.clean strips build metadata and returns normalized version","semver.clean returns unchanged trimmed version string when already normalized","semver.clean returns null for invalid non-semver strings or empty strings","semver.clean returns null for range and comparison operators","semver.clean parses loose version formats when loose option is enabled","semver.clean throws TypeError when version argument is null or undefined"],"goal":"verify semver.clean in pkg:npm/semver@6.3.1","kind":"HOW","packages":["pkg:npm/semver@6.3.1"],"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@6.3.1"],"schemaVersion":1,"subject":"pkg:npm/semver@6.3.1","symbols":["semver.clean"],"verifierAdapter":"node-typescript@1"}

import semver from 'semver';

/**
 * Cleans a version string by removing leading 'v' or '=' characters and whitespace.
 * @param {string} version
 * @param {boolean|import('semver').Options} [options]
 * @returns {string|null}
 */
export function cleanVersion(version, options) {
  return semver.clean(version, options);
}

/**
 * Checks if a version string can be cleaned into a valid semantic version.
 * @param {string} version
 * @param {boolean|import('semver').Options} [options]
 * @returns {boolean}
 */
export function isCleanable(version, options) {
  return semver.clean(version, options) !== null;
}

export { semver };
export default semver;

{
  "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": "6.3.1"
      }
    },
    "node_modules/semver": {
      "version": "6.3.1",
      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
      "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
      "license": "ISC",
      "bin": {
        "semver": "bin/semver.js"
      }
    }
  }
}

{
  "name": "sample-semver-clean",
  "version": "1.0.0",
  "description": "Verify semver.clean in pkg:npm/semver@6.3.1",
  "main": "index.mjs",
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "semver": "6.3.1"
  },
  "license": "MIT-0"
}

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

import assert from 'node:assert/strict';
import semver from 'semver';
import { cleanVersion, isCleanable } from '../index.mjs';

// 1. semver.clean strips leading 'v' and '=' prefixes with surrounding whitespace from standard version string
{
  assert.equal(semver.clean('  =v1.2.3  '), '1.2.3');
  assert.equal(semver.clean(' =1.2.3 '), '1.2.3');
  assert.equal(semver.clean('v1.2.3'), '1.2.3');
  assert.equal(cleanVersion('  =v1.2.3  '), '1.2.3');
  assert.equal(isCleanable('  =v1.2.3  '), true);
}

// 2. semver.clean preserves prerelease identifier while stripping leading prefixes
{
  const input = '  =v1.2.3-beta.1  ';
  const expected = '1.2.3-beta.1';
  assert.equal(semver.clean(input), expected);
  assert.equal(cleanVersion(input), expected);
}

// 3. semver.clean strips build metadata and returns normalized version
{
  assert.equal(semver.clean('1.2.3+build.456'), '1.2.3');
  assert.equal(semver.clean('  =v1.2.3-beta.1+20200101  '), '1.2.3-beta.1');
  assert.equal(cleanVersion('1.2.3+build.456'), '1.2.3');
}

// 4. semver.clean returns unchanged trimmed version string when already normalized
{
  assert.equal(semver.clean('1.2.3'), '1.2.3');
  assert.equal(semver.clean('  2.0.0  '), '2.0.0');
  assert.equal(cleanVersion('1.2.3'), '1.2.3');
}

// 5. semver.clean returns null for invalid non-semver strings or empty strings
{
  assert.equal(semver.clean('not-a-version'), null);
  assert.equal(semver.clean('1.2.3.4'), null);
  assert.equal(semver.clean(''), null);
  assert.equal(isCleanable('not-a-version'), false);
  assert.equal(isCleanable(''), false);
}

// 6. semver.clean returns null for range and comparison operators
{
  assert.equal(semver.clean('~1.2.3'), null);
  assert.equal(semver.clean('^1.2.3'), null);
  assert.equal(semver.clean('>=1.2.3'), null);
  assert.equal(semver.clean('>1.0.0'), null);
  assert.equal(isCleanable('^1.2.3'), false);
}

// 7. semver.clean parses loose version formats when loose option is enabled
{
  assert.equal(semver.clean(' =v1.2.3b1 ', { loose: true }), '1.2.3-b1');
  assert.equal(semver.clean(' =v1.2.3b1 ', true), '1.2.3-b1');
  assert.equal(semver.clean(' =v1.2.3b1 '), null);
  assert.equal(semver.clean('01.02.03', { loose: true }), '1.2.3');
}

// 8. semver.clean throws TypeError when version argument is null or undefined
{
  assert.throws(
    () => semver.clean(null),
    {
      name: 'TypeError'
    }
  );
  assert.throws(
    () => semver.clean(undefined),
    {
      name: 'TypeError'
    }
  );
}

console.log('All semver.clean contract tests passed.');