npm-install-checks 7.1.2: checkEngine, checkPlatform, checkDevEngines

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/npm-install-checks@7.1.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/npm-install-checks@7.1.2
Demonstrate these symbols/APIs:
  - checkEngine
  - checkPlatform

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:a218f4feed2b5ca0d0d4d649ad02c40b1d357355e4168521ed451736ed32c2db","contract":["checkEngine validates target.engines against npm and node versions, throwing EBADENGINE on mismatch unless force is true","checkPlatform validates target os, cpu, and libc arrays (including negated entries) against environment, throwing EBADPLATFORM on mismatch unless force is true","checkDevEngines validates devEngines descriptors against currentEnv.devEngines() and returns structured warning/error objects"],"goal":"verify pkg:npm/npm-install-checks@7.1.2","kind":"HOW","packages":["pkg:npm/npm-install-checks@7.1.2"],"schemaVersion":1,"symbols":["checkEngine","checkPlatform","checkDevEngines","currentEnv"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/npm-install-checks@7.1.2"],"schemaVersion":1,"subject":"pkg:npm/npm-install-checks@7.1.2","symbols":["checkEngine","checkPlatform","checkDevEngines","currentEnv"],"verifierAdapter":"node-typescript@1"}

{
  "name": "verify-npm-install-checks",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-npm-install-checks",
      "version": "1.0.0",
      "dependencies": {
        "npm-install-checks": "7.1.2"
      }
    },
    "node_modules/npm-install-checks": {
      "version": "7.1.2",
      "resolved": "https://registry.npmjs.org/npm-install-checks/-/npm-install-checks-7.1.2.tgz",
      "integrity": "sha512-z9HJBCYw9Zr8BqXcllKIs5nI+QggAImbBdHphOzVYrz2CB4iQ6FzWyKmlqDZua+51nAu7FcemlbTc9VgQN5XDQ==",
      "license": "BSD-2-Clause",
      "dependencies": {
        "semver": "^7.1.1"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/semver": {
      "version": "7.8.5",
      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz",
      "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==",
      "license": "ISC",
      "bin": {
        "semver": "bin/semver.js"
      },
      "engines": {
        "node": ">=10"
      }
    }
  }
}

{
  "name": "verify-npm-install-checks",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "npm-install-checks": "7.1.2"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/npm-install-checks@7.1.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-install-checks@7.1.2"
  ],
  "symbols": [
    "checkEngine",
    "checkPlatform"
  ]
}

import assert from 'node:assert/strict';
import installChecks from 'npm-install-checks';

const { checkEngine, checkPlatform, checkDevEngines, currentEnv } = installChecks;

// 1. checkEngine: passes when engine constraints are satisfied or force=true
checkEngine({ _id: 'demo@1.0.0', engines: { node: '>=18.0.0', npm: '>=9.0.0' } }, '10.2.0', '20.10.0');
checkEngine({ _id: 'demo@1.0.0', engines: { node: '>=22.0.0' } }, '10.2.0', '20.10.0', true);

// 2. checkEngine: throws EBADENGINE when node or npm version does not satisfy range
assert.throws(
  () => checkEngine({ _id: 'demo@1.0.0', engines: { node: '>=22.0.0' } }, '10.2.0', '20.10.0'),
  (err) => {
    assert.equal(err.code, 'EBADENGINE');
    assert.equal(err.pkgid, 'demo@1.0.0');
    assert.deepEqual(err.current, { node: '20.10.0', npm: '10.2.0' });
    assert.deepEqual(err.required, { node: '>=22.0.0' });
    return true;
  }
);

// 3. checkPlatform: passes with matching or negated platform list, or when force=true
checkPlatform(
  { _id: 'demo@1.0.0', os: ['linux', 'darwin'], cpu: ['!ia32'], libc: ['glibc'] },
  false,
  { os: 'linux', cpu: 'x64', libc: 'glibc' }
);
checkPlatform(
  { _id: 'demo@1.0.0', os: ['win32'] },
  true,
  { os: 'linux', cpu: 'x64', libc: 'glibc' }
);

// 4. checkPlatform: throws EBADPLATFORM on os/cpu/libc mismatch
assert.throws(
  () => checkPlatform(
    { _id: 'demo@1.0.0', os: ['darwin'], cpu: ['arm64'] },
    false,
    { os: 'linux', cpu: 'x64', libc: 'glibc' }
  ),
  (err) => {
    assert.equal(err.code, 'EBADPLATFORM');
    assert.equal(err.pkgid, 'demo@1.0.0');
    assert.deepEqual(err.current, { os: 'linux', cpu: 'x64', libc: 'glibc' });
    return true;
  }
);

// 5. checkDevEngines & currentEnv: validates devEngines against environment descriptors
const envDesc = currentEnv.devEngines({
  os: 'linux',
  cpu: 'x64',
  libc: 'glibc',
  npmVersion: '10.5.0',
  nodeVersion: '20.11.0',
});
assert.equal(envDesc.runtime.name, 'node');
assert.equal(envDesc.packageManager.version, '10.5.0');

const passErrors = checkDevEngines(
  { runtime: { name: 'node', version: '>=20.0.0' } },
  envDesc
);
assert.equal(passErrors.length, 0);

const failErrors = checkDevEngines(
  { runtime: { name: 'node', version: '>=22.0.0', onFail: 'warn' } },
  envDesc
);
assert.equal(failErrors.length, 1);
assert.equal(failErrors[0].engine, 'runtime');
assert.equal(failErrors[0].isWarn, true);
assert.equal(failErrors[0].isError, false);