cross-spawn-esm 1.1.1 → 1.2.0

package/README.md

@@ -8,8 +8,8 @@
 This is a "fork" of [cross-spawn](https://www.npmjs.com/package/cross-spawn?activeTab=readme) ( a cross-platform solution to node's spawn
 and spawnSync ) which ports its codebase to modern ESM and TypeScript.
 
-This package isn't a 100% drop-in replacement for **cross-spawn** ( the API differs slightly ) but it tries to behave the same as the
-original package. Please refer to the [Migration guide](#migration-guide) for further explanation.
+This package is a drop-in replacement for **cross-spawn** which tries to behave the same as the original package. Please refer to the
+[Migration guide](#migration-guide) for further explanation.
 
 ## Installation
 
@@ -60,7 +60,7 @@ const result = spawnSync("npm", ["list", "-g", "-depth", "0"], { stdio: "inherit
 
 ## Benefits
 
-- Overall smaller bundle size
+- Overall smaller bundle size (**~50% smaller**)
 - Tree-shaking friendly
 - Zero dependencies
 - No need for an additional types package (`@types/cross-spawn`)
@@ -144,7 +144,7 @@ Beyond the API surface, a few implementation details intentionally differ:
 
 The following behaviors are intentionally kept identical to `cross-spawn`:
 
-- When `options.shell` is used, parsing, escaping, and shebang enhancements are disabled — matching both the original and Node.js behavior.
+- When `options.shell` is used, parsing, escaping, and shebang enhancements are disabled - matching both the original and Node.js behavior.
 - Windows-only ENOENT detection: when the process exits with code `1` and the command could not be resolved, an `error` event (async) or
   `result.error` (sync) is produced.
 

package/dist/index.d.ts

@@ -1,5 +1,38 @@
 import { ChildProcess, SpawnOptions, SpawnSyncOptions, SpawnSyncReturns } from "node:child_process";
 import { NonSharedBuffer } from "node:buffer";
+//#region src/utils/escapes.d.ts
+/**
+ * Remove line breaks (`\r` and `\n`) from the given string. Without this, an argument containing a newline could terminate the enclosing
+ * command early and inject an arbitrary second command into the shell.
+ *
+ * @example
+ * // Without escaping, cmd.exe would run two commands:
+ * //   node -e "console.log('ok')
+ * //   calc.exe"
+ * escapeLineBreaks("console.log('ok')\ncalc.exe");
+ * //=> "console.log('ok')calc.exe"
+ */
+declare function escapeLineBreaks(arg: string): string;
+/**
+ * Escape Windows `cmd.exe` shell meta characters (``/([()\][%!^"`<>&|;, *?])/g``) by prefixing each with `^`. Without this, a meta character in a command or argument would be interpreted
+ * by the shell, breaking the command or enabling arbitrary command execution.
+ *
+ * @example
+ * // Without escaping, cmd.exe would treat the spaces and `&` as separators:
+ * escapeMetaChars('notepad "a & b.txt"');
+ * //=> 'notepad^ ^"a^ ^&^ b.txt^"'
+ */
+declare function escapeMetaChars(arg: string): string;
+/**
+ * Escapes a command name for safe use in a Windows `cmd.exe` invocation.
+ */
+declare function escapeCommand(arg: string): string;
+/**
+ * Escape a single argument into a fully self-contained token for a Windows
+ * `cmd.exe` command line.
+ */
+declare function escapeArgument(arg: unknown, doubleEscapeMetaChars?: boolean): string;
+//#endregion
 //#region src/utils/resolve-command.d.ts
 interface ParsedCommand {
   command: string;
@@ -32,18 +65,25 @@ declare function resolveCommandAttempt(parsed: ParsedCommand, withoutPathExt?: b
 declare function resolveCommand(parsed: ParsedCommand): string | null;
 //#endregion
 //#region src/enoent.d.ts
+interface SpawnError extends NodeJS.ErrnoException {
+  code: string;
+  errno: number;
+  path: string;
+  syscall: string;
+  spawnargs: ReadonlyArray<string>;
+}
 /**
  * Builds an ENOENT error for a command that could not be found. Creates
  * an error whose shape matches what Node's own `spawn`/`spawnSync` would produce
  * when it fails to locate the command file. This makes the error interchangeable
  * with a real ENOENT from Node.
  */
-declare function notFoundError(original: ParsedCommand["original"], syscall: "spawn" | "spawnSync"): NodeJS.ErrnoException;
+declare function notFoundError(original: ParsedCommand["original"], syscall: "spawn" | "spawnSync"): SpawnError;
 /**
  * Detects the Windows-only fake ENOENT that `cmd.exe` produces. On POSIX or
  * for any other exit code the error is not applicable, so `null` is returned.
  */
-declare function verifyENOENT(status: number | null, parsed: ParsedCommand, syscall: "spawn" | "spawnSync"): NodeJS.ErrnoException | null;
+declare function verifyENOENT(status: number | null, parsed: ParsedCommand, syscall: "spawn" | "spawnSync"): SpawnError | null;
 /**
  * Hooks into a `ChildProcess` `exit` event so that a missing command is
  * surfaced as an `error` event instead of silently exiting with code `1`.
@@ -98,39 +138,6 @@ declare function readShebang(file: string): string | null;
  */
 declare function detectShebang(parsed: ParsedCommand): string | null;
 //#endregion
-//#region src/utils/escapes.d.ts
-/**
- * Remove line breaks (`\r` and `\n`) from the given string. Without this, an argument containing a newline could terminate the enclosing
- * command early and inject an arbitrary second command into the shell.
- *
- * @example
- * // Without escaping, cmd.exe would run two commands:
- * //   node -e "console.log('ok')
- * //   calc.exe"
- * escapeLineBreaks("console.log('ok')\ncalc.exe");
- * //=> "console.log('ok')calc.exe"
- */
-declare function escapeLineBreaks(arg: string): string;
-/**
- * Escape Windows `cmd.exe` shell meta characters (``/([()\][%!^"`<>&|;, *?])/g``) by prefixing each with `^`. Without this, a meta character in a command or argument would be interpreted
- * by the shell, breaking the command or enabling arbitrary command execution.
- *
- * @example
- * // Without escaping, cmd.exe would treat the spaces and `&` as separators:
- * escapeMetaChars('notepad "a & b.txt"');
- * //=> 'notepad^ ^"a^ ^&^ b.txt^"'
- */
-declare function escapeMetaChars(arg: string): string;
-/**
- * Escapes a command name for safe use in a Windows `cmd.exe` invocation.
- */
-declare function escapeCommand(arg: string): string;
-/**
- * Escape a single argument into a fully self-contained token for a Windows
- * `cmd.exe` command line.
- */
-declare function escapeArgument(arg: unknown, doubleEscapeMetaChars?: boolean): string;
-//#endregion
 //#region src/utils/path-key.d.ts
 interface PathKeyOptions {
   /**
@@ -139,14 +146,14 @@ interface PathKeyOptions {
    *
    * @see https://nodejs.org/api/process.html#process_process_env
    */
-  env?: Record<string, string | undefined>;
+  readonly env?: NodeJS.ProcessEnv;
   /**
    * Get the PATH key for a specific platform.
    * @default process.platform
    *
    * @see https://nodejs.org/api/process.html#process_process_platform
    */
-  platform?: NodeJS.Platform;
+  readonly platform?: NodeJS.Platform;
 }
 /**
  * Get the [PATH] environment variable key cross-platform.
@@ -159,7 +166,7 @@ interface PathKeyOptions {
  * const PATH = process.env[key];
  * //=> '/usr/local/bin:/usr/bin:/bin'
  */
-declare function pathKey({ env, platform }: PathKeyOptions): string;
+declare function pathKey({ env, platform }?: PathKeyOptions): string;
 //#endregion
 //#region src/parse.d.ts
 /**
@@ -227,4 +234,4 @@ export declare const _utils: {
   pathKey: typeof pathKey;
 };
 //#endregion
-export type { ParsedCommand, PathKeyOptions };
+export type { ParsedCommand, PathKeyOptions, SpawnError };

package/dist/index.js

@@ -12,9 +12,51 @@ const metaCharsRegExp = /([()\][%!^"`<>&|;, *?])/g;
 const executableRegExp = /\.(?:exe)$/i;
 const cmdShimRegExp = /node_modules[\\/].bin[\\/][^\\/]+\.cmd$/i;
 //#endregion
-//#region src/utils/path-key.ts
-function pathKey({ env = _env, platform = _platform }) {
-	return platform === "win32" ? Object.keys(env).reverse().find((key) => key.toUpperCase() === "PATH") ?? "Path" : "PATH";
+//#region src/utils/escapes.ts
+function escapeLineBreaks(arg) {
+	return arg.replace(lineBreaksRegExp, "");
+}
+function escapeMetaChars(arg) {
+	return arg.replace(metaCharsRegExp, "^$1");
+}
+function escapeCommand(arg) {
+	return escapeMetaChars(escapeLineBreaks(arg));
+}
+function escapeArgument(arg, doubleEscapeMetaChars) {
+	let argStr = `${arg}`;
+	argStr = escapeLineBreaks(argStr);
+	argStr = argStr.replace(/(?=(\\+?)?)\1"/g, "$1$1\\\"");
+	argStr = argStr.replace(/(?=(\\+?)?)\1$/, "$1$1");
+	argStr = escapeMetaChars(`"${argStr}"`);
+	if (doubleEscapeMetaChars) argStr = escapeMetaChars(argStr);
+	return argStr;
+}
+//#endregion
+//#region src/enoent.ts
+function notFoundError(original, syscall) {
+	return Object.assign(/* @__PURE__ */ new Error(`${syscall} ${original.command} ENOENT`), {
+		code: "ENOENT",
+		errno: -2,
+		syscall: `${syscall} ${original.command}`,
+		path: original.command,
+		spawnargs: original.args
+	});
+}
+function verifyENOENT(status, parsed, syscall) {
+	if (isWin && status === 1 && !parsed.file) return notFoundError(parsed.original, syscall);
+	return null;
+}
+function hookChildProcess(cp, parsed) {
+	if (!isWin) return;
+	const originalEmit = cp.emit;
+	cp.emit = function(name, ...args) {
+		if (name === "exit") {
+			const status = args[0];
+			const err = verifyENOENT(status, parsed, "spawn");
+			if (err) return originalEmit.call(cp, "error", err);
+		}
+		return originalEmit.apply(cp, [name, ...args]);
+	};
 }
 //#endregion
 //#region src/utils/isexe.ts
@@ -39,7 +81,7 @@ function isExecutableMode(stat) {
 	const { mode, uid, gid } = stat;
 	return !!(mode & execOther || mode & execGroup && groups.has(gid) || mode & execOwner && uid === myUid || mode & execOwnerOrGroup && myUid === 0);
 }
-function isexeSync(file, { pathExt = process.env.PATHEXT ?? "" } = {}) {
+function isexeSync(file, { pathExt = _env.PATHEXT ?? "" } = {}) {
 	try {
 		const stat = fs.statSync(file);
 		if (!stat.isFile()) return false;
@@ -54,7 +96,7 @@ const pathSeparatorRegExp = new RegExp(`[${path.posix.sep}${path.sep === path.po
 function whichSync(command, { cwd = _cwd, path: optPath = _env.PATH, pathExt: optPathExt = _env.PATHEXT } = {}) {
 	const delimiter = path.delimiter;
 	const dirs = command.match(pathSeparatorRegExp) ? [""] : [...isWin ? [cwd] : [], ...(optPath ?? "").split(delimiter)];
-	const pathExtExe = isWin ? optPathExt ?? [
+	const pathExtExe = isWin ? optPathExt || [
 		".EXE",
 		".CMD",
 		".BAT",
@@ -72,6 +114,11 @@ function whichSync(command, { cwd = _cwd, path: optPath = _env.PATH, pathExt: op
 	return null;
 }
 //#endregion
+//#region src/utils/path-key.ts
+function pathKey({ env = _env, platform = _platform } = {}) {
+	return platform === "win32" ? Object.keys(env).reverse().find((key) => key.toUpperCase() === "PATH") ?? "Path" : "PATH";
+}
+//#endregion
 //#region src/utils/resolve-command.ts
 function resolveCommandAttempt(parsed, withoutPathExt) {
 	const env = parsed.options.env ?? _env;
@@ -85,33 +132,6 @@ function resolveCommand(parsed) {
 	return resolveCommandAttempt(parsed) ?? (isWin ? resolveCommandAttempt(parsed, true) : null);
 }
 //#endregion
-//#region src/enoent.ts
-function notFoundError(original, syscall) {
-	return Object.assign(/* @__PURE__ */ new Error(`${syscall} ${original.command} ENOENT`), {
-		code: "ENOENT",
-		errno: -2,
-		syscall: `${syscall} ${original.command}`,
-		path: original.command,
-		spawnargs: original.args
-	});
-}
-function verifyENOENT(status, parsed, syscall) {
-	if (isWin && status === 1 && !parsed.file) return notFoundError(parsed.original, syscall);
-	return null;
-}
-function hookChildProcess(cp, parsed) {
-	if (!isWin) return;
-	const originalEmit = cp.emit;
-	cp.emit = function(name, ...args) {
-		if (name === "exit") {
-			const status = args[0];
-			const err = verifyENOENT(status, parsed, "spawn");
-			if (err) return originalEmit.call(cp, "error", err);
-		}
-		return originalEmit.apply(cp, [name, ...args]);
-	};
-}
-//#endregion
 //#region src/utils/shebang.ts
 function shebangCommand(string) {
 	const match = string.match(shebangRegExp);
@@ -144,26 +164,6 @@ function detectShebang(parsed) {
 	return parsed.file;
 }
 //#endregion
-//#region src/utils/escapes.ts
-function escapeLineBreaks(arg) {
-	return arg.replace(lineBreaksRegExp, "");
-}
-function escapeMetaChars(arg) {
-	return arg.replace(metaCharsRegExp, "^$1");
-}
-function escapeCommand(arg) {
-	return escapeMetaChars(escapeLineBreaks(arg));
-}
-function escapeArgument(arg, doubleEscapeMetaChars) {
-	let argStr = `${arg}`;
-	argStr = escapeLineBreaks(argStr);
-	argStr = argStr.replace(/(?=(\\+?)?)\1"/g, "$1$1\\\"");
-	argStr = argStr.replace(/(?=(\\+?)?)\1$/, "$1$1");
-	argStr = escapeMetaChars(`"${argStr}"`);
-	if (doubleEscapeMetaChars) argStr = escapeMetaChars(argStr);
-	return argStr;
-}
-//#endregion
 //#region src/parse.ts
 function parseNonShell(parsed) {
 	if (!isWin) return parsed;
@@ -186,11 +186,11 @@ function parseNonShell(parsed) {
 	return parsed;
 }
 function parse(command, args, options) {
-	if (!Array.isArray(args)) {
+	if (args && !Array.isArray(args)) {
 		options = args;
 		args = [];
 	}
-	const argsCopy = args.slice(0);
+	const argsCopy = args ? args.slice(0) : [];
 	options = Object.assign({}, options);
 	const parsed = {
 		command,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cross-spawn-esm",
   "type": "module",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "ESM version of cross-spawn package",
   "author": "Timur Bikmuhametov <tim.bic22@gmail.com>",
   "license": "MIT",
@@ -35,14 +35,18 @@
   "devDependencies": {
     "@timbic/eslint-config": "1.2.2",
     "@timbic/prettier-config": "1.2.3",
-    "@types/node": "26.6.1",
+    "@types/node": "26.6.4",
+    "@vitest/coverage-v8": "5.0.3",
     "bumpp": "12.3.0",
-    "eslint": "10.10.0",
+    "eslint": "10.12.0",
     "husky": "9.1.7",
-    "lint-staged": "17.5.1",
-    "prettier": "3.9.6",
+    "lint-staged": "17.6.0",
+    "mkdirp": "3.0.1",
+    "prettier": "3.9.9",
+    "rimraf": "6.1.3",
     "tsdown": "0.23.0",
-    "typescript": "6.0.3"
+    "typescript": "6.0.3",
+    "vitest": "5.0.3"
   },
   "lint-staged": {
     "*/**/*.{js,ts,md,json}": [
@@ -58,6 +62,9 @@
     "lint": "eslint --cache",
     "lint:fix": "eslint --cache --fix",
     "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "release": "bumpp"
   }
 }