bin-links 5.0.0: checkBins

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 bin-links.checkBins in pkg:npm/bin-links@5.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bin-links@5.0.0
Demonstrate these symbols/APIs:
  - bin-links.checkBins

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:f7849fcfb2fae62bacb8c096b0cd2842a825a948fd79e2592ff133da7a0ff3e2","contract":["binLinks.checkBins({ pkg, path, top: true, global: true, force: false }) resolves when target binary does not exist in global bin directory or is a symlink pointing into path","binLinks.checkBins({ pkg, path, top: true, global: true, force: false }) rejects with code EEXIST when target binary in global bin directory points outside path","binLinks.checkBins({ pkg, path, top, global, force }) resolves without checking existing links when force is true or when global or top is false"],"goal":"verify bin-links.checkBins in pkg:npm/bin-links@5.0.0","kind":"HOW","packages":["pkg:npm/bin-links@5.0.0"],"schemaVersion":1,"symbols":["bin-links.checkBins"]},"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/bin-links@5.0.0"],"schemaVersion":1,"subject":"pkg:npm/bin-links@5.0.0","symbols":["bin-links.checkBins"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "bin-links": "5.0.0"
      }
    },
    "node_modules/bin-links": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/bin-links/-/bin-links-5.0.0.tgz",
      "integrity": "sha512-sdleLVfCjBtgO5cNjA2HVRvWBJAHs4zwenaCPMNJAJU0yNxpzj80IpjOIimkpkr+mhlA+how5poQtt53PygbHA==",
      "license": "ISC",
      "dependencies": {
        "cmd-shim": "^7.0.0",
        "npm-normalize-package-bin": "^4.0.0",
        "proc-log": "^5.0.0",
        "read-cmd-shim": "^5.0.0",
        "write-file-atomic": "^6.0.0"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/cmd-shim": {
      "version": "7.0.0",
      "resolved": "https://registry.npmjs.org/cmd-shim/-/cmd-shim-7.0.0.tgz",
      "integrity": "sha512-rtpaCbr164TPPh+zFdkWpCyZuKkjpAzODfaZCf/SVJZzJN+4bHQb/LP3Jzq5/+84um3XXY8r548XiWKSborwVw==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/imurmurhash": {
      "version": "0.1.4",
      "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz",
      "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==",
      "license": "MIT",
      "engines": {
        "node": ">=0.8.19"
      }
    },
    "node_modules/npm-normalize-package-bin": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-4.0.0.tgz",
      "integrity": "sha512-TZKxPvItzai9kN9H/TkmCtx/ZN/hvr3vUycjlfmH0ootY9yFBzNOpiXAdIn1Iteqsvk4lQn6B5PTrt+n6h8k/w==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/proc-log": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-5.0.0.tgz",
      "integrity": "sha512-Azwzvl90HaF0aCz1JrDdXQykFakSSNPaPoiZ9fm5qJIMHioDZEi7OAdRwSm6rSoPtY3Qutnm3L7ogmg3dc+wbQ==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/read-cmd-shim": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/read-cmd-shim/-/read-cmd-shim-5.0.0.tgz",
      "integrity": "sha512-SEbJV7tohp3DAAILbEMPXavBjAnMN0tVnh4+9G8ihV4Pq3HYF9h8QNez9zkJ1ILkv9G2BjdzwctznGZXgu/HGw==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/signal-exit": {
      "version": "4.1.0",
      "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
      "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
      "license": "ISC",
      "engines": {
        "node": ">=14"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "node_modules/write-file-atomic": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-6.0.0.tgz",
      "integrity": "sha512-GmqrO8WJ1NuzJ2DrziEI2o57jKAVIQNf8a18W3nCYU3H7PNWqCCVTeH6/NQE93CIllIgQS98rrmVkYgTX9fFJQ==",
      "license": "ISC",
      "dependencies": {
        "imurmurhash": "^0.1.4",
        "signal-exit": "^4.0.1"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "sample",
  "version": "1.0.0",
  "private": true,
  "license": "MIT-0",
  "dependencies": {
    "bin-links": "5.0.0"
  },
  "scripts": {
    "test": "node test/contract.mjs"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify bin-links.checkBins in pkg:npm/bin-links@5.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/bin-links@5.0.0"
  ],
  "symbols": [
    "bin-links.checkBins"
  ]
}

import assert from 'node:assert/strict';
import fs from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';
import binLinks from 'bin-links';

const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bin-links-test-'));

try {
  const pkgAPath = path.join(tmpDir, 'lib', 'node_modules', 'pkg-a');
  const pkgBPath = path.join(tmpDir, 'lib', 'node_modules', 'pkg-b');
  const globalBinDir = path.join(tmpDir, 'bin');

  await fs.mkdir(pkgAPath, { recursive: true });
  await fs.mkdir(pkgBPath, { recursive: true });
  await fs.mkdir(globalBinDir, { recursive: true });

  const pkgABinFile = path.join(pkgAPath, 'cli.js');
  const pkgBBinFile = path.join(pkgBPath, 'cli.js');
  await fs.writeFile(pkgABinFile, '#!/usr/bin/env node\n');
  await fs.writeFile(pkgBBinFile, '#!/usr/bin/env node\n');

  const pkgA = { name: 'pkg-a', version: '1.0.0', bin: { 'my-tool': './cli.js' } };

  // 1. When target binary does not exist yet in global bin dir, checkBins resolves.
  await binLinks.checkBins({
    pkg: pkgA,
    path: pkgAPath,
    top: true,
    global: true,
    force: false,
  });

  // 2. When target binary is a symlink pointing inside pkgAPath, checkBins resolves.
  const targetBin = path.join(globalBinDir, 'my-tool');
  await fs.symlink(pkgABinFile, targetBin);

  await binLinks.checkBins({
    pkg: pkgA,
    path: pkgAPath,
    top: true,
    global: true,
    force: false,
  });

  // 3. When target binary points to another package (pkgBPath) and force is false, checkBins rejects with EEXIST.
  await fs.unlink(targetBin);
  await fs.symlink(pkgBBinFile, targetBin);

  await assert.rejects(
    () =>
      binLinks.checkBins({
        pkg: pkgA,
        path: pkgAPath,
        top: true,
        global: true,
        force: false,
      }),
    (err) => {
      assert.equal(err.code, 'EEXIST');
      assert.equal(err.path, targetBin);
      return true;
    }
  );

  // 4. When force is true (or global/top is false), checkBins resolves even if target points elsewhere.
  await binLinks.checkBins({
    pkg: pkgA,
    path: pkgAPath,
    top: true,
    global: true,
    force: true,
  });

  await binLinks.checkBins({
    pkg: pkgA,
    path: pkgAPath,
    top: false,
    global: false,
    force: false,
  });
} finally {
  await fs.rm(tmpDir, { recursive: true, force: true });
}