path-key 3.1.1

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/path-key@3.1.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/path-key@3.1.1

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:8b2bea0cc6b0d1fdef4f8d390aea17f95bdf6f7ddee23b9ef83fe396865259d7","contract":["pathKey is a callable function with default export compatibility","pathKey returns 'PATH' by default on POSIX platform","pathKey returns 'PATH' when explicit POSIX platform is passed regardless of env","pathKey returns the exact matching key name from env on win32","pathKey returns the last defined PATH key when multiple case variants exist on win32","pathKey defaults to 'Path' on win32 when no PATH variable exists in env"],"goal":"verify pkg:npm/path-key@3.1.1","kind":"HOW","packages":["pkg:npm/path-key@3.1.1"],"schemaVersion":1},"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/path-key@3.1.1"],"schemaVersion":1,"subject":"pkg:npm/path-key@3.1.1","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-path-key",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-path-key",
      "version": "1.0.0",
      "dependencies": {
        "path-key": "3.1.1"
      }
    },
    "node_modules/path-key": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
      "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    }
  }
}

{
  "name": "sample-path-key",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "path-key": "3.1.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/path-key@3.1.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/path-key@3.1.1"
  ]
}

import assert from 'node:assert/strict';
import pathKey from 'path-key';

// 1. pathKey is a callable function with default export compatibility
{
	assert.equal(typeof pathKey, 'function', 'pathKey must be a function');
	assert.equal(pathKey.default, pathKey, 'pathKey.default must reference pathKey function');
}

// 2. pathKey returns 'PATH' by default on POSIX platform
{
	const key = pathKey();
	assert.equal(typeof key, 'string', 'pathKey() must return a string');
	assert.equal(key, 'PATH', 'pathKey() on POSIX must return PATH');
}

// 3. pathKey returns 'PATH' when explicit POSIX platform is passed regardless of env
{
	assert.equal(pathKey({ platform: 'linux' }), 'PATH');
	assert.equal(pathKey({ platform: 'darwin' }), 'PATH');
	assert.equal(pathKey({ platform: 'aix' }), 'PATH');
	assert.equal(pathKey({ platform: 'freebsd' }), 'PATH');
	assert.equal(pathKey({ platform: 'openbsd' }), 'PATH');
	assert.equal(pathKey({ platform: 'sunos' }), 'PATH');
	assert.equal(pathKey({ platform: 'android' }), 'PATH');

	const customEnv = { Path: 'bin/custom', PATH: 'bin/posix' };
	assert.equal(pathKey({ platform: 'linux', env: customEnv }), 'PATH');
}

// 4. pathKey returns the exact matching key name from env on win32
{
	assert.equal(pathKey({ platform: 'win32', env: { Path: 'bin/dir' } }), 'Path');
	assert.equal(pathKey({ platform: 'win32', env: { PATH: 'bin/dir' } }), 'PATH');
	assert.equal(pathKey({ platform: 'win32', env: { path: 'bin/dir' } }), 'path');
	assert.equal(pathKey({ platform: 'win32', env: { PaTh: 'bin/dir' } }), 'PaTh');
}

// 5. pathKey returns the last defined PATH key when multiple case variants exist on win32
{
	const multiEnv = {
		Path: 'first-entry',
		PATH: 'second-entry',
		path: 'third-entry',
	};
	assert.equal(pathKey({ platform: 'win32', env: multiEnv }), 'path');
}

// 6. pathKey defaults to 'Path' on win32 when no PATH variable exists in env
{
	const emptyEnv = {};
	assert.equal(pathKey({ platform: 'win32', env: emptyEnv }), 'Path');

	const unrelatedEnv = {
		USER_NAME: 'testuser',
		HOME_DIR: 'home/user',
		APP_ENV: 'testing',
	};
	assert.equal(pathKey({ platform: 'win32', env: unrelatedEnv }), 'Path');
}