which 6.0.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/which@6.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/which@6.0.1
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:8a0e9fd6c0ad99fec60c3ee8cdffc61ec2f29d0eb771474fc1363d28469ccc8b","constraints":{"executionContext":"node"},"contract":["which(cmd) resolves to the path of an executable in PATH","which.sync(cmd) returns the path of an executable in PATH synchronously","which(cmd, { path }) resolves executable from custom path directory","which(cmd, { nothrow: true }) resolves null when executable is not found","which.sync(cmd, { nothrow: true }) returns null when executable is not found","which(cmd) rejects with ENOENT when executable is not found","which.sync(cmd) throws ENOENT when executable is not found","which(cmd, { all: true }) returns an array of matching executable paths"],"goal":"verify pkg:npm/which@6.0.1","kind":"HOW","packages":["pkg:npm/which@6.0.1"],"schemaVersion":1},"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/which@6.0.1"],"schemaVersion":1,"subject":"pkg:npm/which@6.0.1","verifierAdapter":"node-typescript@1"}

const which = require('which');

async function findExecutable(name, options) {
  return await which(name, options);
}

function findExecutableSync(name, options) {
  return which.sync(name, options);
}

module.exports = {
  findExecutable,
  findExecutableSync,
};

{
  "name": "sample-which",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-which",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "which": "6.0.1"
      }
    },
    "node_modules/isexe": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz",
      "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==",
      "license": "BlueOak-1.0.0",
      "engines": {
        "node": ">=20"
      }
    },
    "node_modules/which": {
      "version": "6.0.1",
      "resolved": "https://registry.npmjs.org/which/-/which-6.0.1.tgz",
      "integrity": "sha512-oGLe46MIrCRqX7ytPUf66EAYvdeMIZYn3WaocqqKZAxrBpkqHfL/qvTyJ/bTk5+AqHCjXmrv3CEWgy368zhRUg==",
      "license": "ISC",
      "dependencies": {
        "isexe": "^4.0.0"
      },
      "bin": {
        "node-which": "bin/which.js"
      },
      "engines": {
        "node": "^20.17.0 || >=22.9.0"
      }
    }
  }
}

{
  "name": "sample-which",
  "version": "1.0.0",
  "description": "Example verifying which package",
  "main": "index.js",
  "type": "commonjs",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "which": "6.0.1"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/which@6.0.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/which@6.0.1"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const assert = require('assert');
const path = require('path');
const fs = require('fs');
const which = require('which');
const { findExecutable, findExecutableSync } = require('../index.js');

async function runTests() {
  // 1. Asynchronous lookup of an existing executable in PATH (node)
  const nodePath = await which('node');
  assert.strictEqual(typeof nodePath, 'string');
  assert.ok(nodePath.length > 0);
  assert.ok(fs.existsSync(nodePath), 'Resolved node path must exist on disk');

  // 2. Synchronous lookup of an existing executable in PATH (node)
  const nodePathSync = which.sync('node');
  assert.strictEqual(typeof nodePathSync, 'string');
  assert.ok(nodePathSync.length > 0);
  assert.ok(fs.existsSync(nodePathSync), 'Resolved synchronous node path must exist on disk');

  // 3. Helper functions from index.js
  const helperAsync = await findExecutable('node');
  assert.strictEqual(helperAsync, nodePath);

  const helperSync = findExecutableSync('node');
  assert.strictEqual(helperSync, nodePathSync);

  // 4. Lookup with custom path option using a temporary executable fixture
  const fixtureDir = path.join(__dirname, 'fixtures');
  if (!fs.existsSync(fixtureDir)) {
    fs.mkdirSync(fixtureDir, { recursive: true });
  }
  const testBinName = 'custom-test-cmd';
  const testBinPath = path.join(fixtureDir, testBinName);
  fs.writeFileSync(testBinPath, '#!/bin/sh\necho "test"\n', { mode: 0o755 });

  try {
    const foundCustom = await which(testBinName, { path: fixtureDir });
    assert.strictEqual(foundCustom, testBinPath);

    const foundCustomSync = which.sync(testBinName, { path: fixtureDir });
    assert.strictEqual(foundCustomSync, testBinPath);

    // 5. Lookup all matches
    const allMatches = await which(testBinName, { path: fixtureDir, all: true });
    assert.ok(Array.isArray(allMatches));
    assert.ok(allMatches.includes(testBinPath));

    const allMatchesSync = which.sync(testBinName, { path: fixtureDir, all: true });
    assert.ok(Array.isArray(allMatchesSync));
    assert.ok(allMatchesSync.includes(testBinPath));
  } finally {
    if (fs.existsSync(testBinPath)) {
      fs.unlinkSync(testBinPath);
    }
    if (fs.existsSync(fixtureDir)) {
      fs.rmdirSync(fixtureDir);
    }
  }

  // 6. Nonexistent command with nothrow: true returns null
  const missingAsync = await which('nonexistent-executable-command-xyz', { nothrow: true });
  assert.strictEqual(missingAsync, null);

  const missingSync = which.sync('nonexistent-executable-command-xyz', { nothrow: true });
  assert.strictEqual(missingSync, null);

  // 7. Nonexistent command without nothrow throws ENOENT error
  let asyncThrew = false;
  try {
    await which('nonexistent-executable-command-xyz');
  } catch (err) {
    asyncThrew = true;
    assert.strictEqual(err.code, 'ENOENT');
  }
  assert.ok(asyncThrew, 'which should reject when command is not found');

  let syncThrew = false;
  try {
    which.sync('nonexistent-executable-command-xyz');
  } catch (err) {
    syncThrew = true;
    assert.strictEqual(err.code, 'ENOENT');
  }
  assert.ok(syncThrew, 'which.sync should throw when command is not found');

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

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