semver 6.3.1: eq

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.eq 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.eq

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:b636f612368c0226dd439205930a53b213397f1c266c1e63001216fe0dc9236b","constraints":{"executionContext":"node"},"contract":["semver.eq returns true for identical semantic version strings","semver.eq returns true when comparing versions with leading v prefix","semver.eq returns true when versions differ only by build metadata","semver.eq returns false for different major, minor, or patch versions","semver.eq returns false when prerelease identifiers differ","semver.eq returns true for SemVer class instances with identical versions","semver.eq parses equals-prefixed version strings when loose mode is enabled","semver.eq throws TypeError when an invalid version string is passed","semver.eq throws TypeError when non-string or null arguments are passed"],"goal":"verify semver.eq in pkg:npm/semver@6.3.1","kind":"HOW","packages":["pkg:npm/semver@6.3.1"],"schemaVersion":1,"symbols":["semver.eq"]},"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/semver@6.3.1"],"schemaVersion":1,"subject":"pkg:npm/semver@6.3.1","symbols":["semver.eq"],"verifierAdapter":"node-typescript@1"}

const semver = require('semver');

/**
 * Compares two semantic version strings or SemVer instances for equality.
 *
 * @param {string|semver.SemVer} v1 - First version to compare.
 * @param {string|semver.SemVer} v2 - Second version to compare.
 * @param {boolean|object} [options] - Optional loose mode flag or options object.
 * @returns {boolean} True if versions are logically equal according to SemVer 2.0.0.
 */
function areVersionsEqual(v1, v2, options) {
  return semver.eq(v1, v2, options);
}

module.exports = {
  areVersionsEqual,
  eq: semver.eq,
};

{
  "name": "sample-semver-eq",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-semver-eq",
      "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-eq",
  "version": "1.0.0",
  "private": true,
  "description": "Verify semver.eq in pkg:npm/semver@6.3.1",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "semver": "6.3.1"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify semver.eq in pkg:npm/semver@6.3.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/semver@6.3.1"
  ],
  "symbols": [
    "semver.eq"
  ]
}

const assert = require('node:assert');
const semver = require('semver');
const { areVersionsEqual, eq } = require('../index.js');

// 1. semver.eq returns true for identical semantic version strings
{
  assert.strictEqual(areVersionsEqual('1.2.3', '1.2.3'), true, 'identical versions should be equal');
  assert.strictEqual(eq('0.0.1', '0.0.1'), true, 'identical patch versions should be equal');
  assert.strictEqual(semver.eq('2.10.5', '2.10.5'), true, 'direct semver.eq call should be equal');
}

// 2. semver.eq returns true when comparing versions with leading 'v' prefix
{
  assert.strictEqual(areVersionsEqual('v1.2.3', '1.2.3'), true, 'leading v prefix on first argument');
  assert.strictEqual(areVersionsEqual('1.2.3', 'v1.2.3'), true, 'leading v prefix on second argument');
  assert.strictEqual(areVersionsEqual('v1.2.3', 'v1.2.3'), true, 'leading v prefix on both arguments');
}

// 3. semver.eq returns true when versions differ only by build metadata
{
  assert.strictEqual(areVersionsEqual('1.0.0+build1', '1.0.0+build2'), true, 'build metadata is ignored in equality');
  assert.strictEqual(areVersionsEqual('1.2.3-alpha.1+001', '1.2.3-alpha.1+002'), true, 'build metadata ignored with prerelease');
}

// 4. semver.eq returns false for different major, minor, or patch versions
{
  assert.strictEqual(areVersionsEqual('1.2.3', '1.2.4'), false, 'different patch version');
  assert.strictEqual(areVersionsEqual('1.2.3', '1.3.3'), false, 'different minor version');
  assert.strictEqual(areVersionsEqual('1.2.3', '2.2.3'), false, 'different major version');
}

// 5. semver.eq returns false when prerelease identifiers differ
{
  assert.strictEqual(areVersionsEqual('1.0.0-alpha', '1.0.0-beta'), false, 'different prerelease names');
  assert.strictEqual(areVersionsEqual('1.0.0-alpha.1', '1.0.0-alpha.2'), false, 'different prerelease numeric ids');
  assert.strictEqual(areVersionsEqual('1.0.0-alpha', '1.0.0'), false, 'prerelease vs release');
}

// 6. semver.eq returns true for SemVer class instances with identical versions
{
  const s1 = new semver.SemVer('1.2.3');
  const s2 = new semver.SemVer('1.2.3');
  assert.strictEqual(areVersionsEqual(s1, s2), true, 'two SemVer instances with same version');
  assert.strictEqual(areVersionsEqual(s1, '1.2.3'), true, 'SemVer instance and matching string');
}

// 7. semver.eq parses equals-prefixed version strings when loose mode is enabled
{
  assert.strictEqual(areVersionsEqual('=1.2.3', '1.2.3', true), true, 'loose mode boolean true handles equal prefix');
  assert.strictEqual(areVersionsEqual('=1.2.3', '1.2.3', { loose: true }), true, 'loose mode object handles equal prefix');
  assert.throws(
    () => areVersionsEqual('=1.2.3', '1.2.3', false),
    /Invalid Version: =1.2.3/,
    'non-loose mode throws on equal prefix'
  );
}

// 8. semver.eq throws TypeError when an invalid version string is passed
{
  assert.throws(
    () => areVersionsEqual('invalid', '1.2.3'),
    /Invalid Version: invalid/,
    'throws on invalid v1'
  );
  assert.throws(
    () => areVersionsEqual('1.2.3', 'invalid'),
    /Invalid Version: invalid/,
    'throws on invalid v2'
  );
}

// 9. semver.eq throws TypeError when non-string or null arguments are passed
{
  assert.throws(
    () => areVersionsEqual(null, '1.2.3'),
    /Invalid Version: null/,
    'throws on null v1'
  );
  assert.throws(
    () => areVersionsEqual('1.2.3', undefined),
    /Invalid Version: undefined/,
    'throws on undefined v2'
  );
}

console.log('All semver.eq contract assertions passed.');