@sorrell/cli-utilities 1.0.39 → 1.0.41

package/Distribution/PseudoTerminal/PseudoTerminal.Types.d.ts

@@ -4,5 +4,18 @@
  * @copyright (c) 2026 Gage Sorrell
  * @license   MIT
  */
-export {};
+import type { IPty as IPtyOriginal } from "node-pty";
+/**
+ * The data that is supplied to the listener argument of
+ * {@link IPtyOriginal!onExit | onExit}.
+ */
+export type OnExitData = Parameters<Parameters<IPty["onExit"]>[0]>[0];
+/**
+ * The {@link IPtyOriginal | IPty}, with an additional {@link Promise}
+ * {@link OnExit}, which resolves to the {@link OnExitData} for the
+ * given session.
+ */
+export interface IPty extends IPtyOriginal {
+    OnExit: Promise<OnExitData>;
+}
 //# sourceMappingURL=PseudoTerminal.Types.d.ts.map

package/Distribution/PseudoTerminal/PseudoTerminal.Types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PseudoTerminal.Types.d.ts","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}
+{"version":3,"file":"PseudoTerminal.Types.d.ts","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,IAAI,YAAY,EAAE,MAAM,UAAU,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,IAAK,SAAQ,YAAY;IAEtC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/B"}

package/Distribution/PseudoTerminal/PseudoTerminal.d.ts

@@ -4,6 +4,23 @@
  * @copyright (c) 2026 Gage Sorrell
  * @license   MIT
  */
-import { type IPty, type IPtyForkOptions, type IWindowsPtyForkOptions } from "node-pty";
-export declare function Spawn(Command: string, Arguments: Array<string>, Options: IPtyForkOptions | IWindowsPtyForkOptions): IPty;
+import type { IPty } from "./PseudoTerminal.Types.js";
+import { type IPtyForkOptions, type IWindowsPtyForkOptions } from "node-pty";
+/**
+ * This function wraps {@link spawn} and provides sensible default options.
+ *
+ * @param {string} Command - The name of the command to run.
+ * @param {Array<string>} Arguments - The arguments to supply with the {@link Command}.
+ * @param {IPtyForkOptions | IWindowsPtyForkOptions} Options - The options for the resulting
+ * `node-pty` session.
+ *
+ * @returns {IPty} The session
+ *
+ * @example
+ * Running `npm install @sorrell/cli-utilities` via a `node-pty` session,
+ * ```typescript
+ * const MySession: IPty = Spawn("npm", [ "install" ]);
+ * ```
+ */
+export declare function Spawn(Command: string, Arguments?: Array<string>, Options?: IPtyForkOptions | IWindowsPtyForkOptions): IPty;
 //# sourceMappingURL=PseudoTerminal.d.ts.map

package/Distribution/PseudoTerminal/PseudoTerminal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PseudoTerminal.d.ts","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,eAAe,EAAE,KAAK,sBAAsB,EAAS,MAAM,UAAU,CAAC;AAG/F,wBAAgB,KAAK,CACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,EACxB,OAAO,EAAE,eAAe,GAAG,sBAAsB,GAClD,IAAI,CAsBN"}
+{"version":3,"file":"PseudoTerminal.d.ts","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAc,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACH,KAAK,eAAe,EAEpB,KAAK,sBAAsB,EACpB,MAAM,UAAU,CAAC;AAI5B;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CACjB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,KAAK,CAAC,MAAM,CAAO,EAC9B,OAAO,GAAE,eAAe,GAAG,sBAA4B,GACxD,IAAI,CA0CN"}

package/Distribution/PseudoTerminal/PseudoTerminal.js

@@ -6,7 +6,23 @@
  */
 import { spawn } from "node-pty";
 import { GetCommandName } from "../Command/Command.js";
-export function Spawn(Command, Arguments, Options) {
+/**
+ * This function wraps {@link spawn} and provides sensible default options.
+ *
+ * @param {string} Command - The name of the command to run.
+ * @param {Array<string>} Arguments - The arguments to supply with the {@link Command}.
+ * @param {IPtyForkOptions | IWindowsPtyForkOptions} Options - The options for the resulting
+ * `node-pty` session.
+ *
+ * @returns {IPty} The session
+ *
+ * @example
+ * Running `npm install @sorrell/cli-utilities` via a `node-pty` session,
+ * ```typescript
+ * const MySession: IPty = Spawn("npm", [ "install" ]);
+ * ```
+ */
+export function Spawn(Command, Arguments = [], Options = {}) {
     const DefaultOptions = {
         cols: process.stdout.columns || 80,
         cwd: process.cwd(),
@@ -18,6 +34,17 @@ export function Spawn(Command, Arguments, Options) {
         ...DefaultOptions,
         ...Options
     };
-    return spawn(GetCommandName(Command), Arguments, OutOptions);
+    const Out = spawn(GetCommandName(Command), Arguments, OutOptions);
+    let OnExitResolve;
+    const OnExit = new Promise((Resolve, _Reject) => {
+        OnExitResolve = Resolve;
+    });
+    Out.onExit((Data) => {
+        OnExitResolve(Data);
+    });
+    return {
+        ...Out,
+        OnExit
+    };
 }
 //# sourceMappingURL=PseudoTerminal.js.map

package/Distribution/PseudoTerminal/PseudoTerminal.js.map

@@ -1 +1 @@
-{"version":3,"file":"PseudoTerminal.js","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAgE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/F,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,UAAU,KAAK,CACjB,OAAe,EACf,SAAwB,EACxB,OAAiD;IAGjD,MAAM,cAAc,GAChB;QACI,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE;QAClC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;QAClB,GAAG,EAAE,OAAO,CAAC,GAA6B;QAC1C,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE;KAClC,CAAC;IAEN,MAAM,UAAU,GACZ;QACI,GAAG,cAAc;QACjB,GAAG,OAAO;KACb,CAAC;IAEN,OAAO,KAAK,CACR,cAAc,CAAC,OAAO,CAAC,EACvB,SAAS,EACT,UAAU,CACb,CAAC;AACN,CAAC"}
+{"version":3,"file":"PseudoTerminal.js","sourceRoot":"","sources":["../../Source/PseudoTerminal/PseudoTerminal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAIH,KAAK,EAAE,MAAM,UAAU,CAAC;AAE5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,KAAK,CACjB,OAAe,EACf,YAA2B,EAAG,EAC9B,UAAoD,EAAG;IAGvD,MAAM,cAAc,GAChB;QACI,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE;QAClC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;QAClB,GAAG,EAAE,OAAO,CAAC,GAA6B;QAC1C,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE;KAClC,CAAC;IAEN,MAAM,UAAU,GACZ;QACI,GAAG,cAAc;QACjB,GAAG,OAAO;KACb,CAAC;IAEN,MAAM,GAAG,GAAiB,KAAK,CAC3B,cAAc,CAAC,OAAO,CAAC,EACvB,SAAS,EACT,UAAU,CACb,CAAC;IAEF,IAAI,aAAmC,CAAC;IAExC,MAAM,MAAM,GAAmB,IAAI,OAAO,CAAa,CACnD,OAA6B,EAC7B,OAAgB,EACZ,EAAE;QAEN,aAAa,GAAG,OAAO,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,MAAM,CAAC,CAAC,IAAgB,EAAQ,EAAE;QAElC,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO;QACH,GAAG,GAAG;QACN,MAAM;KACT,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.39",
+  "version": "1.0.41",
   "description": "Utilities for CLI tools.",
   "keywords": [
     "cli",