@sorrell/cli-utilities 1.0.22 → 1.0.24

package/Distribution/Confirm.Types.d.ts

@@ -1,5 +1,6 @@
 import type { PartialDeep } from "@inquirer/type";
 import type { Theme } from "@inquirer/core";
+/** The configuration object for {@link Confirm}. */
 export type FConfirmConfig = {
     message: string;
     default?: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"Confirm.Types.d.ts","sourceRoot":"","sources":["../Source/Confirm.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,MAAM,cAAc,GACtB;IACI,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"Confirm.Types.d.ts","sourceRoot":"","sources":["../Source/Confirm.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB;IACI,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;CAC9B,CAAC"}

package/Distribution/Confirm.d.ts

@@ -1,5 +1,11 @@
 import type { FConfirmConfig } from "./index.js";
 import type { Prompt } from "@inquirer/type";
-/** An `inquirer` prompt identical to `confirm`, but with more natural handling of keypresses. */
+/**
+ * An `inquirer` prompt identical to `confirm`, but with more natural handling of keypresses.
+ *
+ * @param config - The configuration for this prompt.
+ *
+ * @returns The `boolean` corresponding to the user's choice.
+ */
 export declare const Confirm: Prompt<boolean, FConfirmConfig>;
 //# sourceMappingURL=Confirm.d.ts.map

package/Distribution/Confirm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Confirm.d.ts","sourceRoot":"","sources":["../Source/Confirm.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAO7C,iGAAiG;AACjG,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,cAAc,CAyDnD,CAAC"}
+{"version":3,"file":"Confirm.d.ts","sourceRoot":"","sources":["../Source/Confirm.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAa7C;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,cAAc,CAwDnD,CAAC"}

package/Distribution/Confirm.js

@@ -4,17 +4,27 @@
  * License:   MIT
  */
 import { createPrompt, isEnterKey, makeTheme, useKeypress, usePrefix, useState } from "@inquirer/core";
+/**
+ * @param Value - The answer.
+ * @returns The string to display for the given answer.
+ */
 function GetAnswerString(Value) {
     return Value ? "Yes" : "No";
 }
-/** An `inquirer` prompt identical to `confirm`, but with more natural handling of keypresses. */
+/* eslint-disable jsdoc/require-jsdoc */
+/**
+ * An `inquirer` prompt identical to `confirm`, but with more natural handling of keypresses.
+ *
+ * @param config - The configuration for this prompt.
+ *
+ * @returns The `boolean` corresponding to the user's choice.
+ */
 export const Confirm = createPrompt((Configuration, Done) => {
     const [status, SetStatus] = useState("idle");
     const [DisplayValue, SetDisplayValue] = useState("");
     const theme = makeTheme(Configuration.theme);
     const Prefix = usePrefix({ status, theme });
     useKeypress((Key) => {
-        console.log("KeypressEvent is: ", JSON.stringify(Key, null, 4));
         if (status !== "idle") {
             return;
         }
@@ -50,4 +60,5 @@ export const Confirm = createPrompt((Configuration, Done) => {
         DisplayValue
     ].join("");
 });
+/* eslint-enable jsdoc/require-jsdoc */
 //# sourceMappingURL=Confirm.js.map

package/Distribution/Confirm.js.map

@@ -1 +1 @@
-{"version":3,"file":"Confirm.js","sourceRoot":"","sources":["../Source/Confirm.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIH,YAAY,EACZ,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAIrC,SAAS,eAAe,CAAC,KAAc;IAEnC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAChC,CAAC;AAED,iGAAiG;AACjG,MAAM,CAAC,MAAM,OAAO,GAAoC,YAAY,CAChE,CAAC,aAA6B,EAAE,IAAgC,EAAE,EAAE;IAEhE,MAAM,CAAE,MAAM,EAAE,SAAS,CAAE,GAAG,QAAQ,CAAS,MAAM,CAAC,CAAC;IACvD,MAAM,CAAE,YAAY,EAAE,eAAe,CAAE,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IACvD,MAAM,KAAK,GAAU,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,MAAM,GAAW,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAEpD,WAAW,CAAC,CAAC,GAAkB,EAAE,EAAE;QAE/B,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAChE,IAAI,MAAM,KAAK,MAAM,EACrB,CAAC;YACG,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAW,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;QAEhD,IAAI,OAAO,KAAK,GAAG,EACnB,CAAC;YACG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,CAAC;YACX,OAAO;QACX,CAAC;QAED,IAAI,OAAO,KAAK,GAAG,EACnB,CAAC;YACG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1C,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,CAAC;YACZ,OAAO;QACX,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,CAAC,EACnB,CAAC;YACG,MAAM,MAAM,GAAY,aAAa,CAAC,OAAO,IAAI,IAAI,CAAC;YACtD,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7D,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACb,MAAM,KAAK,MAAM;QACb,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;QAClF,CAAC,CAAC,EAAE,CAAC;IAEb,OAAO;QACH,MAAM;QACN,GAAG;QACH,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;QAClD,WAAW;QACX,GAAG;QACH,YAAY;KACf,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACf,CAAC,CACJ,CAAC"}
+{"version":3,"file":"Confirm.js","sourceRoot":"","sources":["../Source/Confirm.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIH,YAAY,EACZ,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAIrC;;;GAGG;AACH,SAAS,eAAe,CAAC,KAAc;IAEnC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAChC,CAAC;AAED,wCAAwC;AAExC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAoC,YAAY,CAChE,CAAC,aAA6B,EAAE,IAAgC,EAAE,EAAE;IAEhE,MAAM,CAAE,MAAM,EAAE,SAAS,CAAE,GAAG,QAAQ,CAAS,MAAM,CAAC,CAAC;IACvD,MAAM,CAAE,YAAY,EAAE,eAAe,CAAE,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IACvD,MAAM,KAAK,GAAU,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,MAAM,GAAW,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAEpD,WAAW,CAAC,CAAC,GAAkB,EAAE,EAAE;QAE/B,IAAI,MAAM,KAAK,MAAM,EACrB,CAAC;YACG,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAW,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;QAEhD,IAAI,OAAO,KAAK,GAAG,EACnB,CAAC;YACG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,CAAC;YACX,OAAO;QACX,CAAC;QAED,IAAI,OAAO,KAAK,GAAG,EACnB,CAAC;YACG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1C,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,CAAC;YACZ,OAAO;QACX,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,CAAC,EACnB,CAAC;YACG,MAAM,MAAM,GAAY,aAAa,CAAC,OAAO,IAAI,IAAI,CAAC;YACtD,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7D,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACb,MAAM,KAAK,MAAM;QACb,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;QAClF,CAAC,CAAC,EAAE,CAAC;IAEb,OAAO;QACH,MAAM;QACN,GAAG;QACH,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;QAClD,WAAW;QACX,GAAG;QACH,YAAY;KACf,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACf,CAAC,CACJ,CAAC;AAEF,uCAAuC"}

package/Distribution/Ora.Types.d.ts

@@ -0,0 +1,10 @@
+import type ora from "ora";
+/** The options object of {@link Ora}. */
+export type FOraOptions = Extract<Parameters<typeof ora>[0], object>;
+/**
+ * The `async` function or `Promise` passed to {@link Ora}.
+ *
+ * @typeParam Type - The type of the value returned by the task.
+ */
+export type TOraTaskArgument<Type> = (() => Promise<Type>) | Promise<Type> | ((SetPersistText: ((In: string) => void)) => Promise<Type>);
+//# sourceMappingURL=Ora.Types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.Types.d.ts","sourceRoot":"","sources":["../Source/Ora.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B,yCAAyC;AACzC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAC3B,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GACrB,OAAO,CAAC,IAAI,CAAC,GACb,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC"}

package/Distribution/Ora.Types.js

@@ -0,0 +1,7 @@
+/* File:      Ora.Types.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export {};
+//# sourceMappingURL=Ora.Types.js.map

package/Distribution/Ora.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.Types.js","sourceRoot":"","sources":["../Source/Ora.Types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/Distribution/Ora.d.ts

@@ -0,0 +1,27 @@
+import type { FOraOptions, TOraTaskArgument } from "./Ora.Types.js";
+import { type TTryResult } from "@sorrell/utilities";
+import { type Ora as IOra } from "ora";
+/**
+ * Creates and starts an `Ora` instance with the given {@link Argument}.
+ *
+ * @param Argument - The options object.
+ *
+ * @returns An `Ora` instance with the specified options.
+ */
+export declare function Ora(Argument: FOraOptions): IOra;
+/**
+ * @deprecated Use {@link DoTask} instead.
+ *
+ * Executes an `async` function or `Promise` with a progress indicator.
+ *
+ * @typeParam Type - The type of the data to which the given {@link AsyncSource} resolves.
+ *
+ * @param AsyncSource - The `async` function or `Promise` whose state is conveyed
+ * by the returned instance of `Ora`.
+ * @param TaskDescription - The text to display in the `Ora` instance while the
+ * {@link AsyncSource} is pending.
+ *
+ * @returns The result of the {@link AsyncSource}, as a {@link TTryResult}.
+ */
+export declare function OraTask<Type>(AsyncSource: TOraTaskArgument<Type>, TaskDescription: string): Promise<TTryResult<Type>>;
+//# sourceMappingURL=Ora.d.ts.map

package/Distribution/Ora.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.d.ts","sourceRoot":"","sources":["../Source/Ora.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,KAAK,UAAU,EAAoC,MAAM,oBAAoB,CAAC;AACvF,OAAY,EAAE,KAAK,GAAG,IAAI,IAAI,EAAE,MAAM,KAAK,CAAC;AAE5C;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAoB/C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAC9B,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,EACnC,eAAe,EAAE,MAAM,GACxB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CA2C3B"}

package/Distribution/Ora.js

@@ -0,0 +1,75 @@
+/* File:      Ora.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+import { Try as TryAsync } from "@sorrell/utilities";
+import ora from "ora";
+/**
+ * Creates and starts an `Ora` instance with the given {@link Argument}.
+ *
+ * @param Argument - The options object.
+ *
+ * @returns An `Ora` instance with the specified options.
+ */
+export function Ora(Argument) {
+    const DefaultOptions = {
+        hideCursor: true
+    };
+    const EnforcedOptions = {
+        spinner: "point"
+    };
+    const Options = {
+        ...DefaultOptions,
+        ...Argument,
+        ...EnforcedOptions
+    };
+    return ora(Options).start();
+}
+/**
+ * @deprecated Use {@link DoTask} instead.
+ *
+ * Executes an `async` function or `Promise` with a progress indicator.
+ *
+ * @typeParam Type - The type of the data to which the given {@link AsyncSource} resolves.
+ *
+ * @param AsyncSource - The `async` function or `Promise` whose state is conveyed
+ * by the returned instance of `Ora`.
+ * @param TaskDescription - The text to display in the `Ora` instance while the
+ * {@link AsyncSource} is pending.
+ *
+ * @returns The result of the {@link AsyncSource}, as a {@link TTryResult}.
+ */
+export async function OraTask(AsyncSource, TaskDescription) {
+    const ThisOra = Ora({ text: TaskDescription });
+    let PersistText = undefined;
+    const SetPersistText = (In) => {
+        PersistText = In;
+    };
+    const OutAsyncSource = typeof AsyncSource === "function"
+        ? (AsyncSource.length > 0)
+            ? () => AsyncSource(SetPersistText)
+            : AsyncSource
+        : AsyncSource;
+    const Result = await TryAsync(OutAsyncSource);
+    if (Result.Error === undefined) {
+        if (PersistText !== undefined) {
+            ThisOra.succeed(PersistText);
+        }
+        else {
+            ThisOra.succeed();
+        }
+    }
+    else {
+        if (PersistText !== undefined) {
+            ThisOra.fail(PersistText);
+            console.error(Result.Error);
+        }
+        else {
+            ThisOra.fail();
+            console.error(Result.Error);
+        }
+    }
+    return Result;
+}
+//# sourceMappingURL=Ora.js.map

package/Distribution/Ora.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.js","sourceRoot":"","sources":["../Source/Ora.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAoC,GAAG,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,GAAyB,MAAM,KAAK,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,QAAqB;IAErC,MAAM,cAAc,GAChB;QACI,UAAU,EAAE,IAAI;KACnB,CAAC;IAEN,MAAM,eAAe,GACjB;QACI,OAAO,EAAE,OAAO;KACnB,CAAC;IAEN,MAAM,OAAO,GACT;QACI,GAAG,cAAc;QACjB,GAAG,QAAQ;QACX,GAAG,eAAe;KACrB,CAAC;IAEN,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CACzB,WAAmC,EACnC,eAAuB;IAGvB,MAAM,OAAO,GAAS,GAAG,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IACrD,IAAI,WAAW,GAAuB,SAAS,CAAC;IAEhD,MAAM,cAAc,GAAG,CAAC,EAAU,EAAQ,EAAE;QAExC,WAAW,GAAG,EAAE,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAqB,OAAO,WAAW,KAAK,UAAU;QACtE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YACtB,CAAC,CAAC,GAAkB,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;YAClD,CAAC,CAAE,WAAqC;QAC5C,CAAC,CAAC,WAAW,CAAC;IAElB,MAAM,MAAM,GAAqB,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAChE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAC9B,CAAC;QACG,IAAI,WAAW,KAAK,SAAS,EAC7B,CAAC;YACG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;aAED,CAAC;YACG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtB,CAAC;IACL,CAAC;SAED,CAAC;QACG,IAAI,WAAW,KAAK,SAAS,EAC7B,CAAC;YACG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;aAED,CAAC;YACG,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/Distribution/Print/Print.Internal.Types.d.ts

@@ -0,0 +1,4 @@
+import type { Formatter } from "./Print.Types.js";
+/** The result of parsing a {@link FormatRules} object. */
+export type FormatRulesParsed = Map<string | RegExp, Formatter>;
+//# sourceMappingURL=Print.Internal.Types.d.ts.map

package/Distribution/Print/Print.Internal.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Internal.Types.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.Internal.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,0DAA0D;AAC1D,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,CAAC"}

package/Distribution/Print/Print.Internal.Types.js

@@ -0,0 +1,7 @@
+/* File:      Print.Internal.Types.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export {};
+//# sourceMappingURL=Print.Internal.Types.js.map

package/Distribution/Print/Print.Internal.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Internal.Types.js","sourceRoot":"","sources":["../../Source/Print/Print.Internal.Types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/Distribution/Print/Print.Internal.d.ts

@@ -0,0 +1,14 @@
+import type { FormatRules } from "./Print.Types.js";
+import type { FormatRulesParsed } from "./Print.Internal.Types.js";
+/**
+ * Parse a given {@link FormatRules} object into a `Map`, such that
+ * the keys of the given {@link Rules} that describe regular expressions
+ * are replaced by the `RegExp` objects that they describe.  Keys that
+ * correspond to substrings are left as-is.
+ *
+ * @param Rules - The given {@link FormatRules} to parse.
+ *
+ * @returns The parsed {@link FormatRules}, as a {@link FormatRulesParsed} `Map`.
+ */
+export declare function ParseFormatRules(Rules: FormatRules): FormatRulesParsed;
+//# sourceMappingURL=Print.Internal.d.ts.map

package/Distribution/Print/Print.Internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Internal.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.Internal.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAa,MAAM,kBAAkB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAkFnE;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,iBAAiB,CAatE"}

package/Distribution/Print/Print.Internal.js

@@ -0,0 +1,78 @@
+/* File:      Print.Internal.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+/**
+ * @param Value - The given string to parse.
+ * @returns The parsed string or regular expression.
+ */
+function ParseStringOrRegularExpression(Value) {
+    if (Value.length < 2) {
+        return Value;
+    }
+    if (Value[0] !== "/") {
+        return Value;
+    }
+    const ClosingSlashIndex = GetClosingSlashIndex(Value);
+    if (ClosingSlashIndex <= 0) {
+        return Value;
+    }
+    const Pattern = Value.slice(1, ClosingSlashIndex);
+    const Flags = Value.slice(ClosingSlashIndex + 1);
+    try {
+        return new RegExp(Pattern, Flags);
+    }
+    catch {
+        return Value;
+    }
+}
+/**
+ * @param Value - The given `string` whose index of a closing slash is returned.
+ * @returns The index of the closing slash in the given `string`, or `-1` if there is no closing slash.
+ */
+function GetClosingSlashIndex(Value) {
+    for (let Index = Value.length - 1; Index >= 1; Index--) {
+        if (Value[Index] !== "/") {
+            continue;
+        }
+        if (!IsCharacterEscaped(Value, Index)) {
+            return Index;
+        }
+    }
+    return -1;
+}
+/**
+ * @param Value - The given `string` in which to check whether the character at the given `index` is escaped.
+ * @param Index - The index of the character to check.
+ * @returns Whether the given {@link Value} is escaped at the given {@link Index}.
+ */
+function IsCharacterEscaped(Value, Index) {
+    let BackslashCount = 0;
+    for (let CurrentIndex = Index - 1; CurrentIndex >= 0; CurrentIndex--) {
+        if (Value[CurrentIndex] !== "\\") {
+            break;
+        }
+        BackslashCount++;
+    }
+    return (BackslashCount % 2) === 1;
+}
+/**
+ * Parse a given {@link FormatRules} object into a `Map`, such that
+ * the keys of the given {@link Rules} that describe regular expressions
+ * are replaced by the `RegExp` objects that they describe.  Keys that
+ * correspond to substrings are left as-is.
+ *
+ * @param Rules - The given {@link FormatRules} to parse.
+ *
+ * @returns The parsed {@link FormatRules}, as a {@link FormatRulesParsed} `Map`.
+ */
+export function ParseFormatRules(Rules) {
+    const Out = new Map();
+    Object.entries(Rules).forEach(([Key, Formatter]) => {
+        const ParsedKey = ParseStringOrRegularExpression(Key);
+        Out.set(ParsedKey, Formatter);
+    });
+    return Out;
+}
+//# sourceMappingURL=Print.Internal.js.map

package/Distribution/Print/Print.Internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Internal.js","sourceRoot":"","sources":["../../Source/Print/Print.Internal.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;GAGG;AACH,SAAS,8BAA8B,CAAC,KAAa;IAEjD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EACpB,CAAC;QACG,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,EACpB,CAAC;QACG,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,iBAAiB,GAAW,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE9D,IAAI,iBAAiB,IAAI,CAAC,EAC1B,CAAC;QACG,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,OAAO,GAAW,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAW,KAAK,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;IAEzD,IACA,CAAC;QACG,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IACD,MACA,CAAC;QACG,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,KAAa;IAEvC,KAAK,IAAI,KAAK,GAAW,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAC9D,CAAC;QACG,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,EACxB,CAAC;YACG,SAAS;QACb,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,EACrC,CAAC;YACG,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAED,OAAO,CAAC,CAAC,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,KAAa,EAAE,KAAa;IAEpD,IAAI,cAAc,GAAW,CAAC,CAAC;IAE/B,KAAK,IAAI,YAAY,GAAW,KAAK,GAAG,CAAC,EAAE,YAAY,IAAI,CAAC,EAAE,YAAY,EAAE,EAC5E,CAAC;QACG,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,EAChC,CAAC;YACG,MAAM;QACV,CAAC;QAED,cAAc,EAAE,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAkB;IAE/C,MAAM,GAAG,GAAoC,IAAI,GAAG,EAA8B,CAAC;IAInF,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAE,GAAG,EAAE,SAAS,CAAS,EAAQ,EAAE;QAE9D,MAAM,SAAS,GAAoB,8BAA8B,CAAC,GAAG,CAAC,CAAC;QACvE,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACf,CAAC"}

package/Distribution/Print/Print.Types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A function that formats a given {@link Message | Message string}.
+ *
+ * @param Message - The given message to format.
+ *
+ * @returns The formatted message.
+ */
+export type Formatter = {
+    (Message: string): string;
+};
+/** A mapping of substrings or regular expressions to {@link Formatter | Formatters}. */
+export type FormatRules = Record<string, Formatter>;
+//# sourceMappingURL=Print.Types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Types.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.Types.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GACjB;IACI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CAC7B,CAAC;AAEN,wFAAwF;AACxF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC"}

package/Distribution/Print/Print.Types.js

@@ -0,0 +1,7 @@
+/* File:      Print.Types.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export {};
+//# sourceMappingURL=Print.Types.js.map

package/Distribution/Print/Print.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.Types.js","sourceRoot":"","sources":["../../Source/Print/Print.Types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/Distribution/Print/Print.d.ts

@@ -0,0 +1,30 @@
+import type { FormatRules } from "./Print.Types.js";
+/**
+ * Formats a given {@link Message} as code.
+ *
+ * @param Message - The given message to format.
+ *
+ * @returns The given {@link Message}, formatted to convey that it is code.
+ */
+export declare function Code(Message: string): string;
+/**
+ * Formats a given {@link Path} as a path.
+ *
+ * @note Currently, this is just an alias for {@link Code}.
+ *
+ * @param Path - The path to format.
+ *
+ * @returns The given {@link Path}, formatted to convey that it is a path.
+ */
+export declare function Path(Path: string): string;
+/**
+ * Format a given {@link Message} according to the given {@link Rules}.
+ *
+ * @param Message - The message to format.
+ * @param Rules - The {@link FormatRules} describing the transformations that should be made.
+ *
+ * @returns The formatted {@link Message}, such that every matched substring in {@link Rules}
+ * is formatted by the corresponding {@link Formatter}.
+ */
+export declare function Format(Message: string, Rules: FormatRules): string;
+//# sourceMappingURL=Print.d.ts.map

package/Distribution/Print/Print.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAgBpD;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAClB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GAAG,MAAM,CAY9B"}

package/Distribution/Print/Print.js

@@ -0,0 +1,59 @@
+/* File:      Print.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ * Comment:   This module contains functions to output messages
+ *            to the user with consistent and aesthetic formatting.
+ */
+import Chalk from "chalk";
+import { ParseFormatRules } from "./Print.Internal.js";
+/**
+ * The base function for all functions exported by this module.
+ *
+ * @param Message - The input of the function in which this is called.
+ *
+ * @returns The given {@link Message} with base formatting applied.
+ */
+function FormatBase(Message) {
+    return Chalk.reset(Message);
+}
+/**
+ * Formats a given {@link Message} as code.
+ *
+ * @param Message - The given message to format.
+ *
+ * @returns The given {@link Message}, formatted to convey that it is code.
+ */
+export function Code(Message) {
+    return FormatBase(Chalk.red(Message));
+}
+/**
+ * Formats a given {@link Path} as a path.
+ *
+ * @note Currently, this is just an alias for {@link Code}.
+ *
+ * @param Path - The path to format.
+ *
+ * @returns The given {@link Path}, formatted to convey that it is a path.
+ */
+export function Path(Path) {
+    return Code(Chalk.red(Path));
+}
+/**
+ * Format a given {@link Message} according to the given {@link Rules}.
+ *
+ * @param Message - The message to format.
+ * @param Rules - The {@link FormatRules} describing the transformations that should be made.
+ *
+ * @returns The formatted {@link Message}, such that every matched substring in {@link Rules}
+ * is formatted by the corresponding {@link Formatter}.
+ */
+export function Format(Message, Rules) {
+    Message = FormatBase(Message);
+    const RulesParsed = ParseFormatRules(Rules);
+    for (const [Match, Formatter] of RulesParsed) {
+        Message = Message.replaceAll(Match, Formatter);
+    }
+    return Message;
+}
+//# sourceMappingURL=Print.js.map

package/Distribution/Print/Print.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Print.js","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,OAAe;IAE/B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,OAAe;IAEhC,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAClB,OAAe,EACf,KAAkB;IAElB,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAE9B,MAAM,WAAW,GAAsB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE/D,KAAK,MAAM,CAAE,KAAK,EAAE,SAAS,CAAE,IAAI,WAAW,EAC9C,CAAC;QACG,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC"}

package/Distribution/Print/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Print.js";
+export * from "./Print.Types.js";
+//# sourceMappingURL=index.d.ts.map

package/Distribution/Print/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../Source/Print/index.ts"],"names":[],"mappings":"AAMA,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/Distribution/Print/index.js

@@ -0,0 +1,8 @@
+/* File:      index.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export * from "./Print.js";
+export * from "./Print.Types.js";
+//# sourceMappingURL=index.js.map

package/Distribution/Print/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../Source/Print/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/Distribution/index.d.ts

@@ -2,5 +2,7 @@ export * from "./Confirm.js";
 export * from "./Confirm.Types.js";
 export * from "./FileSelector.js";
 export * from "./FileSelector.Types.js";
-export * from "./Print.js";
+export * from "./Print/index.js";
+export * from "./Ora.js";
+export * from "./Ora.Types.js";
 //# sourceMappingURL=index.d.ts.map

package/Distribution/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/Distribution/index.js

@@ -7,5 +7,7 @@ export * from "./Confirm.js";
 export * from "./Confirm.Types.js";
 export * from "./FileSelector.js";
 export * from "./FileSelector.Types.js";
-export * from "./Print.js";
+export * from "./Print/index.js";
+export * from "./Ora.js";
+export * from "./Ora.Types.js";
 //# sourceMappingURL=index.js.map

package/Distribution/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "description": "Utilities for CLI tools.",
   "keywords": [
     "cli",
@@ -12,7 +12,7 @@
     "ora",
     "commander"
   ],
-  "homepage": "https://github.com/GageSorrell/SorrellWm#readme",
+  "homepage": "https://github.com/GageSorrell/SorrellWm/tree/Master/Package/CliUtilities",
   "bugs": {
     "url": "https://github.com/GageSorrell/SorrellWm/issues"
   },
@@ -23,6 +23,14 @@
   "license": "MIT",
   "author": "Gage Sorrell <gage@sorrell.sh>",
   "type": "module",
+  "exports": {
+    ".": {
+      "default": "./Distribution/index.js",
+      "import": "./Distribution/index.js",
+      "require": "./Distribution/index.js",
+      "types": "./Distribution/index.d.ts"
+    }
+  },
   "main": "./Distribution/index.js",
   "types": "./Distribution/index.d.ts",
   "scripts": {
@@ -36,7 +44,8 @@
     "@inquirer/core": "^11.1.7",
     "@inquirer/prompts": "^8.3.2",
     "@inquirer/type": "^4.0.4",
-    "@sorrell/inquirer-file-selector": "^1.0.3",
+    "@sorrell/inquirer-file-selector": "^1.0.4",
+    "@sorrell/utilities": "^1.1.11",
     "chalk": "^5.6.2",
     "cli-table3": "^0.6.5",
     "clipboardy": "^5.3.1",