@malept/cross-spawn-promise 2.0.0: CrossSpawnError

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 @malept/cross-spawn-promise.CrossSpawnError in pkg:npm/%40malept/cross-spawn-promise@2.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40malept/cross-spawn-promise@2.0.0
Demonstrate these symbols/APIs:
  - @malept/cross-spawn-promise.CrossSpawnError

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:6ec763f553f02a51af383a6600848e7b2120ffb18e4056d791bea5610d716892","contract":["CrossSpawnError is an Error subclass exported by @malept/cross-spawn-promise","CrossSpawnError captures command line arguments, original error, and stderr","CrossSpawnError handles missing or undefined arguments during error formatting","spawn rejects with CrossSpawnError when executing a non-existent command","spawn triggers updateErrorCallback before rejecting with CrossSpawnError"],"goal":"verify @malept/cross-spawn-promise.CrossSpawnError in pkg:npm/%40malept/cross-spawn-promise@2.0.0","kind":"HOW","packages":["pkg:npm/%40malept/cross-spawn-promise@2.0.0"],"schemaVersion":1,"symbols":["@malept/cross-spawn-promise.CrossSpawnError"]},"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/%40malept/cross-spawn-promise@2.0.0"],"schemaVersion":1,"subject":"pkg:npm/%40malept/cross-spawn-promise@2.0.0","symbols":["@malept/cross-spawn-promise.CrossSpawnError"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-cross-spawn-promise-cross-spawn-error",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-cross-spawn-promise-cross-spawn-error",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@malept/cross-spawn-promise": "2.0.0"
      }
    },
    "node_modules/@malept/cross-spawn-promise": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/@malept/cross-spawn-promise/-/cross-spawn-promise-2.0.0.tgz",
      "integrity": "sha512-1DpKU0Z5ThltBwjNySMC14g0CkbyhCaz9FkhxqNsZI6uAPJXFS8cMXlBKo26FJ8ZuW6S9GCMcR9IO5k2X5/9Fg==",
      "funding": [
        {
          "type": "individual",
          "url": "https://github.com/sponsors/malept"
        },
        {
          "type": "tidelift",
          "url": "https://tidelift.com/subscription/pkg/npm-.malept-cross-spawn-promise?utm_medium=referral&utm_source=npm_fund"
        }
      ],
      "license": "Apache-2.0",
      "dependencies": {
        "cross-spawn": "^7.0.1"
      },
      "engines": {
        "node": ">= 12.13.0"
      }
    },
    "node_modules/cross-spawn": {
      "version": "7.0.6",
      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz",
      "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==",
      "license": "MIT",
      "dependencies": {
        "path-key": "^3.1.0",
        "shebang-command": "^2.0.0",
        "which": "^2.0.1"
      },
      "engines": {
        "node": ">= 8"
      }
    },
    "node_modules/isexe": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
      "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==",
      "license": "ISC"
    },
    "node_modules/path-key": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
      "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/shebang-command": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
      "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
      "license": "MIT",
      "dependencies": {
        "shebang-regex": "^3.0.0"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/shebang-regex": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
      "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/which": {
      "version": "2.0.2",
      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
      "license": "ISC",
      "dependencies": {
        "isexe": "^2.0.0"
      },
      "bin": {
        "node-which": "bin/node-which"
      },
      "engines": {
        "node": ">= 8"
      }
    }
  }
}

{
  "name": "sample-cross-spawn-promise-cross-spawn-error",
  "version": "1.0.0",
  "private": true,
  "license": "MIT-0",
  "main": "src/index.js",
  "dependencies": {
    "@malept/cross-spawn-promise": "2.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @malept/cross-spawn-promise.CrossSpawnError in pkg:npm/%40malept/cross-spawn-promise@2.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40malept/cross-spawn-promise@2.0.0"
  ],
  "symbols": [
    "@malept/cross-spawn-promise.CrossSpawnError"
  ]
}

const { CrossSpawnError, spawn } = require('@malept/cross-spawn-promise');

/**
 * Spawns a process and returns its stdout, or throws CrossSpawnError or ExitError.
 *
 * @param {string} command - Executable to run.
 * @param {string[]} [args] - Arguments array.
 * @param {object} [options] - Options passed to cross-spawn-promise.
 * @returns {Promise<string>} Standard output from the spawned command.
 */
async function runCommand(command, args, options) {
  return spawn(command, args, options);
}

module.exports = {
  CrossSpawnError,
  spawn,
  runCommand
};

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const { CrossSpawnError, spawn, runCommand } = require('../src/index.js');
const crossSpawnModule = require('@malept/cross-spawn-promise');

// 1. CrossSpawnError is an Error subclass exported by @malept/cross-spawn-promise
assert.equal(typeof CrossSpawnError, 'function', 'CrossSpawnError must be exported as a function/class');
assert.strictEqual(CrossSpawnError, crossSpawnModule.CrossSpawnError, 'CrossSpawnError export must match @malept/cross-spawn-promise');
assert.ok(CrossSpawnError.prototype instanceof Error, 'CrossSpawnError must inherit from Error');

// 2. CrossSpawnError captures command line arguments, original error, and stderr
const customErr = new Error('original error detail');
const instance = new CrossSpawnError('sample-binary', ['--flag', 'arg-val'], customErr, 'stderr output text');
assert.ok(instance instanceof Error, 'instance must be an Error');
assert.ok(instance instanceof CrossSpawnError, 'instance must be a CrossSpawnError');
assert.strictEqual(instance.originalError, customErr, 'instance.originalError must hold the passed Error');
assert.ok(instance.message.includes('sample-binary --flag arg-val'), 'message must include full command string');
assert.ok(instance.message.includes('original error detail'), 'message must include original error message');
assert.ok(instance.message.includes('stderr output text'), 'message must include stderr output');

// 3. CrossSpawnError handles missing or undefined arguments during error formatting
const errUndefinedArgs = new CrossSpawnError('sample-binary-solo', undefined, customErr, '');
assert.ok(errUndefinedArgs.message.includes('Error executing command (sample-binary-solo):'), 'message must format command without args correctly');

const errEmptyArgs = new CrossSpawnError('sample-binary-solo', [], customErr, '');
assert.ok(errEmptyArgs.message.includes('Error executing command (sample-binary-solo):'), 'message must format command with empty args array');

// 4. spawn rejects with CrossSpawnError when executing a non-existent command
const nonExistentCommand = 'non-existent-binary-for-cross-spawn-test-42';
await assert.rejects(
  async () => {
    await runCommand(nonExistentCommand, ['--check']);
  },
  (err) => {
    assert.ok(err instanceof CrossSpawnError, 'thrown error must be an instance of CrossSpawnError');
    assert.ok(err instanceof Error, 'thrown error must be an instance of Error');
    assert.strictEqual(err.originalError.code, 'ENOENT', 'underlying error code must be ENOENT');
    assert.ok(err.message.includes(`${nonExistentCommand} --check`), 'error message must contain command and arguments');
    return true;
  },
  'runCommand must reject with CrossSpawnError on non-existent binary'
);

// 5. spawn triggers updateErrorCallback before rejecting with CrossSpawnError
let updateCallbackInvoked = false;
let receivedLoggerFlag = null;

await assert.rejects(
  async () => {
    await spawn(nonExistentCommand, [], {
      updateErrorCallback: (err, hasLogger) => {
        updateCallbackInvoked = true;
        receivedLoggerFlag = hasLogger;
        err.message = `augmented: ${err.message}`;
      }
    });
  },
  (err) => {
    assert.ok(err instanceof CrossSpawnError, 'thrown error must be an instance of CrossSpawnError');
    assert.strictEqual(updateCallbackInvoked, true, 'updateErrorCallback must be called on spawn failure');
    assert.strictEqual(receivedLoggerFlag, false, 'hasLogger flag must be false when no logger is provided');
    assert.ok(err.message.includes('augmented:'), 'CrossSpawnError message must reflect mutated originalError');
    return true;
  },
  'spawn must invoke updateErrorCallback before rejecting with CrossSpawnError'
);

console.log('Contract tests passed successfully.');