@shell-shock/core 0.17.8 → 0.17.10

package/dist/components/exec-builtin.mjs

@@ -1,4 +1,82 @@
-import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";import{ReflectionKind as n}from"@powerlines/deepkit/vendor/type";import r from"defu";import{Show as i,code as a,splitProps as o}from"@alloy-js/core";import{Spacing as s}from"@powerlines/plugin-alloy/core/components/spacing";import{FunctionDeclaration as c,InterfaceDeclaration as l,InterfaceMember as u,VarDeclaration as d}from"@alloy-js/typescript";import{BuiltinFile as f}from"@powerlines/plugin-alloy/typescript/components/builtin-file";import{TSDoc as p,TSDocDefaultValue as m,TSDocParam as h,TSDocReturns as g}from"@powerlines/plugin-alloy/typescript/components/tsdoc";const _=[`T`,`K`,()=>v,()=>y,`Omit`,`b!b"e!!e!!ge!"o$#o##w%y`],v=[`T`,`K`,`Pick`,`l+e#!e"!fRb!b"Pde""N#!w#y`],y=[`T`,`U`,`Exclude`,`l6!Re$!RPe#!e$"qk#%QRb!b"Pde"!p)w#y`],b=[()=>_,`id`,`description`,`ExecBuiltinProps`,`P!P.".#Jo!#Mw$y`];function x(_){let[{children:v},y]=o(_,[`children`]);return e(f,t({id:`exec`,description:`A module to handle command execution in a Shell Shock application.`},y,{get imports(){return r(y.imports??{},{"node:path":[`basename`,`extname`,`dirname`,`join`],"node:fs":[`existsSync`],"node:child_process":[{name:`spawn`,alias:`_spawn`},`execFileSync`],"node:stream":[{name:`Stream`,default:!0,type:!0}]})},get builtinImports(){return r(y.builtinImports??{},{env:[`isWindows`,`env`]})},get children(){return[e(c,{name:`resolveCommandEnv`,parameters:[{name:`params`,type:`{ argv: string[]; env?: NodeJS.ProcessEnv; }`}],returnType:`NodeJS.ProcessEnv`,children:a`const argv = params.argv;
+import { createComponent, mergeProps } from "@alloy-js/core/jsx-runtime";
+import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import defu$1 from "defu";
+import { Show, code, splitProps } from "@alloy-js/core";
+import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
+import { FunctionDeclaration, InterfaceDeclaration, InterfaceMember, VarDeclaration } from "@alloy-js/typescript";
+import { BuiltinFile } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
+import { TSDoc, TSDocDefaultValue, TSDocParam, TSDocReturns } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+
+//#region src/components/exec-builtin.tsx
+const __ΩOmit = [
+	"T",
+	"K",
+	() => __ΩPick,
+	() => __ΩExclude,
+	"Omit",
+	"b!b\"e!!e!!ge!\"o$#o##w%y"
+];
+const __ΩPick = [
+	"T",
+	"K",
+	"Pick",
+	"l+e#!e\"!fRb!b\"Pde\"\"N#!w#y"
+];
+const __ΩExclude = [
+	"T",
+	"U",
+	"Exclude",
+	"l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
+];
+const __ΩExecBuiltinProps = [
+	() => __ΩOmit,
+	"id",
+	"description",
+	"ExecBuiltinProps",
+	"P!P.\".#Jo!#Mw$y"
+];
+/**
+* A built-in module for handling command execution in Shell Shock.
+*/
+function ExecBuiltin(props) {
+	const [{ children }, rest] = splitProps(props, ["children"]);
+	return createComponent(BuiltinFile, mergeProps({
+		id: "exec",
+		description: "A module to handle command execution in a Shell Shock application."
+	}, rest, {
+		get imports() {
+			return defu$1(rest.imports ?? {}, {
+				"node:path": [
+					"basename",
+					"extname",
+					"dirname",
+					"join"
+				],
+				"node:fs": ["existsSync"],
+				"node:child_process": [{
+					name: "spawn",
+					alias: "_spawn"
+				}, "execFileSync"],
+				"node:stream": [{
+					name: "Stream",
+					default: true,
+					type: true
+				}]
+			});
+		},
+		get builtinImports() {
+			return defu$1(rest.builtinImports ?? {}, { env: ["isWindows", "env"] });
+		},
+		get children() {
+			return [
+				createComponent(FunctionDeclaration, {
+					name: "resolveCommandEnv",
+					parameters: [{
+						name: "params",
+						type: "{ argv: string[]; env?: NodeJS.ProcessEnv; }"
+					}],
+					returnType: "NodeJS.ProcessEnv",
+					children: code`const argv = params.argv;
           const shouldSuppressNpmFund = (() => {
             const cmd = basename(argv[0] ?? "");
             if (cmd === "npm" || cmd === "npm.cmd" || cmd === "npm.exe") {
@@ -24,12 +102,32 @@ import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";imp
             result.NPM_CONFIG_FUND ??= "false";
             result.npm_config_fund ??= "false";
           }
-          return result; `}),e(s,{}),e(c,{name:`isWindowsBatchCommand`,parameters:[{name:`resolvedCommand`,type:`string`}],returnType:`boolean`,children:a`if (!isWindows) {
+          return result; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "isWindowsBatchCommand",
+					parameters: [{
+						name: "resolvedCommand",
+						type: "string"
+					}],
+					returnType: "boolean",
+					children: code`if (!isWindows) {
             return false;
           }
           const ext = extname(resolvedCommand).toLowerCase();
 
-          return ext === ".cmd" || ext === ".bat"; `}),e(s,{}),e(c,{name:`escapeForCmdExe`,parameters:[{name:`arg`,type:`string`}],returnType:`string`,children:a`if (/[&|<>^%\\\\r\\\\n]/.test(arg)) {
+          return ext === ".cmd" || ext === ".bat"; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "escapeForCmdExe",
+					parameters: [{
+						name: "arg",
+						type: "string"
+					}],
+					returnType: "string",
+					children: code`if (/[&|<>^%\\\\r\\\\n]/.test(arg)) {
           throw new Error(
             \`Unsafe Windows cmd.exe argument detected: \${JSON.stringify(arg)}. \` +
               "Pass an explicit shell-wrapper argv at the call site instead."
@@ -38,9 +136,33 @@ import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";imp
         if (!arg.includes(" ") && !arg.includes('"')) {
           return arg;
         }
-        return \`"\${arg.replace(/"/g, '""')}"\`; `}),e(s,{}),e(c,{name:`buildCmdExeCommandLine`,parameters:[{name:`resolvedCommand`,type:`string`},{name:`args`,type:`string[]`}],returnType:`string`,children:a`return [escapeForCmdExe(resolvedCommand), ...args.map(escapeForCmdExe)].join(
+        return \`"\${arg.replace(/"/g, '""')}"\`; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "buildCmdExeCommandLine",
+					parameters: [{
+						name: "resolvedCommand",
+						type: "string"
+					}, {
+						name: "args",
+						type: "string[]"
+					}],
+					returnType: "string",
+					children: code`return [escapeForCmdExe(resolvedCommand), ...args.map(escapeForCmdExe)].join(
           " "
-        ); `}),e(s,{}),e(c,{name:`resolveNpmArgvForWindows`,doc:`On Windows, Node 18.20.2+ (CVE-2024-27980) rejects spawning .cmd/.bat directly without shell, causing EINVAL. Resolve npm/npx to node + cli script so we spawn node.exe instead of npm.cmd.`,parameters:[{name:`argv`,type:`string[]`}],returnType:`string[] | null`,children:a`if (!isWindows || argv.length === 0) {
+        ); `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "resolveNpmArgvForWindows",
+					doc: "On Windows, Node 18.20.2+ (CVE-2024-27980) rejects spawning .cmd/.bat directly without shell, causing EINVAL. Resolve npm/npx to node + cli script so we spawn node.exe instead of npm.cmd.",
+					parameters: [{
+						name: "argv",
+						type: "string[]"
+					}],
+					returnType: "string[] | null",
+					children: code`if (!isWindows || argv.length === 0) {
             return null;
           }
           const base = basename(argv[0] ?? "")
@@ -60,7 +182,18 @@ import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";imp
 
             return [shimmedCommand, ...argv.slice(1)];
           }
-          return [process.execPath, cliPath, ...argv.slice(1)]; `}),e(s,{}),e(c,{name:`resolveCommand`,doc:`Resolves a command for Windows compatibility. On Windows, non-.exe commands (like pnpm, yarn) are resolved to .cmd; npm/npx are handled by resolveNpmArgvForWindows to avoid spawn EINVAL (no direct .cmd).`,parameters:[{name:`command`,type:`string`}],returnType:`string`,children:a`if (!isWindows) {
+          return [process.execPath, cliPath, ...argv.slice(1)]; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "resolveCommand",
+					doc: "Resolves a command for Windows compatibility. On Windows, non-.exe commands (like pnpm, yarn) are resolved to .cmd; npm/npx are handled by resolveNpmArgvForWindows to avoid spawn EINVAL (no direct .cmd).",
+					parameters: [{
+						name: "command",
+						type: "string"
+					}],
+					returnType: "string",
+					children: code`if (!isWindows) {
             return command;
           }
           const base = basename(command).toLowerCase();
@@ -70,13 +203,33 @@ import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";imp
           if (["pnpm", "yarn"].includes(base)) {
             return \`\${command}.cmd\`;
           }
-          return command; `}),e(s,{}),e(c,{name:`resolveCommandStdio`,parameters:[{name:`params`,type:`{ hasInput: boolean; preferInherit: boolean; }`}],returnType:`["pipe" | "inherit" | "ignore", "pipe", "pipe"]`,children:a`const stdin = params.hasInput
+          return command; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "resolveCommandStdio",
+					parameters: [{
+						name: "params",
+						type: "{ hasInput: boolean; preferInherit: boolean; }"
+					}],
+					returnType: "[\"pipe\" | \"inherit\" | \"ignore\", \"pipe\", \"pipe\"]",
+					children: code`const stdin = params.hasInput
           ? "pipe"
           : params.preferInherit
             ? "inherit"
             : "pipe";
 
-        return [stdin, "pipe", "pipe"]; `}),e(s,{}),e(c,{name:`resolveProcessExitCode`,parameters:[{name:`params`,type:`{ explicitCode: number | null | undefined; childExitCode: number | null | undefined; resolvedSignal: NodeJS.Signals | null; usesWindowsExitCodeShim: boolean; timedOut: boolean; noOutputTimedOut: boolean; killIssuedByTimeout: boolean; }`}],returnType:`number | null`,children:a`return (
+        return [stdin, "pipe", "pipe"]; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "resolveProcessExitCode",
+					parameters: [{
+						name: "params",
+						type: "{ explicitCode: number | null | undefined; childExitCode: number | null | undefined; resolvedSignal: NodeJS.Signals | null; usesWindowsExitCodeShim: boolean; timedOut: boolean; noOutputTimedOut: boolean; killIssuedByTimeout: boolean; }"
+					}],
+					returnType: "number | null",
+					children: code`return (
           params.explicitCode ??
           params.childExitCode ??
           (params.usesWindowsExitCodeShim &&
@@ -86,13 +239,187 @@ import{createComponent as e,mergeProps as t}from"@alloy-js/core/jsx-runtime";imp
           !params.killIssuedByTimeout
             ? 0
             : null)
-        ); `}),e(s,{}),e(c,{name:`shouldSpawnWithShell`,parameters:[{name:`params`,type:`{ resolvedCommand: string; platform: NodeJS.Platform; }`}],returnType:`boolean`,children:a`// SECURITY: never enable \`shell\` for argv-based execution.
+        ); `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(FunctionDeclaration, {
+					name: "shouldSpawnWithShell",
+					parameters: [{
+						name: "params",
+						type: "{ resolvedCommand: string; platform: NodeJS.Platform; }"
+					}],
+					returnType: "boolean",
+					children: code`// SECURITY: never enable \`shell\` for argv-based execution.
           // \`shell\` routes through cmd.exe on Windows, which turns untrusted argv values
           // (like chat prompts passed as CLI args) into command-injection primitives.
           // If you need a shell, use an explicit shell-wrapper argv (e.g. \`cmd.exe /c ...\`)
           // and validate/escape at the call site.
           void params;
-          return false; `}),e(s,{}),e(p,{heading:`The result of a spawn operation.`}),e(l,{export:!0,name:`SpawnResult`,get children(){return[e(p,{heading:`The PID of the spawned child process, if available.`}),e(u,{name:`pid`,optional:!0,type:`number`}),e(s,{}),e(p,{heading:`The standard output produced by the child process.`}),e(u,{name:`stdout`,type:`string`}),e(s,{}),e(p,{heading:`The standard error produced by the child process.`}),e(u,{name:`stderr`,type:`string`}),e(s,{}),e(p,{heading:`The exit code of the child process, if available.`}),e(u,{name:`code`,type:`number | null`}),e(s,{}),e(p,{heading:`The signal that caused the child process to terminate, if it was killed by a signal.`}),e(u,{name:`signal`,type:`NodeJS.Signals | null`}),e(s,{}),e(p,{heading:`Whether the child process was killed.`}),e(u,{name:`killed`,type:`boolean`}),e(s,{}),e(p,{heading:`The reason for the child process termination.`}),e(u,{name:`termination`,type:a`"exit" | "timeout" | "no-output-timeout" | "signal"`}),e(s,{}),e(p,{heading:`Whether the child process timed out due to no output.`}),e(u,{name:`noOutputTimedOut`,optional:!0,type:`boolean`})]}}),e(s,{}),e(p,{heading:`Options for spawning a child process.`}),e(l,{export:!0,name:`SpawnOptions`,get children(){return[e(p,{heading:"The timeout in milliseconds for the spawn operation. If the process runs longer than this, it will be killed and the spawn promise will reject. This can also be provided as a number directly to the spawn function for convenience. Providing \\`-1\\` will disable the timeout.",get children(){return e(m,{get type(){return n.number},defaultValue:`300000`})}}),e(u,{name:`timeoutMs`,optional:!0,type:`number`}),e(s,{}),e(p,{heading:`The current working directory of the child process.`}),e(u,{name:`cwd`,optional:!0,type:`string`}),e(s,{}),e(p,{heading:`The input to be passed to the child process.`}),e(u,{name:`input`,optional:!0,type:`string`}),e(s,{}),e(p,{heading:`The environment variables for the child process.`}),e(u,{name:`env`,optional:!0,type:`NodeJS.ProcessEnv`}),e(s,{}),e(p,{heading:`Whether to pass arguments to the child process verbatim on Windows.`}),e(u,{name:`windowsVerbatimArguments`,optional:!0,type:`boolean`}),e(s,{}),e(p,{heading:`The timeout in milliseconds for the child process to produce output on stdout or stderr. If the process produces no output for this duration, it will be killed and the spawn promise will reject with a no-output-timeout termination reason.`}),e(u,{name:`noOutputTimeoutMs`,optional:!0,type:`number`})]}}),e(s,{}),e(d,{const:!0,name:`WINDOWS_CLOSE_STATE_SETTLE_TIMEOUT_MS`,initializer:a`250`}),e(s,{}),e(d,{const:!0,name:`WINDOWS_CLOSE_STATE_POLL_MS`,initializer:a`10`}),e(s,{}),e(p,{heading:`Spawns a child process with the given arguments and options, returning a promise that resolves with the result of the spawn operation.`,get children(){return[e(h,{name:`argv`,children:`The command and its arguments to spawn.`}),e(h,{name:`optionsOrTimeoutMs`,children:"The options for spawning the command, or a number representing the timeout in milliseconds. This allows for a convenient shorthand when only a timeout is needed. Providing `-1` will disable the timeout. If no options or timeout are provided, a default timeout of 5 minutes will be used."}),e(g,{children:`A promise that resolves with the result of the spawn operation, including stdout, stderr, exit code, signal, and termination reason.`})]}}),e(c,{export:!0,async:!0,name:`spawn`,parameters:[{name:`argv`,type:`string[]`},{name:`optionsOrTimeoutMs`,type:`number | SpawnOptions`,default:`300000`}],returnType:`Promise<SpawnResult>`,children:a`const options: SpawnOptions =
+          return false; `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, { heading: "The result of a spawn operation." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "SpawnResult",
+					get children() {
+						return [
+							createComponent(TSDoc, { heading: "The PID of the spawned child process, if available." }),
+							createComponent(InterfaceMember, {
+								name: "pid",
+								optional: true,
+								type: "number"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The standard output produced by the child process." }),
+							createComponent(InterfaceMember, {
+								name: "stdout",
+								type: "string"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The standard error produced by the child process." }),
+							createComponent(InterfaceMember, {
+								name: "stderr",
+								type: "string"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The exit code of the child process, if available." }),
+							createComponent(InterfaceMember, {
+								name: "code",
+								type: "number | null"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The signal that caused the child process to terminate, if it was killed by a signal." }),
+							createComponent(InterfaceMember, {
+								name: "signal",
+								type: "NodeJS.Signals | null"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "Whether the child process was killed." }),
+							createComponent(InterfaceMember, {
+								name: "killed",
+								type: "boolean"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The reason for the child process termination." }),
+							createComponent(InterfaceMember, {
+								name: "termination",
+								type: code`"exit" | "timeout" | "no-output-timeout" | "signal"`
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "Whether the child process timed out due to no output." }),
+							createComponent(InterfaceMember, {
+								name: "noOutputTimedOut",
+								optional: true,
+								type: "boolean"
+							})
+						];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, { heading: "Options for spawning a child process." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "SpawnOptions",
+					get children() {
+						return [
+							createComponent(TSDoc, {
+								heading: "The timeout in milliseconds for the spawn operation. If the process runs longer than this, it will be killed and the spawn promise will reject. This can also be provided as a number directly to the spawn function for convenience. Providing \\`-1\\` will disable the timeout.",
+								get children() {
+									return createComponent(TSDocDefaultValue, {
+										get type() {
+											return ReflectionKind.number;
+										},
+										defaultValue: "300000"
+									});
+								}
+							}),
+							createComponent(InterfaceMember, {
+								name: "timeoutMs",
+								optional: true,
+								type: "number"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The current working directory of the child process." }),
+							createComponent(InterfaceMember, {
+								name: "cwd",
+								optional: true,
+								type: "string"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The input to be passed to the child process." }),
+							createComponent(InterfaceMember, {
+								name: "input",
+								optional: true,
+								type: "string"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The environment variables for the child process." }),
+							createComponent(InterfaceMember, {
+								name: "env",
+								optional: true,
+								type: "NodeJS.ProcessEnv"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "Whether to pass arguments to the child process verbatim on Windows." }),
+							createComponent(InterfaceMember, {
+								name: "windowsVerbatimArguments",
+								optional: true,
+								type: "boolean"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc, { heading: "The timeout in milliseconds for the child process to produce output on stdout or stderr. If the process produces no output for this duration, it will be killed and the spawn promise will reject with a no-output-timeout termination reason." }),
+							createComponent(InterfaceMember, {
+								name: "noOutputTimeoutMs",
+								optional: true,
+								type: "number"
+							})
+						];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(VarDeclaration, {
+					"const": true,
+					name: "WINDOWS_CLOSE_STATE_SETTLE_TIMEOUT_MS",
+					initializer: code`250`
+				}),
+				createComponent(Spacing, {}),
+				createComponent(VarDeclaration, {
+					"const": true,
+					name: "WINDOWS_CLOSE_STATE_POLL_MS",
+					initializer: code`10`
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, {
+					heading: "Spawns a child process with the given arguments and options, returning a promise that resolves with the result of the spawn operation.",
+					get children() {
+						return [
+							createComponent(TSDocParam, {
+								name: "argv",
+								children: "The command and its arguments to spawn."
+							}),
+							createComponent(TSDocParam, {
+								name: "optionsOrTimeoutMs",
+								children: `The options for spawning the command, or a number representing the timeout in milliseconds. This allows for a convenient shorthand when only a timeout is needed. Providing \`-1\` will disable the timeout. If no options or timeout are provided, a default timeout of 5 minutes will be used.`
+							}),
+							createComponent(TSDocReturns, { children: "A promise that resolves with the result of the spawn operation, including stdout, stderr, exit code, signal, and termination reason." })
+						];
+					}
+				}),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					async: true,
+					name: "spawn",
+					parameters: [{
+						name: "argv",
+						type: "string[]"
+					}, {
+						name: "optionsOrTimeoutMs",
+						type: "number | SpawnOptions",
+						default: "300000"
+					}],
+					returnType: "Promise<SpawnResult>",
+					children: code`const options: SpawnOptions =
   typeof optionsOrTimeoutMs === "number"
     ? { timeoutMs: optionsOrTimeoutMs }
     : optionsOrTimeoutMs;
@@ -315,19 +642,104 @@ return new Promise((resolve, reject) => {
     };
     waitForExitState();
   });
-});`}),e(s,{}),e(p,{heading:`A helper function that executes a command and returns its stdout.`,get children(){return[e(h,{name:`argv`,children:"The command and its arguments to spawn. This is passed directly to the spawn function. Remember that on Windows, commands like `npm` or `pnpm` will be resolved to their .cmd shims, so you can just pass `npm` without worrying about the extension."}),e(h,{name:`optionsOrTimeoutMs`,children:"The options for spawning the command, or a number representing the timeout in milliseconds. This is passed directly to the spawn function. Providing `-1` will disable the timeout. If no options or timeout are provided, a default timeout of 5 minutes will be used."}),e(g,{children:`A promise that resolves with the result of the spawn operation if the command exits with code 0, or rejects with an error if the command exits with a non-zero code or if there is a problem spawning the process.`})]}}),e(c,{export:!0,async:!0,name:`exec`,parameters:[{name:`argv`,type:`string[]`},{name:`optionsOrTimeoutMs`,type:`number | SpawnOptions`,default:`300000`}],returnType:`Promise<string>`,children:a`const spawnResult = await spawn(argv, optionsOrTimeoutMs);
+});`
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, {
+					heading: "A helper function that executes a command and returns its stdout.",
+					get children() {
+						return [
+							createComponent(TSDocParam, {
+								name: "argv",
+								children: `The command and its arguments to spawn. This is passed directly to the spawn function. Remember that on Windows, commands like \`npm\` or \`pnpm\` will be resolved to their .cmd shims, so you can just pass \`npm\` without worrying about the extension.`
+							}),
+							createComponent(TSDocParam, {
+								name: "optionsOrTimeoutMs",
+								children: `The options for spawning the command, or a number representing the timeout in milliseconds. This is passed directly to the spawn function. Providing \`-1\` will disable the timeout. If no options or timeout are provided, a default timeout of 5 minutes will be used.`
+							}),
+							createComponent(TSDocReturns, { children: "A promise that resolves with the result of the spawn operation if the command exits with code 0, or rejects with an error if the command exits with a non-zero code or if there is a problem spawning the process." })
+						];
+					}
+				}),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					async: true,
+					name: "exec",
+					parameters: [{
+						name: "argv",
+						type: "string[]"
+					}, {
+						name: "optionsOrTimeoutMs",
+						type: "number | SpawnOptions",
+						default: "300000"
+					}],
+					returnType: "Promise<string>",
+					children: code`const spawnResult = await spawn(argv, optionsOrTimeoutMs);
           if (spawnResult.code !== 0) {
             throw Object.assign(new Error(
               \`Command "\${argv.join(" ")}" exited with code \${spawnResult.code} and signal \${spawnResult.signal}\`
             ), spawnResult);
           }
 
-          return spawnResult.stdout.trim(); `}),e(s,{}),e(p,{heading:"A helper function that executes a command synchronously and returns its stdout. This is a thin wrapper around \\`child_process.execFileSync\\` with some added Windows compatibility handling.",get children(){return[e(h,{name:`argv`,children:"The command and its arguments to spawn. This is passed directly to `execFileSync` after Windows-specific resolution. Remember that on Windows, commands like `npm` or `pnpm` will be resolved to their .cmd shims, so you can just pass `npm` without worrying about the extension."}),e(h,{name:`options`,children:"The options for spawning the command. This is passed directly to `execFileSync` after some processing. The timeout option is supported, but note that it will throw an error if the process runs longer than the specified timeout. If no options are provided, a default timeout of 5 minutes will be used."}),e(g,{children:`The standard output produced by the command if it exits with code 0. If the command exits with a non-zero code or if there is a problem spawning the process, an error will be thrown.`})]}}),e(c,{export:!0,name:`execSync`,parameters:[{name:`argv`,type:`string[]`},{name:`options`,type:`SpawnOptions`,default:`{}`}],returnType:`string`,children:a`return execFileSync(argv.length > 0 ? argv[0] : "", argv.slice(1), {
+          return spawnResult.stdout.trim(); `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, {
+					heading: "A helper function that executes a command synchronously and returns its stdout. This is a thin wrapper around \\`child_process.execFileSync\\` with some added Windows compatibility handling.",
+					get children() {
+						return [
+							createComponent(TSDocParam, {
+								name: "argv",
+								children: `The command and its arguments to spawn. This is passed directly to \`execFileSync\` after Windows-specific resolution. Remember that on Windows, commands like \`npm\` or \`pnpm\` will be resolved to their .cmd shims, so you can just pass \`npm\` without worrying about the extension.`
+							}),
+							createComponent(TSDocParam, {
+								name: "options",
+								children: `The options for spawning the command. This is passed directly to \`execFileSync\` after some processing. The timeout option is supported, but note that it will throw an error if the process runs longer than the specified timeout. If no options are provided, a default timeout of 5 minutes will be used.`
+							}),
+							createComponent(TSDocReturns, { children: "The standard output produced by the command if it exits with code 0. If the command exits with a non-zero code or if there is a problem spawning the process, an error will be thrown." })
+						];
+					}
+				}),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					name: "execSync",
+					parameters: [{
+						name: "argv",
+						type: "string[]"
+					}, {
+						name: "options",
+						type: "SpawnOptions",
+						default: "{}"
+					}],
+					returnType: "string",
+					children: code`return execFileSync(argv.length > 0 ? argv[0] : "", argv.slice(1), {
           encoding: "utf8",
           stdio: ["ignore", "pipe", "ignore"],
           timeout: options.timeoutMs ?? 300000,
           env: resolveCommandEnv({ argv, env: options.env }),
           cwd: options.cwd || process.cwd(),
           windowsHide: true
-        }).trim(); `}),e(s,{}),e(i,{get when(){return!!v},children:v})]}}))}x.__type=[()=>b,`props`,`ExecBuiltin`,`A built-in module for handling command execution in Shell Shock.`,`Pn!2""/#?$`];export{x as ExecBuiltin,b as __ΩExecBuiltinProps};
+        }).trim(); `
+				}),
+				createComponent(Spacing, {}),
+				createComponent(Show, {
+					get when() {
+						return Boolean(children);
+					},
+					children
+				})
+			];
+		}
+	}));
+}
+ExecBuiltin.__type = [
+	() => __ΩExecBuiltinProps,
+	"props",
+	"ExecBuiltin",
+	"A built-in module for handling command execution in Shell Shock.",
+	"Pn!2\"\"/#?$"
+];
+
+//#endregion
+export { ExecBuiltin, __ΩExecBuiltinProps };
 //# sourceMappingURL=exec-builtin.mjs.map