bin-links 5.0.0: binLinks, binLinks.checkBins, binLinks.getPaths

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/bin-links@5.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bin-links@5.0.0

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:dee4b7b90224164ee7a07fbd5a7441109acdda00f2f9b9e2749502ab51c039f9","contract":["binLinks.getPaths({ path, pkg, global: false, top: false }) returns the expected node_modules/.bin/\u003cname\u003e target path array","binLinks.getPaths({ path, pkg, global: false, top: true }) returns an empty array because non-global top packages do not link bins","binLinks.checkBins({ path, pkg, global: false, top: false, force: false }) resolves without error for local bin linking","binLinks({ path, pkg, global: false, top: false, force: false }) creates a symbolic link in node_modules/.bin pointing to the package bin script and sets executable permissions","binLinks.resetSeen() resets internal link and shim tracking caches without error"],"goal":"verify pkg:npm/bin-links@5.0.0","kind":"HOW","packages":["pkg:npm/bin-links@5.0.0"],"schemaVersion":1,"symbols":["binLinks","binLinks.checkBins","binLinks.getPaths","binLinks.resetSeen"]},"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":["binLinks","binLinks.checkBins","binLinks.getPaths","binLinks.resetSeen"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample",
      "version": "1.0.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,
  "type": "module",
  "dependencies": {
    "bin-links": "5.0.0"
  }
}

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

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 tmpRoot = await fs.mkdtemp(path.join(os.tmpdir(), 'bin-links-sample-'));
try {
  // 1. Local package in node_modules/demo-cli
  const pkgPath = path.join(tmpRoot, 'node_modules', 'demo-cli');
  const binDir = path.join(pkgPath, 'bin');
  await fs.mkdir(binDir, { recursive: true });
  const scriptFile = path.join(binDir, 'cli.js');
  await fs.writeFile(scriptFile, '#!/usr/bin/env node\nconsole.log("ok");\n', 'utf8');

  const pkg = {
    name: 'demo-cli',
    version: '1.0.0',
    bin: {
      'demo-cli': './bin/cli.js',
    },
  };

  // Verify getPaths returns expected bin link target for local non-top install
  const expectedBinLink = path.join(tmpRoot, 'node_modules', '.bin', 'demo-cli');
  const paths = binLinks.getPaths({ path: pkgPath, pkg, global: false, top: false });
  assert.deepEqual(paths, [expectedBinLink]);

  // Verify top && !global returns empty array from getPaths and is a no-op in binLinks
  assert.deepEqual(binLinks.getPaths({ path: pkgPath, pkg, global: false, top: true }), []);
  await binLinks({ path: pkgPath, pkg, global: false, top: true });

  // Run checkBins and binLinks to create the symlink in node_modules/.bin/demo-cli
  await binLinks.checkBins({ path: pkgPath, pkg, global: false, top: false, force: false });
  await binLinks({ path: pkgPath, pkg, global: false, top: false, force: false });

  const linkStat = await fs.lstat(expectedBinLink);
  assert.equal(linkStat.isSymbolicLink(), true);
  const resolvedTarget = await fs.realpath(expectedBinLink);
  const resolvedScript = await fs.realpath(scriptFile);
  assert.equal(resolvedTarget, resolvedScript);

  // Verify executable mode was applied to target script
  const targetStat = await fs.stat(scriptFile);
  assert.equal((targetStat.mode & 0o111) !== 0, true);

  // Verify resetSeen is callable
  binLinks.resetSeen();
} finally {
  await fs.rm(tmpRoot, { recursive: true, force: true });
}