read-cmd-shim 5.0.0: sync

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 read-cmd-shim.sync in pkg:npm/read-cmd-shim@5.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/read-cmd-shim@5.0.0
Demonstrate these symbols/APIs:
  - read-cmd-shim.sync

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:29c49017adc2dc16ff7f76afb017ca0b6b32fa81c0885217b96073bddb6bbadd","contract":["readCmdShim.sync(cmdPath) extracts the relative target path from a .cmd shim matching \"%~dp0\\\u003ctarget\u003e\" %*","readCmdShim.sync(ps1Path) extracts the relative target path from a .ps1 shim matching \"$basedir/\u003ctarget\u003e\" $args","readCmdShim.sync(shPath) extracts the relative target path from a POSIX/Cygwin shim matching \"$basedir/\u003ctarget\u003e\" \"$@\"","readCmdShim.sync(invalidPath) throws an Error with code 'ENOTASHIM' when the file is not a valid cmd-shim"],"goal":"verify read-cmd-shim.sync in pkg:npm/read-cmd-shim@5.0.0","kind":"HOW","packages":["pkg:npm/read-cmd-shim@5.0.0"],"schemaVersion":1,"symbols":["read-cmd-shim.sync"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/read-cmd-shim@5.0.0"],"schemaVersion":1,"subject":"pkg:npm/read-cmd-shim@5.0.0","symbols":["read-cmd-shim.sync"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-read-cmd-shim-sync",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-read-cmd-shim-sync",
      "version": "1.0.0",
      "dependencies": {
        "read-cmd-shim": "5.0.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"
      }
    }
  }
}

{
  "name": "sample-read-cmd-shim-sync",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "read-cmd-shim": "5.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify read-cmd-shim.sync in pkg:npm/read-cmd-shim@5.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/read-cmd-shim@5.0.0"
  ],
  "symbols": [
    "read-cmd-shim.sync"
  ]
}

import readCmdShim from "read-cmd-shim";

export function readShimTargetSync(shimPath) {
  return readCmdShim.sync(shimPath);
}

import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import readCmdShim from "read-cmd-shim";
import { readShimTargetSync } from "../src/index.mjs";

const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "shim-contract-"));

try {
  // 1. Windows .cmd shim format (%~dp0\<target> %*)
  const cmdShimPath = path.join(tmpDir, "tool.cmd");
  fs.writeFileSync(
    cmdShimPath,
    '@ECHO off\r\n"%~dp0\\..\\my-pkg\\bin\\cli.js" %*\r\n',
    "utf8"
  );
  assert.equal(readShimTargetSync(cmdShimPath), "..\\my-pkg\\bin\\cli.js");
  assert.equal(readCmdShim.sync(cmdShimPath), "..\\my-pkg\\bin\\cli.js");

  // 2. PowerShell .ps1 shim format ("$basedir/<target>" $args)
  const ps1ShimPath = path.join(tmpDir, "tool.ps1");
  fs.writeFileSync(
    ps1ShimPath,
    '#!/usr/bin/env pwsh\n& node "$basedir/../my-pkg/bin/cli.js" $args\n',
    "utf8"
  );
  assert.equal(readCmdShim.sync(ps1ShimPath), "../my-pkg/bin/cli.js");

  // 3. Cygwin / POSIX shell shim format ("$basedir/<target>" "$@")
  const shShimPath = path.join(tmpDir, "tool");
  fs.writeFileSync(
    shShimPath,
    '#!/bin/sh\nexec node "$basedir/../my-pkg/bin/cli.js" "$@"\n',
    "utf8"
  );
  assert.equal(readCmdShim.sync(shShimPath), "../my-pkg/bin/cli.js");

  // 4. Non-shim file throws ENOTASHIM
  const invalidShimPath = path.join(tmpDir, "not-a-shim.cmd");
  fs.writeFileSync(invalidShimPath, "echo hello world\n", "utf8");
  assert.throws(
    () => readCmdShim.sync(invalidShimPath),
    (err) => err instanceof Error && err.code === "ENOTASHIM"
  );
} finally {
  fs.rmSync(tmpDir, { recursive: true, force: true });
}