cmd-shim 7.0.0: cmdShim

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 cmdShim in pkg:npm/cmd-shim@7.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/cmd-shim@7.0.0
Demonstrate these symbols/APIs:
  - cmdShim

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:3c2f209d46772a83b04fcdee933d411aaa70505dfc9dac26a9f5fe3f46780abb","contract":["cmdShim(from, to) creates executable shim files (to, to.cmd, to.ps1) forwarding arguments and shebang options to the target script","cmdShim(from, to) rejects with ENOENT when the source script does not exist","cmdShim.ifExists(from, to) resolves without error when the source script does not exist"],"goal":"verify cmdShim in pkg:npm/cmd-shim@7.0.0","kind":"HOW","packages":["pkg:npm/cmd-shim@7.0.0"],"schemaVersion":1,"symbols":["cmdShim"]},"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/cmd-shim@7.0.0"],"schemaVersion":1,"subject":"pkg:npm/cmd-shim@7.0.0","symbols":["cmdShim"],"verifierAdapter":"node-typescript@1"}

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

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

{
  "schemaVersion": 1,
  "goal": "verify cmdShim in pkg:npm/cmd-shim@7.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/cmd-shim@7.0.0"
  ],
  "symbols": [
    "cmdShim"
  ]
}

import assert from 'node:assert/strict';
import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import cmdShim from 'cmd-shim';

const workDir = await mkdtemp(join(tmpdir(), 'cmd-shim-test-'));

try {
  // 1. Create a script with a node shebang and generate shims with cmdShim
  const scriptPath = join(workDir, 'cli.js');
  const shimPath = join(workDir, 'bin', 'my-cli');
  await writeFile(scriptPath, '#!/usr/bin/env node --no-warnings\nconsole.log("ok");\n', 'utf8');

  await cmdShim(scriptPath, shimPath);

  const shContent = await readFile(shimPath, 'utf8');
  const cmdContent = await readFile(`${shimPath}.cmd`, 'utf8');
  const ps1Content = await readFile(`${shimPath}.ps1`, 'utf8');

  assert.ok(shContent.startsWith('#!/bin/sh\n'));
  assert.ok(shContent.includes('"$basedir/../cli.js"'));
  assert.ok(shContent.includes('--no-warnings'));

  assert.ok(cmdContent.startsWith('@ECHO off\r\n'));
  assert.ok(cmdContent.includes('"%dp0%\\..\\cli.js"'));
  assert.ok(cmdContent.includes('--no-warnings'));

  assert.ok(ps1Content.startsWith('#!/usr/bin/env pwsh\n'));
  assert.ok(ps1Content.includes('"$basedir/../cli.js"'));

  // 2. Calling cmdShim on a missing source file rejects with ENOENT
  const missingPath = join(workDir, 'missing.js');
  const missingShim = join(workDir, 'bin', 'missing-cli');
  await assert.rejects(
    () => cmdShim(missingPath, missingShim),
    { code: 'ENOENT' }
  );

  // 3. cmdShim.ifExists resolves without throwing when the source file does not exist
  await cmdShim.ifExists(missingPath, missingShim);
} finally {
  await rm(workDir, { recursive: true, force: true });
}