@sorrell/cli-utilities 1.0.26 → 1.0.28

package/Distribution/Listr.Types.d.ts

@@ -0,0 +1,4 @@
+import type { DefaultRenderer, ListrDefaultRenderer, ListrGetRendererClassFromValue, ListrTask, ListrTaskWrapper } from "listr2";
+export type Wrapper<ContextType> = ListrTaskWrapper<ContextType, ListrDefaultRenderer, ListrDefaultRenderer>;
+export type ListrConstructorTask<ContextType> = ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>> | Array<ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>>>;
+//# sourceMappingURL=Listr.Types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.Types.d.ts","sourceRoot":"","sources":["../Source/Listr.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACR,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC9B,SAAS,EACT,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAErC,MAAM,MAAM,OAAO,CAAC,WAAW,IAAI,gBAAgB,CAC/C,WAAW,EACX,oBAAoB,EACpB,oBAAoB,CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,WAAW,IACtC,SAAS,CACP,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,GACzD,KAAK,CAAC,SAAS,CACb,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,CAC1D,CAAC"}

package/Distribution/Listr.Types.js

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

package/Distribution/Listr.Types.js.map

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

package/Distribution/Listr.d.ts

@@ -0,0 +1,22 @@
+import { type DefaultRenderer, type ListrBaseClassOptions, type ListrTaskObject } from "listr2";
+import type { ListrConstructorTask } from "./Listr.Types.js";
+/** A string-only {@link Error} used by {@link Listr} to show nicely-formatted errors. */
+export declare class SimpleError extends Error {
+    constructor(Message: string);
+    TheMessage: string;
+}
+/**
+ * A wrapper for `new Listr` that handles errors nicely.
+ *
+ * @typeParam ContextType - The type of the `listr2` context used by the {@link Task}.
+ *
+ * @param Task - The task(s) to run.
+ * @param GenericErrorMessage - The error message that is shown if the {@link Task | task(s)} throw(s)
+ * something other than a {@link SimpleError}.
+ * @param Options - *(Optional)* The {@link ListrBaseClassOptions} used to customize the
+ * {@link Task | task(s)}.
+ * @param ParentTask - *(Optional)* The {@link ListrTaskObject | parent task} of which the
+ * {@link Task | task(s)} are (a) descendant(s).
+ */
+export declare function RunListr<ContextType = unknown>(Task: ListrConstructorTask<ContextType>, GenericErrorMessage: string, Options?: ListrBaseClassOptions<ContextType, typeof DefaultRenderer, typeof DefaultRenderer>, ParentTask?: ListrTaskObject<unknown, typeof DefaultRenderer, typeof DefaultRenderer>): Promise<void>;
+//# sourceMappingURL=Listr.d.ts.map

package/Distribution/Listr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.d.ts","sourceRoot":"","sources":["../Source/Listr.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACI,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,yFAAyF;AACzF,qBAAa,WAAY,SAAQ,KAAK;gBAEf,OAAO,EAAE,MAAM;IAM3B,UAAU,EAAE,MAAM,CAAC;CAC7B;AA8BD;;;;;;;;;;;;GAYG;AACH,wBAAsB,QAAQ,CAAC,WAAW,GAAG,OAAO,EAChD,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC,EACvC,mBAAmB,EAAE,MAAM,EAC3B,OAAO,CAAC,EAAE,qBAAqB,CAAC,WAAW,EAAE,OAAO,eAAe,EAAE,OAAO,eAAe,CAAC,EAC5F,UAAU,CAAC,EAAE,eAAe,CACxB,OAAO,EACP,OAAO,eAAe,EACtB,OAAO,eAAe,CACzB,GACF,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/Distribution/Listr.js

@@ -0,0 +1,57 @@
+/* File:      Listr.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+import { Listr as OriginalListr } from "listr2";
+/** A string-only {@link Error} used by {@link Listr} to show nicely-formatted errors. */
+export class SimpleError extends Error {
+    constructor(Message) {
+        super();
+        this.TheMessage = Message;
+    }
+    TheMessage;
+}
+;
+class Listr extends OriginalListr {
+    constructor(Task, Options, ParentTask) {
+        if (Options === undefined && ParentTask === undefined) {
+            super(Task);
+        }
+        else if (Options !== undefined && ParentTask === undefined) {
+            super(Task, Options);
+        }
+        else if (Options !== undefined && ParentTask !== undefined) {
+            super(Task, Options, ParentTask);
+        }
+    }
+}
+;
+/**
+ * A wrapper for `new Listr` that handles errors nicely.
+ *
+ * @typeParam ContextType - The type of the `listr2` context used by the {@link Task}.
+ *
+ * @param Task - The task(s) to run.
+ * @param GenericErrorMessage - The error message that is shown if the {@link Task | task(s)} throw(s)
+ * something other than a {@link SimpleError}.
+ * @param Options - *(Optional)* The {@link ListrBaseClassOptions} used to customize the
+ * {@link Task | task(s)}.
+ * @param ParentTask - *(Optional)* The {@link ListrTaskObject | parent task} of which the
+ * {@link Task | task(s)} are (a) descendant(s).
+ */
+export async function RunListr(Task, GenericErrorMessage, Options, ParentTask) {
+    try {
+        await new Listr(Task, Options, ParentTask);
+    }
+    catch (ListrError) {
+        if (ListrError instanceof SimpleError) {
+            console.error(`🚨 ${ListrError.TheMessage}`);
+        }
+        else {
+            console.dir(ListrError);
+            console.error(`\n🚨 ${GenericErrorMessage}.  The error is printed above.`);
+        }
+    }
+}
+//# sourceMappingURL=Listr.js.map

package/Distribution/Listr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.js","sourceRoot":"","sources":["../Source/Listr.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIH,KAAK,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAC;AAG3C,yFAAyF;AACzF,MAAM,OAAO,WAAY,SAAQ,KAAK;IAElC,YAAmB,OAAe;QAE9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC9B,CAAC;IAEM,UAAU,CAAS;CAC7B;AAAA,CAAC;AAEF,MAAM,KACF,SAAQ,aAA0E;IAElF,YACI,IAAuC,EACvC,OAA4F,EAC5F,UAIC;QAGD,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EACrD,CAAC;YACG,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;CACJ;AAAA,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC1B,IAAuC,EACvC,mBAA2B,EAC3B,OAA4F,EAC5F,UAIC;IAGD,IACA,CAAC;QACG,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,UAAmB,EAC1B,CAAC;QACG,IAAI,UAAU,YAAY,WAAW,EACrC,CAAC;YACG,OAAO,CAAC,KAAK,CAAC,MAAO,UAAU,CAAC,UAAW,EAAE,CAAC,CAAC;QACnD,CAAC;aAED,CAAC;YACG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,QAAS,mBAAoB,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACL,CAAC;AACL,CAAC"}

package/Distribution/Print/Print.d.ts

@@ -31,10 +31,12 @@ export declare function Format(Message: string, Rules: FormatRules): string;
  * Creates a function that formats a given `string` with the given {@link Rules}.
  *
  * @param Rules - The {@link FormatRules} used to format messages passed to the
- * returned function.
+ * returned function.  If multiple are given, then the keys will be pooled.  If
+ * multiple {@link Rules} share a given key, then the respective formatter functions
+ * will be composed in the order of the given {@link Rules} objects.
  *
  * @returns A function that will format the `Message` passed to it according to the
  * {@link Rules} passed to this function.
  */
-export declare function MakeFormatter(Rules: FormatRules): Formatter;
+export declare function MakeFormatter(...Rules: [FormatRules] | Array<FormatRules>): Formatter;
 //# sourceMappingURL=Print.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Print.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAgB/D;;;;;;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,GACnB,MAAM,CAYR;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,CAM3D"}
+{"version":3,"file":"Print.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiB/D;;;;;;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,GACnB,MAAM,CAYR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAAC,GAAG,KAAK,EAAE,CAAE,WAAW,CAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAsCvF"}

package/Distribution/Print/Print.js

@@ -60,14 +60,36 @@ export function Format(Message, Rules) {
  * Creates a function that formats a given `string` with the given {@link Rules}.
  *
  * @param Rules - The {@link FormatRules} used to format messages passed to the
- * returned function.
+ * returned function.  If multiple are given, then the keys will be pooled.  If
+ * multiple {@link Rules} share a given key, then the respective formatter functions
+ * will be composed in the order of the given {@link Rules} objects.
  *
  * @returns A function that will format the `Message` passed to it according to the
  * {@link Rules} passed to this function.
  */
-export function MakeFormatter(Rules) {
+export function MakeFormatter(...Rules) {
+    /* eslint-disable-next-line jsdoc/require-jsdoc */
+    function ComposeRules() {
+        if (Rules.length === 1) {
+            return Rules[0];
+        }
+        return Rules.reduce((PreviousValue, CurrentValue) => {
+            const NewValue = { ...PreviousValue };
+            Object.keys(CurrentValue).forEach((Key) => {
+                if (Key in NewValue && PreviousValue[Key] !== undefined && CurrentValue[Key] !== undefined) {
+                    const OriginalFunction = PreviousValue[Key];
+                    const CurrentFunction = CurrentValue[Key];
+                    NewValue[Key] = function (Message) {
+                        return CurrentFunction(OriginalFunction(Message));
+                    };
+                }
+            });
+            return NewValue;
+        }, {});
+    }
+    const OutRules = ComposeRules();
     return function (Message) {
-        return Format(Message, Rules);
+        return Format(Message, OutRules);
     };
 }
 //# sourceMappingURL=Print.js.map

package/Distribution/Print/Print.js.map

@@ -1 +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;IAGlB,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;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,KAAkB;IAE5C,OAAO,UAAS,OAAe;QAE3B,OAAO,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC;AACN,CAAC"}
+{"version":3,"file":"Print.js","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,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;IAGlB,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;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,KAA2C;IAExE,kDAAkD;IAClD,SAAS,YAAY;QAEjB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EACtB,CAAC;YACG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,aAA0B,EAAE,YAAyB,EAAe,EAAE;YAEvF,MAAM,QAAQ,GAAgB,EAAE,GAAG,aAAa,EAAE,CAAC;YAEnD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAQ,EAAE;gBAEpD,IAAI,GAAG,IAAI,QAAQ,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,SAAS,EAC1F,CAAC;oBACG,MAAM,gBAAgB,GAAc,aAAa,CAAC,GAAG,CAAC,CAAC;oBACvD,MAAM,eAAe,GAAc,YAAY,CAAC,GAAG,CAAC,CAAC;oBAErD,QAAQ,CAAC,GAAG,CAAC,GAAG,UAAS,OAAe;wBAEpC,OAAO,eAAe,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;oBACtD,CAAC,CAAC;gBACN,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QACpB,CAAC,EAAE,EAAG,CAAC,CAAC;IACZ,CAAC;IAED,MAAM,QAAQ,GAAgB,YAAY,EAAE,CAAC;IAE7C,OAAO,UAAS,OAAe;QAE3B,OAAO,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "description": "Utilities for CLI tools.",
   "keywords": [
     "cli",
@@ -44,12 +44,14 @@
     "@inquirer/core": "^11.1.7",
     "@inquirer/prompts": "^8.3.2",
     "@inquirer/type": "^4.0.4",
+    "@listr2/prompt-adapter-enquirer": "^4.2.1",
     "@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",
     "commander": "^14.0.3",
+    "listr2": "^10.2.1",
     "ora": "^9.3.0"
   }
 }