semver 5.7.2: valid

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.valid 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.valid
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:55ae0cad99fc14d1671da104fd27b2f76bf7042759d60f5dd6027af2f2e85bb0","constraints":{"executionContext":"node"},"contract":["valid returns normalized version string for standard semantic versions","valid strips leading v prefix","valid preserves prerelease tags while stripping build metadata","valid returns null for invalid version formats or non-version strings","valid supports loose mode to parse loose or prefixed versions"],"goal":"verify semver.valid in pkg:npm/semver@5.7.2","kind":"HOW","packages":["pkg:npm/semver@5.7.2"],"schemaVersion":1,"symbols":["semver.valid"]},"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.valid"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-semver-valid",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-semver-valid",
      "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-valid",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for semver.valid in semver@5.7.2",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "semver": "5.7.2"
  }
}

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

const semver = require('semver');

/**
 * Validates a semantic version string.
 * Returns the parsed and normalized version string if valid, or null if invalid.
 *
 * @param {string} version - The version string to validate.
 * @param {boolean|object} [loose=false] - Whether to allow loose parsing.
 * @returns {string|null} The normalized version string or null.
 */
function validateVersion(version, loose = false) {
  return semver.valid(version, loose);
}

/**
 * Checks whether a given string is a valid semantic version.
 *
 * @param {string} version - The version string to check.
 * @param {boolean|object} [loose=false] - Whether to allow loose parsing.
 * @returns {boolean} True if the version is valid, false otherwise.
 */
function isValidVersion(version, loose = false) {
  return semver.valid(version, loose) !== null;
}

module.exports = {
  semver,
  valid: semver.valid,
  validateVersion,
  isValidVersion
};

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

const require = createRequire(import.meta.url);
const {
  semver,
  valid,
  validateVersion,
  isValidVersion
} = require('../src/index.js');

async function runContractTests() {
  // 1. valid returns normalized version string for standard semantic versions
  assert.equal(typeof semver.valid, 'function', 'semver.valid must be a function');
  assert.equal(typeof valid, 'function', 'valid must be a function');
  assert.equal(valid('1.0.0'), '1.0.0', 'standard version 1.0.0 should be returned as 1.0.0');
  assert.equal(validateVersion('2.4.10'), '2.4.10', 'validateVersion helper should return normalized string');
  assert.equal(isValidVersion('0.1.0'), true, 'isValidVersion should return true for valid version');

  // 2. valid strips leading v prefix
  assert.equal(valid('v1.2.3'), '1.2.3', 'leading v should be stripped');
  assert.equal(valid('v0.0.1'), '0.0.1', 'leading v should be stripped on 0.0.1');
  assert.equal(validateVersion('v3.14.159'), '3.14.159', 'leading v should be stripped in helper');

  // 3. valid preserves prerelease tags while stripping build metadata
  assert.equal(valid('1.2.3-alpha.1'), '1.2.3-alpha.1', 'prerelease tag should be preserved');
  assert.equal(valid('2.0.0-rc.2'), '2.0.0-rc.2', 'rc prerelease tag should be preserved');
  assert.equal(valid('1.2.3+build.456'), '1.2.3', 'build metadata should be stripped');
  assert.equal(valid('1.2.3-beta.1+20130313144700'), '1.2.3-beta.1', 'prerelease preserved and build metadata stripped');

  // 4. valid returns null for invalid version formats or non-version strings
  assert.equal(valid('not-a-version'), null, 'invalid string should return null');
  assert.equal(valid('1.2'), null, 'incomplete version 1.2 should return null');
  assert.equal(valid('1.2.3.4'), null, 'four-part version should return null');
  assert.equal(valid(''), null, 'empty string should return null');
  assert.equal(valid(null), null, 'null input should return null');
  assert.equal(valid(undefined), null, 'undefined input should return null');
  assert.equal(valid(123), null, 'numeric input should return null');
  assert.equal(isValidVersion('invalid'), false, 'isValidVersion should return false for invalid string');

  // 5. valid supports loose mode to parse loose or prefixed versions
  assert.equal(valid('v 1.2.3', true), '1.2.3', 'loose mode should handle space after v');
  assert.equal(valid('v 1.2.3', false), null, 'strict mode should reject space after v');
  assert.equal(valid('v 2.0.0', { loose: true }), '2.0.0', 'loose mode via options object should work');
  assert.equal(validateVersion('v 3.0.0', true), '3.0.0', 'validateVersion helper should pass loose flag');
  assert.equal(isValidVersion('v 1.0.0', true), true, 'isValidVersion helper should support loose flag');

  console.log('All semver.valid contract tests passed successfully.');
}

runContractTests().catch((err) => {
  console.error('Contract test failure:', err);
  process.exit(1);
});